Class AbstractListMenu<T>

java.lang.Object

ua.mcchickenstudio.opencreative.menus.AbstractMenu

ua.mcchickenstudio.opencreative.menus.AbstractListMenu<T>

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder, InventoryMenu

Direct Known Subclasses:

ListBrowserMenu, WorldEnvironmentColorMenu

public abstract class AbstractListMenu<T>
extends AbstractMenu

AbstractListMenu

This class represents a AbstractMenu that has scrollable list of elements. It creates pages and arrows to change current page.

See Also:

• AbstractMenu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractListMenu.PlacementLayout

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<T>	elements

Fields inherited from class AbstractMenu

AIR_ITEM, creationTime, DECORATION_ITEM, DECORATION_PANE_ITEM, DISABLED_ITEM, inventory, NO_PERMS_ITEM

Modifier and Type	Field	Description
protected final org.bukkit.inventory.ItemStack	AIR_ITEM
protected final long	creationTime
protected final org.bukkit.inventory.ItemStack	DECORATION_ITEM
protected final org.bukkit.inventory.ItemStack	DECORATION_PANE_ITEM
protected final org.bukkit.inventory.ItemStack	DISABLED_ITEM
protected org.bukkit.inventory.Inventory	inventory
protected final org.bukkit.inventory.ItemStack	NO_PERMS_ITEM

Constructor Summary

Constructors

Constructor	Description
AbstractListMenu(org.bukkit.entity.Player player, String title, int[] elementsSlots, int[] charmsBarSlots, int[] decorationSlots)
AbstractListMenu(org.bukkit.entity.Player player, String title, AbstractListMenu.PlacementLayout layout)

Method Summary

Modifier and Type	Method	Description
protected void	fillDecorationItems()
protected void	fillElements(int page)
protected void	fillEmpty()
void	fillItems(org.bukkit.entity.Player player)
protected abstract void	fillOtherItems()
protected int[]	getCharmsBarSlots()
int	getCurrentPage()
protected int[]	getDecorationSlots()
protected abstract org.bukkit.inventory.ItemStack	getElementIcon(T element)
protected abstract List<T>	getElements()
protected List<T>	getElementsFromPage(int page)
protected int[]	getElementsSlots()
protected int	getNextPage()
final int	getPages()
protected org.bukkit.entity.Player	getPlayer()
protected int	getPreviousPage()
protected void	nextPage()
protected abstract void	onCharmsBarClick(org.bukkit.event.inventory.InventoryClickEvent event)
void	onClick(@NotNull org.bukkit.event.inventory.InventoryClickEvent event)	Executes when player clicks in inventory.
protected abstract void	onElementClick(org.bukkit.event.inventory.InventoryClickEvent event)
protected void	previousPage()
void	setCurrentPage(int currentPage)

Methods inherited from class AbstractMenu

getCreationTime, getInventory, getItem, getRows, getSize, getTitle, isClickedInMenuSlots, isNotEmpty, isPlayerClicked, onOpen, open, reverse, setItem, setItem, setRows, setTitle

Modifier and Type	Method	Description
long	getCreationTime()	Returns the creation time of menu in milliseconds of Unix format.
@NotNull org.bukkit.inventory.Inventory	getInventory()
@NotNull org.bukkit.inventory.ItemStack	getItem(int slot)
int	getRows()
int	getSize()
String	getTitle()
protected final boolean	isClickedInMenuSlots(org.bukkit.event.inventory.InventoryClickEvent event)
protected boolean	isNotEmpty(org.bukkit.inventory.ItemStack item)
protected final boolean	isPlayerClicked(org.bukkit.event.inventory.InventoryClickEvent event)
abstract void	onOpen(@NotNull org.bukkit.event.inventory.InventoryOpenEvent event)	Executes when player opens inventory and sees it first time.
void	open(@NotNull org.bukkit.entity.Player player)	Opens the inventory for player.
protected int	reverse(int slot)
void	setItem(int slot, org.bukkit.inventory.ItemStack item)
void	setItem(org.bukkit.inventory.ItemStack item, int... slots)
protected void	setRows(int rows)
void	setTitle(String title)

Methods inherited from class Object

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

Methods inherited from interface InventoryMenu

destroy, onClose

Modifier and Type	Method	Description
default void	destroy()	Destroys menus from memory and disables all event listeners for it.
default void	onClose(@NotNull org.bukkit.event.inventory.InventoryCloseEvent event)	Executes when player closes inventory.

Field Details

elements

protected final List<T> elements

Constructor Details

AbstractListMenu

public AbstractListMenu(org.bukkit.entity.Player player,
 String title,
 AbstractListMenu.PlacementLayout layout)

AbstractListMenu

public AbstractListMenu(org.bukkit.entity.Player player,
 String title,
 int[] elementsSlots,
 int[] charmsBarSlots,
 int[] decorationSlots)

Method Details

getCurrentPage

public int getCurrentPage()

setCurrentPage

public void setCurrentPage(int currentPage)

getElementIcon

protected abstract org.bukkit.inventory.ItemStack getElementIcon(T element)

fillOtherItems

protected abstract void fillOtherItems()

onCharmsBarClick

protected abstract void onCharmsBarClick(org.bukkit.event.inventory.InventoryClickEvent event)

onElementClick

protected abstract void onElementClick(org.bukkit.event.inventory.InventoryClickEvent event)

getElements

protected abstract List<T> getElements()

fillDecorationItems

protected void fillDecorationItems()

fillElements

protected void fillElements(int page)

fillEmpty

protected void fillEmpty()

getElementsFromPage

protected List<T> getElementsFromPage(int page)

getPages

public final int getPages()

fillItems

public void fillItems(org.bukkit.entity.Player player)

Specified by:

fillItems in class AbstractMenu

onClick

public void onClick(@NotNull
 @NotNull org.bukkit.event.inventory.InventoryClickEvent event)

Description copied from interface: InventoryMenu

Executes when player clicks in inventory.

Specified by:

onClick in interface InventoryMenu

Specified by:

onClick in class AbstractMenu

Parameters:

event - event of click in inventory.

nextPage

protected void nextPage()

previousPage

protected void previousPage()

getPlayer

protected org.bukkit.entity.Player getPlayer()

getPreviousPage

protected int getPreviousPage()

getNextPage

protected int getNextPage()

getElementsSlots

protected int[] getElementsSlots()

getCharmsBarSlots

protected int[] getCharmsBarSlots()

getDecorationSlots

protected int[] getDecorationSlots()