Package 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

  • Constructor Details

    • ToggleButton

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

    • ToggleButton

      public ToggleButton​(int length, int height)

    • ToggleButton

      public ToggleButton​(int x, int y, 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 org.bukkit.event.inventory.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

    • 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

    • 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)
      Loads a toggle button from an XML element
      Parameters:
      instance - the instance class
      element - the element
      Returns:
      the toggle button
      Since:
      0.5.0