Class ListBrowserMenu<T>

java.lang.Object

ua.mcchickenstudio.opencreative.menus.AbstractMenu

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

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

Type Parameters:

T - type of elements, that will be stored in list.

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder, InventoryMenu

Direct Known Subclasses:

ContentWithMenusCategoryMenu, EntitiesBrowserMenu, FunctionChooserMenu, MethodChooserMenu, ModulesBrowserMenu, OwnModulesBrowserMenu, OwnWorldsBrowserMenu, ParticlesMenu, PlayersBrowserMenu, PotionsMenu, RecommendedWorldsBrowserMenu, WorldsBrowserMenu

public abstract class ListBrowserMenu<T>
extends AbstractListMenu<T>

ListBrowserMenu

This class represents a menu that stores list of elements and has arrows to change pages.

See Also:

• AbstractListMenu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ListBrowserMenu.PlacementLayout

Field Summary

Fields inherited from class AbstractListMenu

elements

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
ListBrowserMenu(org.bukkit.entity.Player player, String title)
ListBrowserMenu(org.bukkit.entity.Player player, String title, int[] elementsSlots, int[] charmsBarSlots, int[] decorationSlots, int noElementsPageButtonSlot, int previousPageButtonSlot, int nextPageButtonSlot)
ListBrowserMenu(org.bukkit.entity.Player player, String title, ListBrowserMenu.PlacementLayout layout)
ListBrowserMenu(org.bukkit.entity.Player player, String title, ListBrowserMenu.PlacementLayout layout, int[] charmsBarSlots, int[] decorationSlots)

Method Summary

Modifier and Type	Method	Description
protected void	fillArrowsItems(int currentPage)
protected void	fillElements(int page)
protected void	fillEmpty()
void	fillItems(org.bukkit.entity.Player player)
protected abstract void	fillOtherItems()
protected List<T>	filterList(List<T> list, Predicate<T> predicate)
List<T>	getCurrentElements()
org.bukkit.inventory.ItemStack	getElementIcon(int index)
protected abstract org.bukkit.inventory.ItemStack	getElementIcon(T element)
abstract List<T>	getElements()
protected abstract org.bukkit.inventory.ItemStack	getNextPageButton()
protected int	getNextPageButtonSlot()
protected org.bukkit.inventory.ItemStack	getNextPageEmptyButton()
protected abstract org.bukkit.inventory.ItemStack	getNoElementsButton()
protected int	getNoElementsPageButtonSlot()
protected abstract org.bukkit.inventory.ItemStack	getPreviousPageButton()
protected int	getPreviousPageButtonSlot()
protected org.bukkit.inventory.ItemStack	getPreviousPageEmptyButton()
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	updateElements()

Methods inherited from class AbstractListMenu

fillDecorationItems, getCharmsBarSlots, getCurrentPage, getDecorationSlots, getElementsFromPage, getElementsSlots, getNextPage, getPages, getPlayer, getPreviousPage, setCurrentPage

Modifier and Type	Method	Description
protected void	fillDecorationItems()
protected int[]	getCharmsBarSlots()
int	getCurrentPage()
protected int[]	getDecorationSlots()
protected List<T>	getElementsFromPage(int page)
protected int[]	getElementsSlots()
protected int	getNextPage()
final int	getPages()
protected org.bukkit.entity.Player	getPlayer()
protected int	getPreviousPage()
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.

Constructor Details

ListBrowserMenu

public ListBrowserMenu(org.bukkit.entity.Player player,
 String title)

ListBrowserMenu

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

ListBrowserMenu

public ListBrowserMenu(org.bukkit.entity.Player player,
 String title,
 ListBrowserMenu.PlacementLayout layout,
 int[] charmsBarSlots,
 int[] decorationSlots)

ListBrowserMenu

public ListBrowserMenu(org.bukkit.entity.Player player,
 String title,
 int[] elementsSlots,
 int[] charmsBarSlots,
 int[] decorationSlots,
 int noElementsPageButtonSlot,
 int previousPageButtonSlot,
 int nextPageButtonSlot)

Method Details

getElementIcon

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

Specified by:

getElementIcon in class AbstractListMenu<T>

fillOtherItems

protected abstract void fillOtherItems()

Specified by:

fillOtherItems in class AbstractListMenu<T>

onCharmsBarClick

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

Specified by:

onCharmsBarClick in class AbstractListMenu<T>

onElementClick

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

Specified by:

onElementClick in class AbstractListMenu<T>

getElements

public abstract List<T> getElements()

Specified by:

getElements in class AbstractListMenu<T>

getNextPageButton

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

getPreviousPageButton

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

getNoElementsButton

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

getNextPageEmptyButton

protected org.bukkit.inventory.ItemStack getNextPageEmptyButton()

getPreviousPageEmptyButton

protected org.bukkit.inventory.ItemStack getPreviousPageEmptyButton()

fillArrowsItems

protected void fillArrowsItems(int currentPage)

fillElements

protected void fillElements(int page)

Overrides:

fillElements in class AbstractListMenu<T>

fillEmpty

protected void fillEmpty()

Overrides:

fillEmpty in class AbstractListMenu<T>

fillItems

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

Overrides:

fillItems in class AbstractListMenu<T>

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

Overrides:

onClick in class AbstractListMenu<T>

Parameters:

event - event of click in inventory.

getElementIcon

public org.bukkit.inventory.ItemStack getElementIcon(int index)

updateElements

public void updateElements()

getCurrentElements

public List<T> getCurrentElements()

nextPage

protected void nextPage()

Overrides:

nextPage in class AbstractListMenu<T>

previousPage

protected void previousPage()

Overrides:

previousPage in class AbstractListMenu<T>

filterList

protected List<T> filterList(List<T> list,
 Predicate<T> predicate)

getNextPageButtonSlot

protected int getNextPageButtonSlot()

getPreviousPageButtonSlot

protected int getPreviousPageButtonSlot()

getNoElementsPageButtonSlot

protected int getNoElementsPageButtonSlot()