com.github.stefvanschie.inventoryframework.pane.component

Class CycleButton

java.lang.Object

com.github.stefvanschie.inventoryframework.pane.Pane

com.github.stefvanschie.inventoryframework.pane.component.CycleButton

public class CycleButton
extends Pane

A button for cycling between different options

Since:

0.5.0

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
CycleButton(int length, int height)
CycleButton(int x, int y, int length, int height)
CycleButton(int x, int y, int length, int height, Pane.Priority priority)

Method Summary

Modifier and Type	Method and Description
void	addPane(int index, Pane pane) Adds a pane to the current list of options
void	addPane(Pane pane) Adds a pane to the current list of options
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	cycle() Cycles through one option, making it go to the next one
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
Collection<Pane>	getPanes() Gets all the panes in this panes, including any child panes from other panes
static CycleButton	load(Object instance, Element element) Loads a cycle button from a given element

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

CycleButton

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

CycleButton

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

CycleButton

public CycleButton(int length,
                   int height)

Method Detail

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

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

getItems

@NotNull
public Collection<GuiItem> getItems()

Gets all the items in this pane and all underlying panes

Specified by:

getItems in class Pane

Returns:

all items

addPane

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

Adds a pane to the current list of options

Parameters:

index - the index to insert the pane at

pane - the pane to add

Since:

0.5.0

addPane

public void addPane(@NotNull
                    Pane pane)

Adds a pane to the current list of options

Parameters:

pane - the pane to add

Since:

0.5.0

clear

public void clear()

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

Specified by:

clear in class Pane

getPanes

@NotNull
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

cycle

public void cycle()

Cycles through one option, making it go to the next one

Since:

0.5.0

load

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

Loads a cycle button from a given element

Parameters:

instance - the instance class

element - the element

Returns:

the cycle button

Since:

0.5.0