Package me.hsgamer.bettergui.menu

Class BaseInventoryMenu<B extends ButtonMap>

java.lang.Object

me.hsgamer.bettergui.api.menu.Menu

me.hsgamer.bettergui.api.menu.StandardMenu

me.hsgamer.bettergui.menu.BaseMenu

me.hsgamer.bettergui.menu.BaseInventoryMenu<B>

Type Parameters:

B - the type of the ButtonMap to use in the BukkitGUIHolder

Direct Known Subclasses:

AddonMenu, SimpleMenu

public abstract class BaseInventoryMenu<B extends ButtonMap>
extends BaseMenu

A BaseMenu for menus using BukkitGUIHolder

Field Summary

Fields inherited from class me.hsgamer.bettergui.menu.BaseMenu

argumentHandler, closeActionApplier, closeRequirementApplier, openActionApplier, permissions, viewRequirementApplier

Fields inherited from class me.hsgamer.bettergui.api.menu.StandardMenu

configSettings, menuSettings

Fields inherited from class me.hsgamer.bettergui.api.menu.Menu

config, MENU_SETTINGS_PATH, variableManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseInventoryMenu(Config config)

Method Summary

Modifier and Type	Method	Description
void	close(org.bukkit.entity.Player player)	Close the menu
void	closeAll()	Close/Clear all inventories of the type
protected abstract B	createButtonMap()
protected boolean	createChecked(org.bukkit.entity.Player player, String[] args, boolean bypass)	Create the menu after checking the conditions
B	getButtonMap()
BukkitGUIHolder	getGUIHolder()
protected void	refreshButtonMapOnCreate(B buttonMap, UUID uuid)
void	update(org.bukkit.entity.Player player)	Called when updating the menu

Methods inherited from class me.hsgamer.bettergui.menu.BaseMenu

create, getArgumentHandler, tabComplete

Methods inherited from class me.hsgamer.bettergui.api.menu.Menu

getConfig, getName, getParentMenu, getVariableManager, setParentMenu

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseInventoryMenu

protected BaseInventoryMenu(Config config)

Method Detail

createChecked

protected boolean createChecked(org.bukkit.entity.Player player,
                                String[] args,
                                boolean bypass)

Description copied from class: BaseMenu

Create the menu after checking the conditions

Specified by:

createChecked in class BaseMenu

Parameters:

player - the player

args - the arguments

bypass - if the requirement should be bypassed

Returns:

true if the menu is created

See Also:

BaseMenu.create(Player, String[], boolean)

update

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

Description copied from class: Menu

Called when updating the menu

Specified by:

update in class Menu

Parameters:

player - the player involved in

close

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

Description copied from class: Menu

Close the menu

Specified by:

close in class Menu

Parameters:

player - the player involved in

closeAll

public void closeAll()

Description copied from class: Menu

Close/Clear all inventories of the type

Specified by:

closeAll in class Menu

createButtonMap

protected abstract B createButtonMap()

refreshButtonMapOnCreate

protected void refreshButtonMapOnCreate(B buttonMap,
                                        UUID uuid)

getButtonMap

public B getButtonMap()

getGUIHolder

public BukkitGUIHolder getGUIHolder()