Package de.themoep.inventorygui

Class GuiPageElement

java.lang.Object

de.themoep.inventorygui.GuiElement

de.themoep.inventorygui.StaticGuiElement

de.themoep.inventorygui.GuiPageElement

public class GuiPageElement
extends StaticGuiElement

This is an element that allows for controlling the pagination of the gui. Untested und potentially unfinished.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GuiPageElement.PageAction

Nested classes/interfaces inherited from class de.themoep.inventorygui.GuiElement

GuiElement.Action, GuiElement.Click

Field Summary

Fields inherited from class de.themoep.inventorygui.GuiElement

gui, slots

Constructor Summary

Constructors

Constructor	Description
GuiPageElement(char slotChar, org.bukkit.inventory.ItemStack item, GuiPageElement.PageAction pageAction, String... text)	An element that allows for controlling the pagination of the gui.

Method Summary

Modifier and Type	Method	Description
org.bukkit.inventory.ItemStack	getItem(org.bukkit.entity.HumanEntity who, int slot)	Get the item that is displayed by this element on a certain page
boolean	isSilent()	Get whether or not this element should make a sound when interacted with
void	setSilent(boolean silent)	Set whether or not this element should make a sound when interacted with

Methods inherited from class de.themoep.inventorygui.StaticGuiElement

getNumber, getRawItem, getText, setItem, setNumber, setText

Methods inherited from class de.themoep.inventorygui.GuiElement

getAction, getGui, getSlotChar, getSlotIndex, getSlotIndex, getSlots, setAction, setGui, setSlots

Methods inherited from class java.lang.Object

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

Constructor Details

GuiPageElement

public GuiPageElement(char slotChar,
 org.bukkit.inventory.ItemStack item,
 GuiPageElement.PageAction pageAction,
 String... text)

An element that allows for controlling the pagination of the gui.

Parameters:

slotChar - The character to replace in the gui setup string

item - The ItemStack representing this element

pageAction - What kind of page action you want to happen when interacting with the element.

text - The text to display on this element, placeholders are automatically replaced, see InventoryGui.replaceVars(org.bukkit.entity.HumanEntity, java.lang.String, java.lang.String...) for a list of the placeholder variables. Empty text strings are also filter out, use a single space if you want to add an empty line!
If it's not set/empty the item's default name will be used

Method Details

isSilent

public boolean isSilent()

Get whether or not this element should make a sound when interacted with

Returns:

Whether or not to make a sound when interacted with

setSilent

public void setSilent(boolean silent)

Set whether or not this element should make a sound when interacted with

Parameters:

silent - Whether or not to make a sound when interacted with

getItem

public org.bukkit.inventory.ItemStack getItem(org.bukkit.entity.HumanEntity who,
 int slot)

Description copied from class: GuiElement

Get the item that is displayed by this element on a certain page

Overrides:

getItem in class StaticGuiElement

Parameters:

who - The player who views the page

slot - The slot to get the item for

Returns:

The ItemStack that is displayed as this element