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,MenuAction>	actions
protected boolean	allowItemPickup
protected boolean	cancelLowerInvClick
protected org.bukkit.inventory.ItemStack[]	initialContents
protected Map<Integer,MenuElement>	items
Menu.InventoryRows	numberOfRows
protected String	title

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	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	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

items

protected final Map<Integer,MenuElement> items

actions

protected final Map<Integer,MenuAction> actions

title

protected String title

initialContents

protected org.bukkit.inventory.ItemStack[] initialContents

cancelLowerInvClick

protected boolean cancelLowerInvClick

allowItemPickup

protected boolean allowItemPickup

Constructor Detail

MenuBuilder

public MenuBuilder(Menu.InventoryRows rows,
                   String title)

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

Menu will be blank and elements added.

Parameters:

rows - Menu.InventoryRows number to generate

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

title - Title of generated inventory

initialContents - an array of items to prefill the menu with

Method Detail

setTitle

public MenuBuilder setTitle(String title)

Set a new title for the menu

Parameters:

title - a new title for the generate menu

Returns:

same MenuBuilder object

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:

same MenuBuilder object

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:

same MenuBuilder object

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:

same MenuBuilder object

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