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

Class CycleGUIButton<E extends CycleEnum>

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.cyclebutton.CycleGUIButton<E>

Type Parameters:

E - The Enum

All Implemented Interfaces:

Sizeable

public abstract class CycleGUIButton<E extends CycleEnum>
extends GUIButton

GUIButton which cycles through values of an Enum

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CycleGUIButton.Builder<E extends CycleEnum>	Builder for creating CycleGUIButton

Nested classes/interfaces inherited from class de.placeblock.betterinventories.content.item.GUIButton

GUIButton.AbstractBuilder<B extends GUIButton.AbstractBuilder<B,P>,P extends GUIButton>

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
CycleGUIButton(GUI gui, int cooldown, org.bukkit.Sound sound, E[] values, E startValue)	Creates a new CycleGUIButton.

Method Summary

Modifier and Type	Method	Description
void	cycle(ClickData data)	Cycles the Values
protected org.bukkit.inventory.ItemStack	getItem(E value)	Returns the Item to be displayed for an Enum-value Can be overridden for modifying Enum-Item-conversion
void	onClick(ClickData data)	Is called when the player clicks on the Button no matter how.
protected abstract void	onCycle(ClickData data, E newValue)	Is called when cycling through the Enum-values

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

CycleGUIButton

public CycleGUIButton(GUI gui,
 int cooldown,
 org.bukkit.Sound sound,
 E[] values,
 E startValue)

Creates a new CycleGUIButton. The permission is passed in the various enum values.

Parameters:

gui - The GUI

values - The Enum values

startValue - The Start-value

cooldown - The cooldown of the Button. Applied to the material, not the Button alone.

sound - The sound that is played when pressing that button

Method Details

getItem

protected org.bukkit.inventory.ItemStack getItem(E value)

Returns the Item to be displayed for an Enum-value Can be overridden for modifying Enum-Item-conversion

Parameters:

value - The Enum-value

Returns:

The according ItemStack

onClick

public void onClick(ClickData data)

Description copied from class: GUIButton

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

Specified by:

onClick in class GUIButton

Parameters:

data - The ClickData

cycle

public void cycle(ClickData data)

Cycles the Values

Parameters:

data - The clickData if the click event

onCycle

protected abstract void onCycle(ClickData data,
 E newValue)

Is called when cycling through the Enum-values

Parameters:

data - The ClickData

newValue - The new Enum-value