Package de.placeblock.betterinventories.content.item.impl.togglebutton

Class ToggleGUIButton

java.lang.Object

de.placeblock.betterinventories.content.GUISection

de.placeblock.betterinventories.content.item.GUIItem

de.placeblock.betterinventories.content.item.GUIButton

de.placeblock.betterinventories.content.item.impl.togglebutton.ToggleGUIButton

All Implemented Interfaces:

Sizeable

public class ToggleGUIButton
extends GUIButton

GUIButton which toggles between on and off

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToggleGUIButton.AbstractBuilder<B extends ToggleGUIButton.AbstractBuilder<B,P>,P extends ToggleGUIButton>	Abstract Builder for creating ToggleGUIButton
static class	ToggleGUIButton.Builder	Builder for creating ToggleGUIButton

Field Summary

Fields inherited from class de.placeblock.betterinventories.content.item.GUIItem

BUTTON_SIZE, itemStack

Fields inherited from class de.placeblock.betterinventories.content.GUISection

maxSize, minSize

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ToggleGUIButton(GUI gui, int cooldown, org.bukkit.Sound sound, String permission, boolean toggled, Supplier<org.bukkit.inventory.ItemStack> enabledItem, Supplier<org.bukkit.inventory.ItemStack> disabledItem, ToggleConsumer onToggle)	Creates a new ToggleGUIButton

Method Summary

Modifier and Type	Method	Description
protected org.bukkit.inventory.ItemStack	getDisabledItem()
protected org.bukkit.inventory.ItemStack	getEnabledItem()
void	onClick(ClickData data)	Is called when the player clicks on the Button no matter how.
protected void	onToggle(ClickData clickData, boolean toggled)	Gets called when the Button gets toggled
void	toggle(ClickData clickData)	Toggles the state of the Button

Methods inherited from class de.placeblock.betterinventories.content.item.GUIButton

applyCooldown, click, hasPermission, onItemClick, onLeftClick, onRightClick, onShiftClick, onShiftLeftClick, onShiftRightClick, setCooldown

Methods inherited from class de.placeblock.betterinventories.content.item.GUIItem

onItemAdd, onItemAmount, onItemRemove, render, search

Methods inherited from class de.placeblock.betterinventories.content.GUISection

getEmptyContentList, getHeight, getSlots, getWidth, setSize, slotToVector, vectorToSlot

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.placeblock.betterinventories.Sizeable

clampSize, getMaxSize, getMinSize, getSize

Constructor Details

ToggleGUIButton

protected ToggleGUIButton(GUI gui,
 int cooldown,
 org.bukkit.Sound sound,
 String permission,
 boolean toggled,
 Supplier<org.bukkit.inventory.ItemStack> enabledItem,
 Supplier<org.bukkit.inventory.ItemStack> disabledItem,
 ToggleConsumer onToggle)

Creates a new ToggleGUIButton

Parameters:

gui - The GUI

permission - The permission required to toggle

toggled - The default value of the toggled-state

cooldown - The cooldown of the Button

sound - The sound played when pressing this button

enabledItem - Used to get the item which is displayed when the button is enabled

disabledItem - Used to get the item which is displayed when the button is disabled

onToggle - Executed when the button is toggled

Method Details

onClick

public void onClick(ClickData data)

Is called when the player clicks on the Button no matter how.

Overrides:

onClick in class GUIButton

Parameters:

data - The ClickData

toggle

public void toggle(ClickData clickData)

Toggles the state of the Button

Parameters:

clickData - The clickData of the action

getEnabledItem

protected org.bukkit.inventory.ItemStack getEnabledItem()

Returns:

The Item for the enabled-state

getDisabledItem

protected org.bukkit.inventory.ItemStack getDisabledItem()

Returns:

The Item for the disabled-state

onToggle

protected void onToggle(ClickData clickData,
 boolean toggled)

Gets called when the Button gets toggled

Parameters:

clickData - The clickData of the action

toggled - The current state