Class WorldsBrowserMenu

java.lang.Object

ua.mcchickenstudio.opencreative.menus.AbstractMenu

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

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

ua.mcchickenstudio.opencreative.menus.world.browsers.WorldsBrowserMenu

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder, InventoryMenu

Direct Known Subclasses:

WorldsPickerMenu

public class WorldsBrowserMenu
extends ListBrowserMenu<Planet>

This class represents a menu, that displays specified list of worlds. Player can sort worlds and change pages.

Nested Class Summary

Nested classes/interfaces inherited from class ListBrowserMenu

ListBrowserMenu.PlacementLayout

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<Planet>	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
WorldsBrowserMenu(org.bukkit.entity.Player player, Set<Planet> planets)
WorldsBrowserMenu(org.bukkit.entity.Player player, Set<Planet> planets, boolean withRecommendedButton)

Method Summary

Modifier and Type	Method	Description
protected void	fillArrowsItems(int currentPage)
protected void	fillOtherItems()
protected org.bukkit.inventory.ItemStack	getElementIcon(Planet planet)
List<Planet>	getElements()
protected org.bukkit.inventory.ItemStack	getNextPageButton()
protected org.bukkit.inventory.ItemStack	getNoElementsButton()
protected org.bukkit.inventory.ItemStack	getPreviousPageButton()
protected void	onCharmsBarClick(org.bukkit.event.inventory.InventoryClickEvent event)
protected void	onElementClick(org.bukkit.event.inventory.InventoryClickEvent event)
void	onOpen(@NotNull org.bukkit.event.inventory.InventoryOpenEvent event)	Executes when player opens inventory and sees it first time.
protected void	onPlanetClick(org.bukkit.entity.Player player, Planet planet)

Methods inherited from class ListBrowserMenu

fillElements, fillEmpty, fillItems, filterList, getCurrentElements, getElementIcon, getNextPageButtonSlot, getNextPageEmptyButton, getNoElementsPageButtonSlot, getPreviousPageButtonSlot, getPreviousPageEmptyButton, nextPage, onClick, previousPage, updateElements

Modifier and Type	Method	Description
protected void	fillElements(int page)
protected void	fillEmpty()
void	fillItems(org.bukkit.entity.Player player)
protected List<Planet>	filterList(List<Planet> list, Predicate<Planet> predicate)
List<Planet>	getCurrentElements()
org.bukkit.inventory.ItemStack	getElementIcon(int index)
protected int	getNextPageButtonSlot()
protected org.bukkit.inventory.ItemStack	getNextPageEmptyButton()
protected int	getNoElementsPageButtonSlot()
protected int	getPreviousPageButtonSlot()
protected org.bukkit.inventory.ItemStack	getPreviousPageEmptyButton()
protected void	nextPage()
void	onClick(@NotNull org.bukkit.event.inventory.InventoryClickEvent event)	Executes when player clicks in inventory.
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<Planet>	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, 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)
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

WorldsBrowserMenu

public WorldsBrowserMenu(org.bukkit.entity.Player player,
 Set<Planet> planets)

WorldsBrowserMenu

public WorldsBrowserMenu(org.bukkit.entity.Player player,
 Set<Planet> planets,
 boolean withRecommendedButton)

Method Details

getElementIcon

protected org.bukkit.inventory.ItemStack getElementIcon(Planet planet)

Specified by:

getElementIcon in class ListBrowserMenu<Planet>

fillOtherItems

protected void fillOtherItems()

Specified by:

fillOtherItems in class ListBrowserMenu<Planet>

onCharmsBarClick

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

Specified by:

onCharmsBarClick in class ListBrowserMenu<Planet>

onElementClick

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

Specified by:

onElementClick in class ListBrowserMenu<Planet>

onPlanetClick

protected void onPlanetClick(org.bukkit.entity.Player player,
 Planet planet)

fillArrowsItems

protected void fillArrowsItems(int currentPage)

Overrides:

fillArrowsItems in class ListBrowserMenu<Planet>

getElements

public List<Planet> getElements()

Specified by:

getElements in class ListBrowserMenu<Planet>

getNextPageButton

protected org.bukkit.inventory.ItemStack getNextPageButton()

Specified by:

getNextPageButton in class ListBrowserMenu<Planet>

getPreviousPageButton

protected org.bukkit.inventory.ItemStack getPreviousPageButton()

Specified by:

getPreviousPageButton in class ListBrowserMenu<Planet>

getNoElementsButton

protected org.bukkit.inventory.ItemStack getNoElementsButton()

Specified by:

getNoElementsButton in class ListBrowserMenu<Planet>

onOpen

public void onOpen(@NotNull
 @NotNull org.bukkit.event.inventory.InventoryOpenEvent event)

Description copied from interface: InventoryMenu

Executes when player opens inventory and sees it first time. Useful for playing sounds or setting items.

Specified by:

onOpen in interface InventoryMenu

Specified by:

onOpen in class AbstractMenu

Parameters:

event - event of inventory open.