Class Layout

java.lang.Object

ua.mcchickenstudio.opencreative.menus.AbstractMenu

ua.mcchickenstudio.opencreative.coding.menus.layouts.Layout

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder, InventoryMenu

Direct Known Subclasses:

LayoutMaker

public abstract class Layout
extends AbstractMenu

Layout

This class represents a inventory menu, that opens when player clicks on coding container to fill arguments.

See Also:

• LayoutMaker

Field Summary

Fields

Modifier and Type	Field	Description
protected final ActionType	actionType
protected final List<Integer>	argsSlots
protected final List<ParameterButton>	parameterButtons
protected final ArgumentSlot[]	requiredSlots

Fields inherited from class AbstractMenu

AIR_ITEM, creationTime, DECORATION_ITEM, DECORATION_PANE_ITEM, DISABLED_ITEM, inventory, NO_PERMS_ITEM

Modifier and Type	Field	Description
protected final org.bukkit.inventory.ItemStack	AIR_ITEM
protected final long	creationTime
protected final org.bukkit.inventory.ItemStack	DECORATION_ITEM
protected final org.bukkit.inventory.ItemStack	DECORATION_PANE_ITEM
protected final org.bukkit.inventory.ItemStack	DISABLED_ITEM
protected org.bukkit.inventory.Inventory	inventory
protected final org.bukkit.inventory.ItemStack	NO_PERMS_ITEM

Constructor Summary

Constructors

Constructor	Description
Layout(int rows, @NotNull ActionType actionType, @NotNull org.bukkit.block.Block containerBlock)	Creates a coding container layout menu.

Method Summary

Modifier and Type	Method	Description
protected @NotNull ParameterButton	createParamButton(@NotNull ParameterSlot parameter, Object value)	Creates and returns parameter button.
protected abstract void	fillArgumentItems()	Fills menu with argument glasses and values.
void	fillItems(org.bukkit.entity.Player player)
@NotNull List<Integer>	getArgsSlots()	Returns list of slots, items from will be saved into coding container after closing menu.
protected @NotNull org.bukkit.inventory.ItemStack	getArgumentValueFromContainer(int slot)	Returns argument value item from coding container.
protected @NotNull List<Integer>	getCentredSlots(int count, int row)	Returns list of slots, that will be used to display a row of items in more beautiful place.
@NotNull Set<org.bukkit.entity.Player>	getViewers()	Returns set of players, who have opened this menu.
void	onClick(@NotNull org.bukkit.event.inventory.InventoryClickEvent event)	Executes when player clicks in inventory.
final void	onClose(@NotNull org.bukkit.event.inventory.InventoryCloseEvent event)	Executes when player closes inventory.
void	onOpen(@NotNull org.bukkit.event.inventory.InventoryOpenEvent event)	Executes when player opens inventory and sees it first time.
protected void	setArgSlot(int argNumber, int... slots)	Sets argument slot in slot.
protected void	setArgSlotCross(int argNumber, int slot)	Sets argument slot with vertical and horizontal glass panes in slot.
protected void	setArgSlotHorizontal(int argNumber, int slot)	Sets argument slot with horizontal glass panes in slot.
protected void	setArgSlotVertical(int argNumber, int slot)	Sets argument slot with vertical glass panes in slot.
protected void	setGlass(int argNumber, int... slots)	Sets glass pane in slot.

Methods inherited from class AbstractMenu

getCreationTime, getInventory, getItem, getRows, getSize, getTitle, isClickedInMenuSlots, isNotEmpty, isPlayerClicked, open, reverse, setItem, setItem, setRows, setTitle

Modifier and Type	Method	Description
long	getCreationTime()	Returns the creation time of menu in milliseconds of Unix format.
@NotNull org.bukkit.inventory.Inventory	getInventory()
@NotNull org.bukkit.inventory.ItemStack	getItem(int slot)
int	getRows()
int	getSize()
String	getTitle()
protected final boolean	isClickedInMenuSlots(org.bukkit.event.inventory.InventoryClickEvent event)
protected boolean	isNotEmpty(org.bukkit.inventory.ItemStack item)
protected final boolean	isPlayerClicked(org.bukkit.event.inventory.InventoryClickEvent event)
void	open(@NotNull org.bukkit.entity.Player player)	Opens the inventory for player.
protected int	reverse(int slot)
void	setItem(int slot, org.bukkit.inventory.ItemStack item)
void	setItem(org.bukkit.inventory.ItemStack item, int... slots)
protected void	setRows(int rows)
void	setTitle(String title)

Methods inherited from class Object

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

Methods inherited from interface InventoryMenu

destroy

Modifier and Type	Method	Description
default void	destroy()	Destroys menus from memory and disables all event listeners for it.

Field Details

actionType

protected final ActionType actionType

argsSlots

protected final List<Integer> argsSlots

parameterButtons

protected final List<ParameterButton> parameterButtons

requiredSlots

protected final ArgumentSlot[] requiredSlots

Constructor Details

Layout

public Layout(int rows,
 @NotNull
 @NotNull ActionType actionType,
 @NotNull
 @NotNull org.bukkit.block.Block containerBlock)

Creates a coding container layout menu.

Parameters:

rows - amount of rows in layout.

actionType - type of action, that has arguments.

containerBlock - container block.

Method Details

fillItems

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

Specified by:

fillItems in class AbstractMenu

fillArgumentItems

protected abstract void fillArgumentItems()

Fills menu with argument glasses and values.

See Also:

• setArgSlot(int, int...)
• setGlass(int, int...)
• setArgSlotHorizontal(int, int)
• setArgSlotVertical(int, int)

getArgumentValueFromContainer

@NotNull
protected @NotNull org.bukkit.inventory.ItemStack getArgumentValueFromContainer(int slot)

Returns argument value item from coding container.

Parameters:

slot - slot of item inside coding container.

Returns:

value item, or empty item.

onClick

public void onClick(@NotNull
 @NotNull org.bukkit.event.inventory.InventoryClickEvent event)

Description copied from interface: InventoryMenu

Executes when player clicks in inventory.

Specified by:

onClick in interface InventoryMenu

Specified by:

onClick in class AbstractMenu

Parameters:

event - event of click in inventory.

onOpen

public void onOpen(@NotNull
 @NotNull org.bukkit.event.inventory.InventoryOpenEvent event)

Description copied from interface: InventoryMenu

Executes when player opens inventory and sees it first time. Useful for playing sounds or setting items.

Specified by:

onOpen in interface InventoryMenu

Specified by:

onOpen in class AbstractMenu

Parameters:

event - event of inventory open.

onClose

public final void onClose(@NotNull
 @NotNull org.bukkit.event.inventory.InventoryCloseEvent event)

Description copied from interface: InventoryMenu

Executes when player closes inventory.

NOTE: Menu should be unregistered after closing it.

Parameters:

event - event of inventory close.

See Also:

• InventoryMenu.destroy()

setArgSlotVertical

protected void setArgSlotVertical(int argNumber,
 int slot)

Sets argument slot with vertical glass panes in slot.

Parameters:

argNumber - number of argument.

slot - slot to put item.

setArgSlotHorizontal

protected void setArgSlotHorizontal(int argNumber,
 int slot)

Sets argument slot with horizontal glass panes in slot.

Parameters:

argNumber - number of argument.

slot - slot to put item.

setArgSlotCross

protected void setArgSlotCross(int argNumber,
 int slot)

Sets argument slot with vertical and horizontal glass panes in slot.

Parameters:

argNumber - number of argument.

slot - slot to put item.

setGlass

protected void setGlass(int argNumber,
 int... slots)

Sets glass pane in slot.

Parameters:

argNumber - number of argument.

slots - slots to put glass pane.

setArgSlot

protected void setArgSlot(int argNumber,
 int... slots)

Sets argument slot in slot.

Parameters:

argNumber - number of argument.

slots - slots to put argument slot.

getArgsSlots

@NotNull
public @NotNull List<Integer> getArgsSlots()

Returns list of slots, items from will be saved into coding container after closing menu.

Returns:

list of slots with argument items.

createParamButton

@NotNull
protected @NotNull ParameterButton createParamButton(@NotNull
 @NotNull ParameterSlot parameter,
 Object value)

Creates and returns parameter button.

Parameters:

parameter - parameter with info.

value - current value.

Returns:

parameter button.

getCentredSlots

@NotNull
protected @NotNull List<Integer> getCentredSlots(int count,
 int row)

Returns list of slots, that will be used to display a row of items in more beautiful place.

Parameters:

count - count of items in row (1-9)

row - row (1-6)

Returns:

list of centered slots.

getViewers

@NotNull
public @NotNull Set<org.bukkit.entity.Player> getViewers()

Returns set of players, who have opened this menu.

Returns:

set of menu viewers.