com.github.stefvanschie.inventoryframework.pane

Class PaginatedPane

java.lang.Object

com.github.stefvanschie.inventoryframework.pane.Pane

com.github.stefvanschie.inventoryframework.pane.PaginatedPane

public class PaginatedPane
extends Pane

A pane for panes that should be spread out over multiple pages

Nested Class Summary

Nested classes/interfaces inherited from class com.github.stefvanschie.inventoryframework.pane.Pane

Pane.Priority

Field Summary

Fields inherited from class com.github.stefvanschie.inventoryframework.pane.Pane

height, length, onClick, x, y

Constructor Summary

Constructors

Constructor and Description
PaginatedPane(int length, int height)
PaginatedPane(int x, int y, int length, int height)
PaginatedPane(int x, int y, int length, int height, Pane.Priority priority)

Method Summary

Modifier and Type	Method and Description
void	addPane(int page, Pane pane) Assigns a pane to a selected page
void	clear() Clears the entire pane of any items/panes.
boolean	click(Gui gui, org.bukkit.event.inventory.InventoryClickEvent event, int paneOffsetX, int paneOffsetY, int maxLength, int maxHeight) Called whenever there is being clicked on this pane
void	display(Gui gui, org.bukkit.inventory.Inventory inventory, org.bukkit.inventory.PlayerInventory playerInventory, int paneOffsetX, int paneOffsetY, int maxLength, int maxHeight) Has to set all the items in the right spot inside the inventory
Collection<GuiItem>	getItems() Gets all the items in this pane and all underlying panes
int	getPage() Returns the current page
int	getPages() Returns the amount of pages
Collection<Pane>	getPanes() Gets all the panes in this panes, including any child panes from other panes
static PaginatedPane	load(Object instance, Element element) Loads a paginated pane from a given element
void	populateWithGuiItems(List<GuiItem> items) Populates the PaginatedPane based on the provided list by adding new pages until all items can fit.
void	populateWithItemStacks(List<org.bukkit.inventory.ItemStack> items) Populates the PaginatedPane based on the provided list by adding new pages until all items can fit.
void	populateWithNames(List<String> displayNames, org.bukkit.Material material) This method creates a list of ItemStacks all with the given material and the display names.
void	setPage(int page) Sets the current displayed page

Methods inherited from class com.github.stefvanschie.inventoryframework.pane.Pane

getHeight, getLength, getPriority, getPropertyMappings, getX, getY, isVisible, load, loadItem, setHeight, setLength, setOnClick, setOnLocalClick, setPriority, setVisible, setX, setY

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginatedPane

public PaginatedPane(int x,
                     int y,
                     int length,
                     int height,
                     @NotNull
                     Pane.Priority priority)

PaginatedPane

public PaginatedPane(int x,
                     int y,
                     int length,
                     int height)

PaginatedPane

public PaginatedPane(int length,
                     int height)

Method Detail

getPage

public int getPage()

Returns the current page

Returns:

the current page

getPages

public int getPages()

Returns the amount of pages

Returns:

the amount of pages

addPane

public void addPane(int page,
                    @NotNull
                    Pane pane)

Assigns a pane to a selected page

Parameters:

page - the page to assign the pane to

pane - the new pane

setPage

public void setPage(int page)

Sets the current displayed page

Parameters:

page - the page

populateWithItemStacks

@Contract(value="null -> fail")
public void populateWithItemStacks(@NotNull
                                                                    List<org.bukkit.inventory.ItemStack> items)

Populates the PaginatedPane based on the provided list by adding new pages until all items can fit. This can be helpful when dealing with lists of unknown size.

Parameters:

items - The list to populate the pane with

populateWithGuiItems

@Contract(value="null -> fail")
public void populateWithGuiItems(@NotNull
                                                                  List<GuiItem> items)

Populates the PaginatedPane based on the provided list by adding new pages until all items can fit. This can be helpful when dealing with lists of unknown size.

Parameters:

items - The list to populate the pane with

populateWithNames

@Contract(value="null, _ -> fail")
public void populateWithNames(@NotNull
                                                                  List<String> displayNames,
                                                                  @Nullable
                                                                  org.bukkit.Material material)

This method creates a list of ItemStacks all with the given material and the display names. After that it calls populateWithItemStacks(List) This method also translates the color char & for all names.

Parameters:

displayNames - The display names for all the items

material - The material to use for the ItemStacks

display

public void display(@NotNull
                    Gui gui,
                    @NotNull
                    org.bukkit.inventory.Inventory inventory,
                    @NotNull
                    org.bukkit.inventory.PlayerInventory playerInventory,
                    int paneOffsetX,
                    int paneOffsetY,
                    int maxLength,
                    int maxHeight)

Has to set all the items in the right spot inside the inventory

Specified by:

display in class Pane

Parameters:

gui - the gui for which we're rendering

inventory - the inventory that the items should be displayed in

playerInventory - the player's inventory

paneOffsetX - the pane's offset on the x axis

paneOffsetY - the pane's offset on the y axis

maxLength - the maximum length of the pane

maxHeight - the maximum height of the pane

click

public boolean click(@NotNull
                     Gui gui,
                     @NotNull
                     org.bukkit.event.inventory.InventoryClickEvent event,
                     int paneOffsetX,
                     int paneOffsetY,
                     int maxLength,
                     int maxHeight)

Called whenever there is being clicked on this pane

Specified by:

click in class Pane

Parameters:

gui - the gui this event stems from

event - the event that occurred while clicking on this item

paneOffsetX - the pane's offset on the x axis

paneOffsetY - the pane's offset on the y axis

maxLength - the maximum length of the pane

maxHeight - the maximum height of the pane

Returns:

whether the item was found or not

getPanes

@NotNull
 @Contract(pure=true)
public Collection<Pane> getPanes()

Gets all the panes in this panes, including any child panes from other panes

Specified by:

getPanes in class Pane

Returns:

all panes

getItems

@NotNull
 @Contract(pure=true)
public Collection<GuiItem> getItems()

Gets all the items in this pane and all underlying panes

Specified by:

getItems in class Pane

Returns:

all items

clear

public void clear()

Clears the entire pane of any items/panes. Underlying panes will not be cleared.

Specified by:

clear in class Pane

load

@NotNull
 @Contract(value="_, null -> fail")
public static PaginatedPane load(@NotNull
                                                                                Object instance,
                                                                                @NotNull
                                                                                Element element)

Loads a paginated pane from a given element

Parameters:

instance - the instance class

element - the element

Returns:

the paginated pane