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

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.ToggleGUIButton

All Implemented Interfaces:

Sizeable

public abstract class ToggleGUIButton
extends GUIButton

GUIButton which toggles between on and off

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

Constructor	Description
ToggleGUIButton(GUI gui)	Creates a new ToggleGUIButton
ToggleGUIButton(GUI gui, boolean toggled)	Creates a new ToggleGUIButton
ToggleGUIButton(GUI gui, String permission)	Creates a new ToggleGUIButton
ToggleGUIButton(GUI gui, String permission, boolean toggled)	Creates a new ToggleGUIButton

Method Summary

Modifier and Type	Method	Description
protected abstract org.bukkit.inventory.ItemStack	getDisabledItem()
protected abstract org.bukkit.inventory.ItemStack	getEnabledItem()
protected abstract void	onToggle(boolean toggled)	Gets called when the Button gets toggled
void	toggle()	Toggles the state of the Button

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

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

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

getSectionAt, getSectionAt, render

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

public ToggleGUIButton(GUI gui)

Creates a new ToggleGUIButton

Parameters:

gui - The GUI

ToggleGUIButton

public ToggleGUIButton(GUI gui,
 boolean toggled)

Creates a new ToggleGUIButton

Parameters:

gui - The GUI

toggled - The default value of the toggled-state

ToggleGUIButton

public ToggleGUIButton(GUI gui,
 String permission)

Creates a new ToggleGUIButton

Parameters:

gui - The GUI

permission - The permission required to toggle

ToggleGUIButton

public ToggleGUIButton(GUI gui,
 String permission,
 boolean toggled)

Creates a new ToggleGUIButton

Parameters:

gui - The GUI

permission - The permission required to toggle

toggled - The default value of the toggled-state

Method Details

toggle

public void toggle()

Toggles the state of the Button

getEnabledItem

protected abstract org.bukkit.inventory.ItemStack getEnabledItem()

Returns:

The Item for the enabled-state

getDisabledItem

protected abstract org.bukkit.inventory.ItemStack getDisabledItem()

Returns:

The Item for the disabled-state

onToggle

protected abstract void onToggle(boolean toggled)

Gets called when the Button gets toggled

Parameters:

toggled - The current state