com.github.stefvanschie.inventoryframework.pane

Class Pane

java.lang.Object

com.github.stefvanschie.inventoryframework.pane.Pane

Direct Known Subclasses:

CycleButton, MasonryPane, OutlinePane, PaginatedPane, StaticPane, ToggleButton, VariableBar

public abstract class Pane
extends Object

The base class for all panes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pane.Priority An enum representing the rendering priorities for the panes.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	height Length is horizontal, height is vertical
protected int	length Length is horizontal, height is vertical
protected Consumer<org.bukkit.event.inventory.InventoryClickEvent>	onClick The consumer that will be called once a players clicks in the gui
protected int	x The starting position of this pane, which is 0 by default
protected int	y The starting position of this pane, which is 0 by default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Pane(int length, int height) Constructs a new default pane, with no position
protected	Pane(int x, int y, int length, int height) Constructs a new default pane
protected	Pane(int x, int y, int length, int height, Pane.Priority priority) Constructs a new default pane

Method Summary

Modifier and Type	Method and Description
abstract void	clear() Clears the entire pane of any items/panes.
abstract boolean	click(Gui gui, org.bukkit.event.inventory.InventoryClickEvent event, int paneOffsetX, int paneOffsetY, int maxLength, int maxHeight) Called whenever there is being clicked on this pane
abstract void	display(Gui gui, org.bukkit.inventory.Inventory inventory, org.bukkit.inventory.PlayerInventory playerInventory, int paneOffsetX, int paneOffsetY, int maxLength, int maxHeight) Has to set all the items in the right spot inside the inventory
int	getHeight() Returns the height of this pane
abstract Collection<GuiItem>	getItems() Gets all the items in this pane and all underlying panes
int	getLength() Returns the length of this pane
abstract Collection<Pane>	getPanes() Gets all the panes in this panes, including any child panes from other panes
Pane.Priority	getPriority() Returns the priority of the pane
static Map<String,Function<String,Object>>	getPropertyMappings() Returns the property mappings used when loading properties from an XML file.
int	getX() Gets the x coordinate of this pane
int	getY() Gets the y coordinate of this pane
boolean	isVisible() Returns the pane's visibility state
static void	load(Pane pane, Object instance, Element element)
static GuiItem	loadItem(Object instance, Element element) Loads an item from an instance and an element
void	setHeight(int height) Set the height of this pane
void	setLength(int length) Set the length of this pane
void	setOnClick(Consumer<org.bukkit.event.inventory.InventoryClickEvent> onClick) Set the consumer that should be called whenever this gui is clicked in.
void	setOnLocalClick(Consumer<org.bukkit.event.inventory.InventoryClickEvent> onLocalClick) Deprecated. see setOnClick(Consumer)
void	setPriority(Pane.Priority priority) Sets the priority of this pane
void	setVisible(boolean visible) Sets whether this pane is visible or not
void	setX(int x) Set the x coordinate of this pane
void	setY(int y) Set the y coordinate of this pane

Methods inherited from class java.lang.Object

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

Field Detail

x

protected int x

The starting position of this pane, which is 0 by default

y

protected int y

The starting position of this pane, which is 0 by default

length

protected int length

Length is horizontal, height is vertical

height

protected int height

Length is horizontal, height is vertical

onClick

@Nullable
protected Consumer<org.bukkit.event.inventory.InventoryClickEvent> onClick

The consumer that will be called once a players clicks in the gui

Constructor Detail

Pane

protected Pane(int x,
               int y,
               int length,
               int height,
               @NotNull
               Pane.Priority priority)

Constructs a new default pane

Parameters:

x - the upper left x coordinate of the pane

y - the upper left y coordinate of the pane

length - the length of the pane

height - the height of the pane

priority - the priority of the pane

Pane

protected Pane(int length,
               int height)

Constructs a new default pane, with no position

Parameters:

length - the length of the pane

height - the height of the pane

Pane

protected Pane(int x,
               int y,
               int length,
               int height)

Constructs a new default pane

Parameters:

x - the upper left x coordinate of the pane

y - the upper left y coordinate of the pane

length - the length of the pane

height - the height of the pane

Method Detail

setLength

public void setLength(int length)

Set the length of this pane

Parameters:

length - the new length

setHeight

public void setHeight(int height)

Set the height of this pane

Parameters:

height - the new height

setX

public void setX(int x)

Set the x coordinate of this pane

Parameters:

x - the new x coordinate

setY

public void setY(int y)

Set the y coordinate of this pane

Parameters:

y - the new y coordinate

getLength

@Contract(pure=true)
public int getLength()

Returns the length of this pane

Returns:

the length

getHeight

@Contract(pure=true)
public int getHeight()

Returns the height of this pane

Returns:

the height

getX

@Contract(pure=true)
public int getX()

Gets the x coordinate of this pane

Returns:

the x coordinate

getY

@Contract(pure=true)
public int getY()

Gets the y coordinate of this pane

Returns:

the y coordinate

display

public abstract void display(@NotNull
                             Gui gui,
                             @NotNull
                             org.bukkit.inventory.Inventory inventory,
                             @NotNull
                             org.bukkit.inventory.PlayerInventory playerInventory,
                             int paneOffsetX,
                             int paneOffsetY,
                             int maxLength,
                             int maxHeight)

Has to set all the items in the right spot inside the inventory

Parameters:

gui - the gui for which we're rendering

inventory - the inventory that the items should be displayed in

playerInventory - the player's inventory

paneOffsetX - the pane's offset on the x axis

paneOffsetY - the pane's offset on the y axis

maxLength - the maximum length of the pane

maxHeight - the maximum height of the pane

isVisible

@Contract(pure=true)
public boolean isVisible()

Returns the pane's visibility state

Returns:

the pane's visibility

setVisible

public void setVisible(boolean visible)

Sets whether this pane is visible or not

Parameters:

visible - the pane's visibility

click

public abstract boolean click(@NotNull
                              Gui gui,
                              @NotNull
                              org.bukkit.event.inventory.InventoryClickEvent event,
                              int paneOffsetX,
                              int paneOffsetY,
                              int maxLength,
                              int maxHeight)

Called whenever there is being clicked on this pane

Parameters:

gui - the gui this event stems from

event - the event that occurred while clicking on this item

paneOffsetX - the pane's offset on the x axis

paneOffsetY - the pane's offset on the y axis

maxLength - the maximum length of the pane

maxHeight - the maximum height of the pane

Returns:

whether the item was found or not

setPriority

public void setPriority(@NotNull
                        Pane.Priority priority)

Sets the priority of this pane

Parameters:

priority - the priority

loadItem

@NotNull
 @Contract(pure=true)
public static GuiItem loadItem(@NotNull
                                                                Object instance,
                                                                @NotNull
                                                                Element element)

Loads an item from an instance and an element

Parameters:

instance - the instance

element - the element

Returns:

the gui item

load

public static void load(@NotNull
                        Pane pane,
                        @NotNull
                        Object instance,
                        @NotNull
                        Element element)

getPriority

@NotNull
public Pane.Priority getPriority()

Returns the priority of the pane

Returns:

the priority

getItems

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

Gets all the items in this pane and all underlying panes

Returns:

all items

getPanes

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

Gets all the panes in this panes, including any child panes from other panes

Returns:

all panes

clear

public abstract void clear()

Clears the entire pane of any items/panes. Underlying panes will not be cleared.

Since:

0.3.2

setOnClick

public void setOnClick(@Nullable
                       Consumer<org.bukkit.event.inventory.InventoryClickEvent> onClick)

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

Parameters:

onClick - the consumer that gets called

Since:

0.4.0

setOnLocalClick

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

Deprecated. see setOnClick(Consumer)

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

Parameters:

onLocalClick - the consumer that gets called

getPropertyMappings

@NotNull
 @Contract(pure=true)
public static Map<String,Function<String,Object>> getPropertyMappings()

Returns the property mappings used when loading properties from an XML file.

Returns:

the property mappings