com.codelanx.codelanxlib.inventory.iinterface

Class InventoryPanel

java.lang.Object

com.codelanx.codelanxlib.inventory.iinterface.InventoryPanel

public final class InventoryPanel
extends Object

A single inventory that represents a menu

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
void	click(Player p, int slot) Called when a player clicks a MenuIcon inside of an InventoryPanel
String	getName() Returns the name/title used for the Inventory in this panel
String	getSeed() Returns the seed relevant to this specific panel
String	getSerializedName() Returns the serialized name for this panel
void	linkIcon(MenuIcon icon) Links this panel to the passed MenuIcon such that clicking it will open this panel
MenuIcon	newIcon(ItemStack item, Execution onExec) Returns a new MenuIcon stored in this panel
MenuIcon	newIcon(ItemStack item, Execution onExec, Map<String,Object> options) Returns a new MenuIcon stored in this panel
void	open(Player p) Opens this InventoryPanel for the passed Player
void	setAllExecutions(Execution onExec) Sets the Execution for all MenuIcon objects held in this panel
InventoryPanel	setSerializedName(String name) Sets the serialized name for this panel

Methods inherited from class java.lang.Object

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

Method Detail

newIcon

public MenuIcon newIcon(ItemStack item,
                        Execution onExec,
                        Map<String,Object> options)

Returns a new MenuIcon stored in this panel

Parameters:

item - The ItemStack to use for displaying the icon

onExec - The Execution to use when the icon is clicked

options - A mapping of metadata options for the icon

Returns:

The new MenuIcon

Since:

0.0.1

newIcon

public MenuIcon newIcon(ItemStack item,
                        Execution onExec)

Returns a new MenuIcon stored in this panel

Parameters:

item - The ItemStack to use for displaying the icon

onExec - The Execution to use when the icon is clicked

Returns:

The new MenuIcon

Since:

0.0.1

linkIcon

public void linkIcon(MenuIcon icon)

Links this panel to the passed MenuIcon such that clicking it will open this panel

Parameters:

icon - The MenuIcon to link

Since:

0.0.1

See Also:

InventoryInterface.linkPanel(MenuIcon, InventoryPanel)

setAllExecutions

public void setAllExecutions(Execution onExec)

Sets the Execution for all MenuIcon objects held in this panel

Parameters:

onExec - The Execution to set

Since:

0.1.0

getSeed

public String getSeed()

Returns the seed relevant to this specific panel

Returns:

The seed for this panel

Since:

0.0.1

click

public void click(Player p,
                  int slot)

Called when a player clicks a MenuIcon inside of an InventoryPanel

Parameters:

p - The Player who clicked

slot - The slot that was clicked

Since:

0.0.1

open

public void open(Player p)

Opens this InventoryPanel for the passed Player

Parameters:

p - The Player to open this panel for

Since:

0.0.1

setSerializedName

public InventoryPanel setSerializedName(String name)

Sets the serialized name for this panel

Parameters:

name - The name to set

Returns:

The current instance (chained)

Since:

0.0.1

getSerializedName

public String getSerializedName()

Returns the serialized name for this panel

Returns:

The serialized name

Since:

0.0.1

getName

public String getName()

Returns the name/title used for the Inventory in this panel

Returns:

The name for this panel

Since:

0.0.1