com.github.stefvanschie.inventoryframework

Class Gui

java.lang.Object

com.github.stefvanschie.inventoryframework.Gui

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

public class Gui
extends Object
implements org.bukkit.inventory.InventoryHolder

The base class of all GUIs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Gui.State The gui state

Constructor Summary

Constructors

Constructor and Description
Gui(org.bukkit.plugin.Plugin plugin, int rows, String title) Constructs a new GUI

Method Summary

Modifier and Type	Method and Description
void	addPane(Pane pane) Adds a pane to this gui
protected HumanEntityCache	getHumanEntityCache() Gets the human entity cache used for this gui
org.bukkit.inventory.Inventory	getInventory()
static org.bukkit.inventory.Inventory	getInventory(org.bukkit.inventory.InventoryView view, int rawSlot)
Collection<GuiItem>	getItems() Gets all the items in all underlying panes
Consumer<org.bukkit.event.inventory.InventoryClickEvent>	getOnBottomClick() Gets the bottom click event assigned to this gui, or null if there is no bottom click assigned.
Consumer<org.bukkit.event.inventory.InventoryCloseEvent>	getOnClose() Gets the on close event assigned to this gui, or null if no close event is assigned.
Consumer<org.bukkit.event.inventory.InventoryClickEvent>	getOnGlobalClick() Gets the global click event assigned to this gui, or null if there is no global click assigned.
Consumer<org.bukkit.event.inventory.InventoryClickEvent>	getOnOutsideClick() Gets the outside click event assigned to this gui, or null if there is no outside click assigned.
Consumer<org.bukkit.event.inventory.InventoryClickEvent>	getOnTopClick() Gets the top click event assigned to this gui, or null if there is no top click assigned.
List<Pane>	getPanes() Gets all the panes in this gui, this includes child panes from other panes
int	getRows() Returns the amount of rows this gui currently has
Gui.State	getState() Gets the state of this gui
String	getTitle() Returns the title of this gui
static Gui	load(org.bukkit.plugin.Plugin plugin, Object instance, InputStream inputStream) Loads a Gui from a given input stream
static Pane	loadPane(Object instance, Node node) Loads a pane by the given instance and node
static void	registerPane(String name, BiFunction<Object,Element,Pane> biFunction) Registers a name that can be used inside an XML file to add custom panes
static void	registerProperty(String attributeName, Function<String,Object> function) Registers a property that can be used inside an XML file to add additional new properties.
void	setOnBottomClick(Consumer<org.bukkit.event.inventory.InventoryClickEvent> onBottomClick) Set the consumer that should be called whenever the inventory is clicked in.
void	setOnClose(Consumer<org.bukkit.event.inventory.InventoryCloseEvent> onClose) Set the consumer that should be called whenever this gui is closed.
void	setOnGlobalClick(Consumer<org.bukkit.event.inventory.InventoryClickEvent> onGlobalClick) Set the consumer that should be called whenever this gui or inventory is clicked in.
void	setOnLocalClick(Consumer<org.bukkit.event.inventory.InventoryClickEvent> onLocalClick) Deprecated. see setOnTopClick(Consumer)
void	setOnOutsideClick(Consumer<org.bukkit.event.inventory.InventoryClickEvent> onOutsideClick) Set the consumer that should be called whenever a player clicks outside the gui.
void	setOnTopClick(Consumer<org.bukkit.event.inventory.InventoryClickEvent> onTopClick) Set the consumer that should be called whenever this gui is clicked in.
void	setRows(int rows) Sets the amount of rows for this inventory.
void	setState(Gui.State state) Calling this method will set the state of this gui.
void	setTitle(String title) Sets the title for this inventory.
void	show(org.bukkit.entity.HumanEntity humanEntity) Shows a gui to a player
void	update() Update the gui for everyone

Methods inherited from class java.lang.Object

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

Constructor Detail

Gui

public Gui(@NotNull
           org.bukkit.plugin.Plugin plugin,
           int rows,
           @NotNull
           String title)

Constructs a new GUI

Parameters:

plugin - the main plugin.

rows - the amount of rows this gui should contain, in range 1..6.

title - the title/name of this gui.

Method Detail

addPane

public void addPane(@NotNull
                    Pane pane)

Adds a pane to this gui

Parameters:

pane - the pane to add

show

public void show(@NotNull
                 org.bukkit.entity.HumanEntity humanEntity)

Shows a gui to a player

Parameters:

humanEntity - the human entity to show the gui to

setRows

public void setRows(int rows)

Sets the amount of rows for this inventory. This will (unlike most other methods) directly update itself in order to ensure all viewers will still be viewing the new inventory as well.

Parameters:

rows - the amount of rows in range 1..6.

getPanes

@NotNull
 @Contract(pure=true)
public List<Pane> getPanes()

Gets all the panes in this gui, this includes child panes from other panes

Returns:

all panes

setTitle

public void setTitle(@NotNull
                     String title)

Sets the title for this inventory. This will (unlike most other methods) directly update itself in order to ensure all viewers will still be viewing the new inventory as well.

Parameters:

title - the title

getItems

@NotNull
 @Contract(pure=true)
public Collection<GuiItem> getItems()

Gets all the items in all underlying panes

Returns:

all items

update

public void update()

Update the gui for everyone

setState

public void setState(@NotNull
                     Gui.State state)

Calling this method will set the state of this gui. If this state is set to top state, it will restore all the stored inventories of the players and will assume no pane extends into the bottom inventory part. If the state is set to bottom state it will assume one or more panes overflow into the bottom half of the inventory and will store all players' inventories and clear those. Do not call this method if you just want the player's inventory to be cleared.

Parameters:

state - the new gui state

Since:

0.4.0

getState

@NotNull
 @Contract(pure=true)
public Gui.State getState()

Gets the state of this gui

Returns:

the state

Since:

0.5.4

getHumanEntityCache

@NotNull
 @Contract(pure=true)
protected HumanEntityCache getHumanEntityCache()

Gets the human entity cache used for this gui

Returns:

the human entity cache

Since:

0.5.4

See Also:

HumanEntityCache

load

@Nullable
 @Contract(value="_, _, null -> fail")
public static Gui load(@NotNull
                                                                          org.bukkit.plugin.Plugin plugin,
                                                                          @NotNull
                                                                          Object instance,
                                                                          @NotNull
                                                                          InputStream inputStream)

Loads a Gui from a given input stream

Parameters:

plugin - the main plugin

instance - the class instance for all reflection lookups

inputStream - the file

Returns:

the gui

setOnTopClick

public void setOnTopClick(@NotNull
                          Consumer<org.bukkit.event.inventory.InventoryClickEvent> onTopClick)

Set the consumer that should be called whenever this gui is clicked in.

Parameters:

onTopClick - the consumer that gets called

getOnTopClick

@Nullable
 @Contract(pure=true)
public Consumer<org.bukkit.event.inventory.InventoryClickEvent> getOnTopClick()

Gets the top click event assigned to this gui, or null if there is no top click assigned.

Returns:

the top click

Since:

0.5.4

setOnBottomClick

public void setOnBottomClick(@NotNull
                             Consumer<org.bukkit.event.inventory.InventoryClickEvent> onBottomClick)

Set the consumer that should be called whenever the inventory is clicked in.

Parameters:

onBottomClick - the consumer that gets called

getOnBottomClick

@Nullable
 @Contract(pure=true)
public Consumer<org.bukkit.event.inventory.InventoryClickEvent> getOnBottomClick()

Gets the bottom click event assigned to this gui, or null if there is no bottom click assigned.

Returns:

the bottom click

Since:

0.5.4

setOnGlobalClick

public void setOnGlobalClick(@NotNull
                             Consumer<org.bukkit.event.inventory.InventoryClickEvent> onGlobalClick)

Set the consumer that should be called whenever this gui or inventory is clicked in.

Parameters:

onGlobalClick - the consumer that gets called

getOnGlobalClick

@Nullable
 @Contract(pure=true)
public Consumer<org.bukkit.event.inventory.InventoryClickEvent> getOnGlobalClick()

Gets the global click event assigned to this gui, or null if there is no global click assigned.

Returns:

the global click

Since:

0.5.4

setOnOutsideClick

public void setOnOutsideClick(@NotNull
                              Consumer<org.bukkit.event.inventory.InventoryClickEvent> onOutsideClick)

Set the consumer that should be called whenever a player clicks outside the gui.

Parameters:

onOutsideClick - the consumer that gets called

Since:

0.5.7

getOnOutsideClick

@Nullable
 @Contract(pure=true)
public Consumer<org.bukkit.event.inventory.InventoryClickEvent> getOnOutsideClick()

Gets the outside click event assigned to this gui, or null if there is no outside click assigned.

Returns:

the outside click

Since:

0.5.7

setOnLocalClick

@Deprecated
public void setOnLocalClick(@NotNull
                                         Consumer<org.bukkit.event.inventory.InventoryClickEvent> onLocalClick)

Deprecated. see setOnTopClick(Consumer)

Set the consumer that should be called whenever this gui is clicked in.

Parameters:

onLocalClick - the consumer that gets called

setOnClose

public void setOnClose(@NotNull
                       Consumer<org.bukkit.event.inventory.InventoryCloseEvent> onClose)

Set the consumer that should be called whenever this gui is closed.

Parameters:

onClose - the consumer that gets called

getOnClose

@Nullable
 @Contract(pure=true)
public Consumer<org.bukkit.event.inventory.InventoryCloseEvent> getOnClose()

Gets the on close event assigned to this gui, or null if no close event is assigned.

Returns:

the on close event

Since:

0.5.4

getRows

public int getRows()

Returns the amount of rows this gui currently has

Returns:

the amount of rows

getTitle

@NotNull
 @Contract(pure=true)
public String getTitle()

Returns the title of this gui

Returns:

the title

getInventory

@NotNull
public org.bukkit.inventory.Inventory getInventory()

Specified by:

getInventory in interface org.bukkit.inventory.InventoryHolder

getInventory

public static org.bukkit.inventory.Inventory getInventory(org.bukkit.inventory.InventoryView view,
                                                          int rawSlot)

registerProperty

public static void registerProperty(@NotNull
                                    String attributeName,
                                    @NotNull
                                    Function<String,Object> function)

Registers a property that can be used inside an XML file to add additional new properties.

Parameters:

attributeName - the name of the property. This is the same name you'll be using to specify the property type in the XML file.

function - how the property should be processed. This converts the raw text input from the XML node value into the correct object type.

Throws:

IllegalArgumentException - when a property with this name is already registered.

registerPane

public static void registerPane(@NotNull
                                String name,
                                @NotNull
                                BiFunction<Object,Element,Pane> biFunction)

Registers a name that can be used inside an XML file to add custom panes

Parameters:

name - the name of the pane to be used in the XML file

biFunction - how the pane loading should be processed

Throws:

IllegalArgumentException - when a pane with this name is already registered

loadPane

@NotNull
 @Contract(value="_, null -> fail")
public static Pane loadPane(@NotNull
                                                                           Object instance,
                                                                           @NotNull
                                                                           Node node)

Loads a pane by the given instance and node

Parameters:

instance - the instance

node - the node

Returns:

the pane