Package studio.magemonkey.codex.manager.api.menu

Class Menu

java.lang.Object

studio.magemonkey.codex.manager.api.menu.Menu

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

Direct Known Subclasses:

FileExplorerMenu

public abstract class Menu
extends Object
implements org.bukkit.inventory.InventoryHolder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Menu.NextPageButton
static class	Menu.PreviousPageButton

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	fakeClosing
protected org.bukkit.inventory.Inventory	inventory
protected boolean	opening
protected Menu	parentMenu
protected final org.bukkit.entity.Player	player
protected final int	rows
protected final TreeMap<Integer,Slot>	slots
protected final String	title

Constructor Summary

Constructors

Constructor	Description
Menu(org.bukkit.entity.Player player, int rows, String title)

Method Summary

Modifier and Type	Method	Description
void	clearSlots()
void	close()
void	close(int layers)
void	fakeClose()
org.bukkit.inventory.Inventory	getInventory()
protected Slot	getNextButton()
static Menu	getOpenMenu(org.bukkit.entity.Player player)
int	getPage()
int	getPages()
org.bukkit.entity.Player	getPlayer()
protected Slot	getPrevButton()
Slot	getSlot(int i)
Slot	getSlotOnCurrentPage(int displaySlot)	Resolves a raw display slot (0..inventory size, as seen by the player/Bukkit) to the Slot bound to it on the currently open page.
boolean	isOpening()
void	onClose()
void	open()
void	open(int page)
void	openSubMenu(Menu menu)
void	openSync()
void	registerListener(org.bukkit.event.Listener listener)
void	registerTask(org.bukkit.scheduler.BukkitTask task)
abstract void	setContents()
void	setSlot(int i, Slot slot)
void	unregisterListener(org.bukkit.event.Listener listener)
void	unregisterTask(org.bukkit.scheduler.BukkitTask task)

Methods inherited from class java.lang.Object

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

Field Details

player

protected final org.bukkit.entity.Player player

title

protected final String title

rows

protected final int rows

inventory

protected org.bukkit.inventory.Inventory inventory

slots

protected final TreeMap<Integer,Slot> slots

parentMenu

protected Menu parentMenu

opening

protected boolean opening

fakeClosing

protected boolean fakeClosing

Constructor Details

Menu

public Menu(org.bukkit.entity.Player player,
 int rows,
 String title)

Method Details

getOpenMenu

@Nullable
public static Menu getOpenMenu(org.bukkit.entity.Player player)

getPlayer

public org.bukkit.entity.Player getPlayer()

getInventory

@NotNull
public org.bukkit.inventory.Inventory getInventory()

Specified by:

getInventory in interface org.bukkit.inventory.InventoryHolder

getPages

public int getPages()

setSlot

public void setSlot(int i,
 @Nullable
 Slot slot)

clearSlots

public void clearSlots()

setContents

public abstract void setContents()

getSlot

@Nullable
public Slot getSlot(int i)

getSlotOnCurrentPage

@Nullable
public Slot getSlotOnCurrentPage(int displaySlot)

Resolves a raw display slot (0..inventory size, as seen by the player/Bukkit) to the Slot bound to it on the currently open page. This applies the same page offset that open(int) uses to render the page, so click handling and rendering can't drift out of sync.

openSync

public void openSync()

open

public void open()

open

public void open(int page)

openSubMenu

public void openSubMenu(Menu menu)

close

public void close()

close

public void close(int layers)

onClose

public void onClose()

fakeClose

public void fakeClose()

getPrevButton

protected Slot getPrevButton()

getNextButton

protected Slot getNextButton()

registerListener

public void registerListener(org.bukkit.event.Listener listener)

unregisterListener

public void unregisterListener(org.bukkit.event.Listener listener)

registerTask

public void registerTask(org.bukkit.scheduler.BukkitTask task)

unregisterTask

public void unregisterTask(org.bukkit.scheduler.BukkitTask task)

getPage

public int getPage()

isOpening

public boolean isOpening()