com.github.stefvanschie.inventoryframework.pane.component

Class ToggleButton

java.lang.Object

com.github.stefvanschie.inventoryframework.pane.Pane

com.github.stefvanschie.inventoryframework.pane.component.ToggleButton

public class ToggleButton
extends Pane

A button that toggles between an enabled and disabled state.

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

Method Summary

Modifier and Type	Method and Description
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
Collection<Pane>	getPanes() Gets all the panes in this panes, including any child panes from other panes
static ToggleButton	load(Object instance, Element element) Loads a toggle button from an XML element
void	setDisabledItem(GuiItem item) Sets the item to use when the button is set to disabled
void	setEnabledItem(GuiItem item) Sets the item to use when the button is set to enabled
void	toggle() Toggles between the enabled and disabled states

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

ToggleButton

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

ToggleButton

public ToggleButton(int length,
                    int height)

ToggleButton

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

Method Detail

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

setDisabledItem

public void setDisabledItem(@NotNull
                            GuiItem item)

Sets the item to use when the button is set to disabled

Parameters:

item - the disabled item

Since:

0.5.0

setEnabledItem

public void setEnabledItem(@NotNull
                           GuiItem item)

Sets the item to use when the button is set to enabled

Parameters:

item - the enabled item

Since:

0.5.0

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

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

toggle

public void toggle()

Toggles between the enabled and disabled states

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

load

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

Loads a toggle button from an XML element

Parameters:

instance - the instance class

element - the element

Returns:

the toggle button

Since:

0.5.0