me.lucko.helper.menu

Class Gui

java.lang.Object

me.lucko.helper.menu.Gui

All Implemented Interfaces:

TerminableConsumer

Direct Known Subclasses:

PaginatedGui

@NonnullByDefault
public abstract class Gui
extends Object
implements TerminableConsumer

A simple GUI abstraction

Field Summary

Fields

Modifier and Type	Field and Description
static MetadataKey<Gui>	OPEN_GUI_KEY

Constructor Summary

Constructors

Constructor and Description
Gui(org.bukkit.entity.Player player, int lines, String title)

Method Summary

Modifier and Type	Method and Description
void	addItem(Item item)
void	addItems(Iterable<Item> items)
<T extends AutoCloseable> T	bind(T terminable) Binds with the given terminable.
void	clearItems()
void	close()
void	fillWith(Item item)
Function<org.bukkit.entity.Player,Gui>	getFallbackGui()
int	getFirstEmpty()
Optional<Slot>	getFirstEmptySlot()
org.bukkit.inventory.Inventory	getHandle() Gets the delegate Bukkit inventory
String	getInitialTitle() Gets the initial title which was set when this GUI was made
static int	getMenuSize(int count) Utility method to get the number of lines needed for x items
static int	getMenuSize(int count, int itemsPerLine) Utility method to get the number of lines needed for x items
org.bukkit.entity.Player	getPlayer() Gets the player viewing this Gui
Slot	getSlot(int slot)
boolean	isFirstDraw()
boolean	isValid() Returns true unless this GUI has been invalidated, through being closed, or the player leaving.
void	open()
abstract void	redraw() Places items on the GUI.
void	removeItem(int slot)
void	removeItems(int... slots)
void	removeItems(Iterable<Integer> slots)
void	setFallbackGui(Function<org.bukkit.entity.Player,Gui> fallbackGui)
void	setItem(int slot, Item item)
void	setItems(Item item, int... slots)
void	setItems(Iterable<Integer> slots, Item item)

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.lucko.helper.terminable.TerminableConsumer

bindModule

Field Detail

OPEN_GUI_KEY

public static final MetadataKey<Gui> OPEN_GUI_KEY

Constructor Detail

Gui

public Gui(org.bukkit.entity.Player player,
           int lines,
           String title)

Method Detail

getMenuSize

public static int getMenuSize(int count)

Utility method to get the number of lines needed for x items

Parameters:

count - the number of items

Returns:

the number of lines needed

getMenuSize

public static int getMenuSize(int count,
                              int itemsPerLine)

Utility method to get the number of lines needed for x items

Parameters:

count - the number of items

itemsPerLine - the number of items per line

Returns:

the number of lines needed

redraw

public abstract void redraw()

Places items on the GUI. Called when the GUI is opened. Use isFirstDraw() to determine if this is the first time redraw has been called.

getPlayer

public org.bukkit.entity.Player getPlayer()

Gets the player viewing this Gui

Returns:

the player viewing this gui

getHandle

public org.bukkit.inventory.Inventory getHandle()

Gets the delegate Bukkit inventory

Returns:

the bukkit inventory being wrapped by this instance

getInitialTitle

public String getInitialTitle()

Gets the initial title which was set when this GUI was made

Returns:

the initial title used when this GUI was made

getFallbackGui

@Nullable
public Function<org.bukkit.entity.Player,Gui> getFallbackGui()

setFallbackGui

public void setFallbackGui(@Nullable
                           Function<org.bukkit.entity.Player,Gui> fallbackGui)

bind

@Nonnull
public <T extends AutoCloseable> T bind(@Nonnull
                                                 T terminable)

Description copied from interface: TerminableConsumer

Binds with the given terminable.

Specified by:

bind in interface TerminableConsumer

Type Parameters:

T - the terminable type

Parameters:

terminable - the terminable to bind with

Returns:

the same terminable

isFirstDraw

public boolean isFirstDraw()

getSlot

public Slot getSlot(int slot)

setItem

public void setItem(int slot,
                    Item item)

setItems

public void setItems(Item item,
                     int... slots)

setItems

public void setItems(Iterable<Integer> slots,
                     Item item)

getFirstEmpty

public int getFirstEmpty()

getFirstEmptySlot

public Optional<Slot> getFirstEmptySlot()

addItem

public void addItem(Item item)

addItems

public void addItems(Iterable<Item> items)

fillWith

public void fillWith(Item item)

removeItem

public void removeItem(int slot)

removeItems

public void removeItems(int... slots)

removeItems

public void removeItems(Iterable<Integer> slots)

clearItems

public void clearItems()

open

public void open()

close

public void close()

isValid

public boolean isValid()

Returns true unless this GUI has been invalidated, through being closed, or the player leaving.

Returns:

true unless this GUI has been invalidated.