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, slot, uuid, x, y
Constructor Summary

Constructors

Constructor

Description

ToggleButton(int length, int height)

ToggleButton(int length, int height, boolean enabled)

ToggleButton(int length, int height, boolean enabled, @NotNull Plugin plugin)

Creates a new toggle button

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

ToggleButton(int x, int y, int length, int height, boolean enabled)

ToggleButton(int x, int y, int length, int height, boolean enabled, @NotNull Plugin plugin)

Creates a new toggle button

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

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

ToggleButton(int x, int y, int length, int height, @NotNull Pane.Priority priority, boolean enabled, @NotNull Plugin plugin)

Creates a new toggle button

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

Creates a new toggle button

ToggleButton(int x, int y, int length, int height, @NotNull Plugin plugin)

Creates a new toggle button

ToggleButton(int length, int height, @NotNull Plugin plugin)

Creates a new toggle button

ToggleButton(@NotNull Slot slot, int length, int height)

Creates a new toggle button

ToggleButton(@NotNull Slot slot, int length, int height, boolean enabled)

Creates a new toggle button

ToggleButton(@NotNull Slot slot, int length, int height, boolean enabled, @NotNull Plugin plugin)

Creates a new toggle button

ToggleButton(@NotNull Slot slot, int length, int height, @NotNull Pane.Priority priority)

Creates a new toggle button

ToggleButton(@NotNull Slot slot, int length, int height, @NotNull Pane.Priority priority, boolean enabled)

Creates a new toggle button

ToggleButton(@NotNull Slot slot, int length, int height, @NotNull Pane.Priority priority, boolean enabled, @NotNull Plugin plugin)

Creates a new toggle button

ToggleButton(@NotNull Slot slot, int length, int height, @NotNull Pane.Priority priority, @NotNull Plugin plugin)

Creates a new toggle button

ToggleButton(@NotNull Slot slot, int length, int height, @NotNull Plugin plugin)

Creates a new toggle button
Method Summary

Modifier and Type

Method

Description

void

allowToggle(boolean allowToggle)

Sets whether this toggle button can be toggled.

void

clear()

Clears the entire pane of any items/panes.

boolean

click(@NotNull Gui gui, @NotNull InventoryComponent inventoryComponent, @NotNull InventoryClickEvent event, int slot, int paneOffsetX, int paneOffsetY, int maxLength, int maxHeight)

Called whenever there is being clicked on this pane

@NotNull ToggleButton

copy()

Makes a copy of this pane and returns it.

void

display(@NotNull InventoryComponent inventoryComponent, int paneOffsetX, int paneOffsetY, int maxLength, int maxHeight)

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

@NotNull Collection<GuiItem>

getItems()

Gets all the items in this pane and all underlying panes.

@NotNull Collection<Pane>

getPanes()

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

boolean

isEnabled()

Gets whether this toggle button is currently enabled or disabled.

static @NotNull ToggleButton

load(@NotNull Object instance, @NotNull Element element)

Deprecated.
this method is no longer used internally and has been superseded by load(Object, Element, Plugin)

static @NotNull ToggleButton

load(@NotNull Object instance, @NotNull Element element, @NotNull Plugin plugin)

Loads a toggle button from an XML element

void

setDisabledItem(@NotNull GuiItem item)

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

void

setEnabledItem(@NotNull GuiItem item)

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

void

setHeight(int height)

Set the height of this pane

void

setLength(int length)

Set the length of this pane

void

toggle()

Toggles between the enabled and disabled states

Methods inherited from class com.github.stefvanschie.inventoryframework.pane.Pane
callOnClick, createBorder, createBorder, findMatchingItem, getHeight, getLength, getPriority, getSlot, getUUID, getX, getY, isVisible, load, loadItem, loadItem, matchesItem, registerProperty, setOnClick, setPriority, setSlot, setVisible, setX, setY

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ToggleButton
  
  public ToggleButton(@NotNull @NotNull Slot slot, int length, int height, @NotNull @NotNull Pane.Priority priority, boolean enabled, @NotNull @NotNull Plugin plugin)
  
  Creates a new toggle button
  Parameters:
  
  slot - the slot
  
  length - the length
  
  height - the height
  
  priority - the priority
  
  enabled - whether the button should start in its enabled or disabled state
  
  plugin - the plugin that will be the owner of this button's items
  
  Since:
  
  0.10.8
  
  See Also:
  
  ToggleButton(int, int, int, int, Priority, boolean)
- ToggleButton
  
  public ToggleButton(int x, int y, int length, int height, @NotNull @NotNull Pane.Priority priority, boolean enabled, @NotNull @NotNull Plugin plugin)
  
  Creates a new toggle button
  Parameters:
  
  x - the x coordinate
  
  y - the y coordinate
  
  length - the length
  
  height - the height
  
  priority - the priority
  
  enabled - whether the button should start in its enabled or disabled state
  
  plugin - the plugin that will be the owner of this button's items
  
  Since:
  
  0.10.8
  
  See Also:
  
  ToggleButton(int, int, int, int, Priority, boolean)
- ToggleButton
  
  public ToggleButton(@NotNull @NotNull Slot slot, int length, int height, @NotNull @NotNull Pane.Priority priority, @NotNull @NotNull Plugin plugin)
  
  Creates a new toggle button
  Parameters:
  
  slot - the slot
  
  length - the length
  
  height - the height
  
  priority - the priority
  
  plugin - the plugin that will be the owner of this button's items
  
  Since:
  
  0.10.8
  
  See Also:
  
  ToggleButton(Slot, int, int, Priority)
- ToggleButton
  
  public ToggleButton(int x, int y, int length, int height, @NotNull @NotNull Pane.Priority priority, @NotNull @NotNull Plugin plugin)
  
  Creates a new toggle button
  Parameters:
  
  x - the x coordinate
  
  y - the y coordinate
  
  length - the length
  
  height - the height
  
  priority - the priority
  
  plugin - the plugin that will be the owner of this button's items
  
  Since:
  
  0.10.8
  
  See Also:
  
  ToggleButton(int, int, int, int, Priority)
- ToggleButton
  
  public ToggleButton(@NotNull @NotNull Slot slot, int length, int height, boolean enabled, @NotNull @NotNull Plugin plugin)
  
  Creates a new toggle button
  Parameters:
  
  slot - the slot
  
  length - the length
  
  height - the height
  
  enabled - whether the button should start in its enabled or disabled state
  
  plugin - the plugin that will be the owner of this button's items
  
  Since:
  
  0.10.8
  
  See Also:
  
  ToggleButton(Slot, int, int, boolean)
- ToggleButton
  
  public ToggleButton(int x, int y, int length, int height, boolean enabled, @NotNull @NotNull Plugin plugin)
  
  Creates a new toggle button
  Parameters:
  
  x - the x coordinate
  
  y - the y coordinate
  
  length - the length
  
  height - the height
  
  enabled - whether the button should start in its enabled or disabled state
  
  plugin - the plugin that will be the owner of this button's items
  
  Since:
  
  0.10.8
  
  See Also:
  
  ToggleButton(int, int, int, int, boolean)
- ToggleButton
  
  public ToggleButton(@NotNull @NotNull Slot slot, int length, int height, @NotNull @NotNull Plugin plugin)
  
  Creates a new toggle button
  Parameters:
  
  slot - the slot
  
  length - the length
  
  height - the height
  
  plugin - the plugin that will be the owner of this button's items
  
  Since:
  
  0.10.8
  
  See Also:
  
  ToggleButton(Slot, int, int)
- ToggleButton
  
  public ToggleButton(int x, int y, int length, int height, @NotNull @NotNull Plugin plugin)
  
  Creates a new toggle button
  Parameters:
  
  x - the x coordinate
  
  y - the y coordinate
  
  length - the length
  
  height - the height
  
  plugin - the plugin that will be the owner of this button's items
  
  Since:
  
  0.10.8
  
  See Also:
  
  ToggleButton(int, int, int, int)
- ToggleButton
  
  public ToggleButton(int length, int height, boolean enabled, @NotNull @NotNull Plugin plugin)
  
  Creates a new toggle button
  Parameters:
  
  length - the length
  
  height - the height
  
  enabled - whether the button should start in its enabled or disabled state
  
  plugin - the plugin that will be the owner of this button's items
  
  Since:
  
  0.10.8
  
  See Also:
  
  ToggleButton(int, int, boolean)
- ToggleButton
  
  public ToggleButton(int length, int height, @NotNull @NotNull Plugin plugin)
  
  Creates a new toggle button
  Parameters:
  
  length - the length
  
  height - the height
  
  plugin - the plugin that will be the owner of this button's items
  
  Since:
  
  0.10.8
  
  See Also:
  
  ToggleButton(int, int)
- ToggleButton
  
  public ToggleButton(@NotNull @NotNull Slot slot, int length, int height, @NotNull @NotNull Pane.Priority priority, boolean enabled)
  
  Creates a new toggle button
  
  Parameters:
  
  slot - the slot
  
  length - the length
  
  height - the height
  
  priority - the priority
  
  enabled - whether the button should start in its enabled or disabled state
  
  Since:
  
  0.10.8
- ToggleButton
  
  public ToggleButton(int x, int y, int length, int height, @NotNull @NotNull Pane.Priority priority, boolean enabled)
- ToggleButton
  
  public ToggleButton(@NotNull @NotNull Slot slot, int length, int height, @NotNull @NotNull Pane.Priority priority)
  
  Creates a new toggle button
  
  Parameters:
  
  slot - the slot
  
  length - the length
  
  height - the height
  
  priority - the priority
  
  Since:
  
  0.10.8
- ToggleButton
  
  public ToggleButton(int x, int y, int length, int height, @NotNull @NotNull Pane.Priority priority)
- ToggleButton
  
  public ToggleButton(@NotNull @NotNull Slot slot, int length, int height, boolean enabled)
  
  Creates a new toggle button
  
  Parameters:
  
  slot - the slot
  
  length - the length
  
  height - the height
  
  enabled - whether the button should start in its enabled or disabled state
  
  Since:
  
  0.10.8
- ToggleButton
  
  public ToggleButton(int x, int y, int length, int height, boolean enabled)
- ToggleButton
  
  public ToggleButton(@NotNull @NotNull Slot slot, int length, int height)
  
  Creates a new toggle button
  
  Parameters:
  
  slot - the slot
  
  length - the length
  
  height - the height
  
  Since:
  
  0.10.8
- ToggleButton
  
  public ToggleButton(int x, int y, int length, int height)
- ToggleButton
  
  public ToggleButton(int length, int height, boolean enabled)
- ToggleButton
  
  public ToggleButton(int length, int height)
Method Details
- display
  
  public void display(@NotNull @NotNull InventoryComponent inventoryComponent, int paneOffsetX, int paneOffsetY, int maxLength, int maxHeight)
  
  Description copied from class: Pane
  
  Has to set all the items in the right spot inside the inventory
  
  Specified by:
  
  display in class Pane
  
  Parameters:
  
  inventoryComponent - the inventory component in which the items should be displayed
  
  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 @NotNull Gui gui, @NotNull @NotNull InventoryComponent inventoryComponent, @NotNull @NotNull InventoryClickEvent event, int slot, int paneOffsetX, int paneOffsetY, int maxLength, int maxHeight)
  
  Description copied from class: Pane
  
  Called whenever there is being clicked on this pane
  
  Specified by:
  
  click in class Pane
  
  Parameters:
  
  gui - the gui in which was clicked
  
  inventoryComponent - the inventory component in which this pane resides
  
  event - the event that occurred while clicking on this item
  
  slot - the slot that was clicked in
  
  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
- copy
  
  @NotNull @Contract(pure=true) public @NotNull ToggleButton copy()
  
  Description copied from class: Pane
  
  Makes a copy of this pane and returns it. This makes a deep copy of the pane. This entails that the underlying panes and/or items will be copied as well. The returned pane will never be reference equal to the current pane.
  
  Overrides:
  
  copy in class Pane
  
  Returns:
  
  a copy of this pane
- setLength
  
  public void setLength(int length)
  
  Description copied from class: Pane
  
  Set the length of this pane
  
  Overrides:
  
  setLength in class Pane
  
  Parameters:
  
  length - the new length
- setHeight
  
  public void setHeight(int height)
  
  Description copied from class: Pane
  
  Set the height of this pane
  
  Overrides:
  
  setHeight in class Pane
  
  Parameters:
  
  height - the new height
- setDisabledItem
  
  public void setDisabledItem(@NotNull @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 @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 @NotNull Collection<GuiItem> getItems()
  
  Description copied from class: Pane
  
  Gets all the items in this pane and all underlying panes. The returned collection is not guaranteed to be mutable or to be a view of the underlying data. (So changes to the gui are not guaranteed to be visible in the returned value.)
  
  Specified by:
  
  getItems in class Pane
  
  Returns:
  
  all items
- getPanes
  
  @NotNull public @NotNull Collection<Pane> getPanes()
  
  Description copied from class: Pane
  
  Gets all the panes in this panes, including any child panes from other panes. The returned collection is not guaranteed to be mutable or to be a view of the underlying data. (So changes to the gui are not guaranteed to be visible in the returned value.)
  
  Specified by:
  
  getPanes in class Pane
  
  Returns:
  
  all panes
- allowToggle
  
  public void allowToggle(boolean allowToggle)
  
  Sets whether this toggle button can be toggled. This only prevents players from toggling the button and does not prevent toggling the button programmatically with methods such as toggle().
  
  Parameters:
  
  allowToggle - whether this button can be toggled
  
  Since:
  
  0.10.8
- isEnabled
  
  @Contract(pure=true) public boolean isEnabled()
  
  Gets whether this toggle button is currently enabled or disabled.
  
  Returns:
  
  whether the button is enabled or disabled
  
  Since:
  
  0.9.6
- toggle
  
  public void toggle()
  
  Toggles between the enabled and disabled states
  
  Since:
  
  0.5.0
- clear
  
  public void clear()
  
  Description copied from class: Pane
  
  Clears the entire pane of any items/panes. Underlying panes will not be cleared.
  
  Specified by:
  
  clear in class Pane
- load
  
  @NotNull @Contract(pure=true) public static @NotNull ToggleButton load(@NotNull @NotNull Object instance, @NotNull @NotNull Element element, @NotNull @NotNull Plugin plugin)
  
  Loads a toggle button from an XML element
  
  Parameters:
  
  instance - the instance class
  
  element - the element
  
  plugin - the plugin that will be the owner of the underlying items
  
  Returns:
  
  the toggle button
  
  Since:
  
  0.10.8
- load
  
  @NotNull @Contract(pure=true) @Deprecated public static @NotNull ToggleButton load(@NotNull @NotNull Object instance, @NotNull @NotNull Element element)
  
  Deprecated.
  this method is no longer used internally and has been superseded by load(Object, Element, Plugin)
  
  Loads a toggle button from an XML element
  
  Parameters:
  
  instance - the instance class
  
  element - the element
  
  Returns:
  
  the toggle button
  
  Since:
  
  0.5.0

Class ToggleButton

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Details

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

ToggleButton

Method Details

display

click

copy

setLength

setHeight

setDisabledItem

setEnabledItem

getItems

getPanes

allowToggle

isEnabled

toggle

clear

load

load