me.mattstudios.mfgui.gui.guis

Class PaginatedGui

java.lang.Object

me.mattstudios.mfgui.gui.guis.BaseGui

me.mattstudios.mfgui.gui.guis.PaginatedGui

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

public final class PaginatedGui
extends BaseGui

Constructor Summary

Constructors

Constructor and Description
PaginatedGui(@NotNull org.bukkit.plugin.Plugin plugin, int rows, int pageSize, @NotNull String title)
PaginatedGui(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull String title)

Method Summary

Modifier and Type	Method and Description
BaseGui	addItem(GuiItem... items) Overridden method to add the items to the page instead
BaseGui	addItem(@NotNull GuiItem item) Adds an item to the next empty slot in the GUI
Map<Integer,GuiItem>	getCurrentPageItems() Gets the items on the current page
int	getCurrentPageNum() Gets the current page number
int	getNextPageNum() Gets the next page number
List<GuiItem>	getPageItems() Gets all the items added to the GUI
int	getPrevPageNum() Gets the previous page number
boolean	nextPage() Goes to the next page
void	open(@NotNull org.bukkit.entity.HumanEntity player) Opens the GUI in the first page
void	open(@NotNull org.bukkit.entity.HumanEntity player, int openPage) Overridden open method to add the gui page items
boolean	prevPage() Goes to the previous page if possible
BaseGui	setPageSize(int pageSize) Sets the page size
void	update() Overridden update method to use the paginated open
void	updatePageItem(int slot, @NotNull GuiItem item) Used for updating the current item in the page at runtime
void	updatePageItem(int row, int col, @NotNull GuiItem item) Used for updating the current item in the page at runtime
void	updatePageItem(int row, int col, @NotNull org.bukkit.inventory.ItemStack itemStack) Used for updating the current item in the page at runtime
void	updatePageItem(int slot, @NotNull org.bukkit.inventory.ItemStack itemStack) Used for updating the current item in the page at runtime

Methods inherited from class me.mattstudios.mfgui.gui.guis.BaseGui

addSlotAction, addSlotAction, close, getFiller, getGuiItem, getGuiItems, getInventory, getRows, isUpdating, setCloseGuiAction, setDefaultClickAction, setDefaultTopClickAction, setDragAction, setItem, setItem, setItem, setOpenGuiAction, setOutsideClickAction, setRows, setUpdating, updateItem, updateItem, updateItem, updateItem, updateTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaginatedGui

public PaginatedGui(@NotNull
                    @NotNull org.bukkit.plugin.Plugin plugin,
                    int rows,
                    int pageSize,
                    @NotNull
                    @NotNull String title)

PaginatedGui

public PaginatedGui(@NotNull
                    @NotNull org.bukkit.plugin.Plugin plugin,
                    @NotNull
                    @NotNull String title)

Method Detail

setPageSize

public BaseGui setPageSize(int pageSize)

Sets the page size

Parameters:

pageSize - The new page size

Returns:

The GUI

addItem

public BaseGui addItem(@NotNull
                       @NotNull GuiItem item)

Adds an item to the next empty slot in the GUI

Parameters:

item - The GUI item

Returns:

The GUI

addItem

public BaseGui addItem(@NotNull
                       GuiItem... items)

Overridden method to add the items to the page instead

Overrides:

addItem in class BaseGui

Parameters:

items - The Gui Items

Returns:

The GUI

update

public void update()

Overridden update method to use the paginated open

Overrides:

update in class BaseGui

updatePageItem

public void updatePageItem(int slot,
                           @NotNull
                           @NotNull org.bukkit.inventory.ItemStack itemStack)

Used for updating the current item in the page at runtime

Parameters:

slot - The slot of the item to update

itemStack - The new ItemStack

updatePageItem

public void updatePageItem(int row,
                           int col,
                           @NotNull
                           @NotNull org.bukkit.inventory.ItemStack itemStack)

Used for updating the current item in the page at runtime

Parameters:

row - The row of the slot

col - The col of the slot

itemStack - The new ItemStack

updatePageItem

public void updatePageItem(int slot,
                           @NotNull
                           @NotNull GuiItem item)

Used for updating the current item in the page at runtime

Parameters:

slot - The slot of the item to update

item - The new ItemStack

updatePageItem

public void updatePageItem(int row,
                           int col,
                           @NotNull
                           @NotNull GuiItem item)

Used for updating the current item in the page at runtime

Parameters:

row - The row of the slot

col - The col of the slot

item - The new ItemStack

open

public void open(@NotNull
                 @NotNull org.bukkit.entity.HumanEntity player)

Opens the GUI in the first page

Overrides:

open in class BaseGui

Parameters:

player - The player to open it to

open

public void open(@NotNull
                 @NotNull org.bukkit.entity.HumanEntity player,
                 int openPage)

Overridden open method to add the gui page items

Parameters:

player - The player to open it to

openPage - The specific page to open at

getCurrentPageItems

public Map<Integer,GuiItem> getCurrentPageItems()

Gets the items on the current page

Returns:

The map with the items

getPageItems

public List<GuiItem> getPageItems()

Gets all the items added to the GUI

Returns:

The list with all the items

getCurrentPageNum

public int getCurrentPageNum()

Gets the current page number

Returns:

The current page number

getNextPageNum

public int getNextPageNum()

Gets the next page number

Returns:

The next page number or -1 as no next

getPrevPageNum

public int getPrevPageNum()

Gets the previous page number

Returns:

The previous page number or -1 as no previous

nextPage

public boolean nextPage()

Goes to the next page

prevPage

public boolean prevPage()

Goes to the previous page if possible