com.github.ms5984.api.menuman

Class MenuBuilder

java.lang.Object

com.github.ms5984.api.menuman.MenuBuilder

public final class MenuBuilder
extends Object

Fluid interface menu builder

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Integer,ClickAction>	actions MenuAction to slot mappings.
protected boolean	allowItemPickup Allow items to be removed from the menu inventory.
protected boolean	allowLowerInvShiftClick Allow shift-clicking of items from the lower inventory.
protected boolean	cancelLowerInvClick Determine whether clicks on the lower inventory should be cancelled.
protected CloseAction	closeAction Callback to run on menu close.
protected org.bukkit.inventory.ItemStack[]	initialContents Initial contents of the menu inventory before elements are added.
protected Map<Integer,MenuElement>	items ItemStack to slot mappings.
Menu.InventoryRows	numberOfRows Describes the number of rows and slots in the final Menu.
protected String	title Title of the final Menu inventory.

Constructor Summary

Constructors

Constructor and Description
MenuBuilder(Menu.InventoryRows rows, String title) Create a new MenuBuilder with a number of rows and a title.
MenuBuilder(Menu.InventoryRows rows, String title, org.bukkit.inventory.ItemStack[] initialContents) Create a new MenuBuilder with rows, title and initial contents.

Method Summary

Modifier and Type	Method and Description
ElementBuilder	addElement(org.bukkit.inventory.ItemStack item) Add a previously styled ItemStack directly to the menu.
ElementBuilder	addElement(org.bukkit.inventory.ItemStack item, String text, String... lore) Add an ItemStack to the menu of specified display name and lore.
MenuBuilder	allowLowerShiftClicks(boolean toAllow) Should shift-clicks on the lower inventory be allowed?
MenuBuilder	cancelLowerInventoryClicks(boolean toCancel) Should ALL clicks on the lower inventory be cancelled as well?
Menu	create(org.bukkit.plugin.java.JavaPlugin yourPlugin) Create the Menu specified by the contents of this builder.
MenuBuilder	defaultClickBehavior(boolean allowPickup) Determine default pickup behavior when clicking ItemStacks.
MenuBuilder	setCloseAction(CloseAction closeAction) Define a callback to run on inventory close.
MenuBuilder	setInitialContents(org.bukkit.inventory.ItemStack[] contents) Set the initial contents of the inventory.
MenuBuilder	setTitle(String title) Set a new title for the menu.

Methods inherited from class java.lang.Object

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

Field Detail

numberOfRows

public final Menu.InventoryRows numberOfRows

Describes the number of rows and slots in the final Menu.

items

protected final Map<Integer,MenuElement> items

ItemStack to slot mappings.

actions

protected final Map<Integer,ClickAction> actions

MenuAction to slot mappings.

closeAction

protected CloseAction closeAction

Callback to run on menu close. Defaults to null.

title

protected String title

Title of the final Menu inventory.

initialContents

protected org.bukkit.inventory.ItemStack[] initialContents

Initial contents of the menu inventory before elements are added.

cancelLowerInvClick

protected boolean cancelLowerInvClick

Determine whether clicks on the lower inventory should be cancelled.

allowItemPickup

protected boolean allowItemPickup

Allow items to be removed from the menu inventory.

allowLowerInvShiftClick

protected boolean allowLowerInvShiftClick

Allow shift-clicking of items from the lower inventory.

Constructor Detail

MenuBuilder

public MenuBuilder(Menu.InventoryRows rows,
                   String title)

Create a new MenuBuilder with a number of rows and a title.

Menu will start out blank and elements will added.

Parameters:

rows - number of rows in final Inventory

title - Title of generated inventory

MenuBuilder

public MenuBuilder(Menu.InventoryRows rows,
                   String title,
                   org.bukkit.inventory.ItemStack[] initialContents)

Create a new MenuBuilder with rows, title and initial contents.

Parameters:

rows - number of rows in final Inventory

title - Title of generated inventory

initialContents - an array of items to prefill the menu with

Throws:

IllegalArgumentException - if initialContents.length > slots

Method Detail

setCloseAction

public MenuBuilder setCloseAction(CloseAction closeAction)

Define a callback to run on inventory close.

Null by default; set to null to disable.

Parameters:

closeAction - a CloseAction or null for none

Returns:

this MenuBuilder

setTitle

public MenuBuilder setTitle(String title)

Set a new title for the menu.

Parameters:

title - a new title for the generate menu

Returns:

this MenuBuilder

setInitialContents

public MenuBuilder setInitialContents(org.bukkit.inventory.ItemStack[] contents)

Set the initial contents of the inventory.

This happens after creation of the inventory but before menu elements are processed.

Parameters:

contents - an array of items

Returns:

this MenuBuilder

defaultClickBehavior

public MenuBuilder defaultClickBehavior(boolean allowPickup)

Determine default pickup behavior when clicking ItemStacks.

Defaults to false. You can set this true and set different pickup logic for specific elements (for instance, an item vault system with pagination, possibly a sub-menu).

Parameters:

allowPickup - whether to allow item pickup

Returns:

this MenuBuilder

cancelLowerInventoryClicks

public MenuBuilder cancelLowerInventoryClicks(boolean toCancel)

Should ALL clicks on the lower inventory be cancelled as well?

False by default.

Parameters:

toCancel - true to cancel clicks on lower

Returns:

this MenuBuilder

allowLowerShiftClicks

public MenuBuilder allowLowerShiftClicks(boolean toAllow)

Should shift-clicks on the lower inventory be allowed?

Care should be taken to ensure menu elements aren't altered by items provided. Defaults to false.

Parameters:

toAllow - allow shift-clicks on item

Returns:

this MenuBuilder

addElement

public ElementBuilder addElement(org.bukkit.inventory.ItemStack item)

Add a previously styled ItemStack directly to the menu.

This is useful if you're used to managing your own custom items. Your item will not be altered.

Parameters:

item - item to add

Returns:

a new ElementBuilder to customize the element

addElement

public ElementBuilder addElement(org.bukkit.inventory.ItemStack item,
                                 String text,
                                 String... lore)

Add an ItemStack to the menu of specified display name and lore.

Recommended if you are not used to altering ItemMetas. Handles styling for you.

Parameters:

item - item to add

text - display name of item

lore - optional lore to add as varargs

Returns:

a new ElementBuilder to customize the element

create

public Menu create(org.bukkit.plugin.java.JavaPlugin yourPlugin)

Create the Menu specified by the contents of this builder.

Requires plugin reference for event syncing.

Parameters:

yourPlugin - an instance of your plugin

Returns:

new Menu initialized with this object's contents