com.github.stefvanschie.inventoryframework.pane

Class StaticPane

java.lang.Object

com.github.stefvanschie.inventoryframework.pane.Pane

com.github.stefvanschie.inventoryframework.pane.StaticPane

All Implemented Interfaces:

Flippable, Rotatable

public class StaticPane
extends Pane
implements Flippable, Rotatable

A pane for static items and stuff. All items will have to be specified a slot, or will be added in the next position.

Nested Class Summary

Nested classes/interfaces inherited from class com.github.stefvanschie.inventoryframework.pane.Pane

Pane.Priority

Field Summary

Fields inherited from class com.github.stefvanschie.inventoryframework.pane.Pane

height, length, onClick, x, y

Constructor Summary

Constructors

Constructor and Description
StaticPane(int length, int height)
StaticPane(int x, int y, int length, int height)
StaticPane(int x, int y, int length, int height, Pane.Priority priority)

Method Summary

Modifier and Type	Method and Description
void	addItem(GuiItem item, int x, int y) Adds a gui item at the specific spot in the pane
void	clear() Clears the entire pane of any items/panes.
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
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
void	fillWith(org.bukkit.inventory.ItemStack itemStack) Fills all empty space in the pane with the given itemStack
void	flipHorizontally(boolean flipHorizontally) Sets whether this pane should flip its items horizontally
void	flipVertically(boolean flipVertically) Sets whether this pane should flip its items vertically
Collection<GuiItem>	getItems() Gets all the items in this pane and all underlying panes
Collection<Pane>	getPanes() Gets all the panes in this panes, including any child panes from other panes
int	getRotation() Gets the rotation specified to this pane.
boolean	isFlippedHorizontally() Gets whether this pane's items are flipped horizontally
boolean	isFlippedVertically() Gets whether this pane's items are flipped vertically
static StaticPane	load(Object instance, Element element) Loads an outline pane from a given element
void	removeItem(GuiItem item) Removes the specified item from the pane
void	setRotation(int rotation) Sets the rotation of this pane.

Methods inherited from class com.github.stefvanschie.inventoryframework.pane.Pane

getHeight, getLength, getPriority, getPropertyMappings, getX, getY, isVisible, load, loadItem, setHeight, setLength, setOnClick, setOnLocalClick, setPriority, setVisible, setX, setY

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.stefvanschie.inventoryframework.pane.Flippable

load

Methods inherited from interface com.github.stefvanschie.inventoryframework.pane.Rotatable

load

Constructor Detail

StaticPane

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

StaticPane

public StaticPane(int x,
                  int y,
                  int length,
                  int height)

StaticPane

public StaticPane(int length,
                  int height)

Method Detail

display

public 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

Specified by:

display in class Pane

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

addItem

public void addItem(@NotNull
                    GuiItem item,
                    int x,
                    int y)

Adds a gui item at the specific spot in the pane

Parameters:

item - the item to set

x - the x coordinate of the position of the item

y - the y coordinate of the position of the item

removeItem

public void removeItem(@NotNull
                       GuiItem item)

Removes the specified item from the pane

Parameters:

item - the item to remove

Since:

0.5.8

click

public 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

Specified by:

click in class 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

setRotation

public void setRotation(int rotation)

Sets the rotation of this pane. The rotation is in degrees and can only be in increments of 90. Anything higher than 360, will be lowered to a value in between [0, 360) while maintaining the same rotational value. E.g. 450 degrees becomes 90 degrees, 1080 degrees becomes 0, etc. This method fails for any pane that has a length and height which are unequal.

Specified by:

setRotation in interface Rotatable

Parameters:

rotation - the rotation of this pane, must be divisible by 90.

fillWith

@Contract(value="null -> fail")
public void fillWith(@NotNull
                                                      org.bukkit.inventory.ItemStack itemStack)

Fills all empty space in the pane with the given itemStack

Parameters:

itemStack - The ItemStack to fill the empty space with

getItems

@NotNull
public Collection<GuiItem> getItems()

Gets all the items in this pane and all underlying panes

Specified by:

getItems in class Pane

Returns:

all items

clear

public void clear()

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

Specified by:

clear in class Pane

getPanes

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

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

Specified by:

getPanes in class Pane

Returns:

all panes

flipHorizontally

public void flipHorizontally(boolean flipHorizontally)

Sets whether this pane should flip its items horizontally

Specified by:

flipHorizontally in interface Flippable

Parameters:

flipHorizontally - whether the pane should flip items horizontally

flipVertically

public void flipVertically(boolean flipVertically)

Sets whether this pane should flip its items vertically

Specified by:

flipVertically in interface Flippable

Parameters:

flipVertically - whether the pane should flip items vertically

getRotation

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

Gets the rotation specified to this pane. If no rotation has been set, or if this pane is not capable of having a rotation, 0 is returned.

Specified by:

getRotation in interface Rotatable

Returns:

the rotation for this pane

isFlippedHorizontally

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

Gets whether this pane's items are flipped horizontally

Specified by:

isFlippedHorizontally in interface Flippable

Returns:

true if the items are flipped horizontally, false otherwise

isFlippedVertically

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

Gets whether this pane's items are flipped vertically

Specified by:

isFlippedVertically in interface Flippable

Returns:

true if the items are flipped vertically, false otherwise

load

@NotNull
 @Contract(value="_, null -> fail")
public static StaticPane load(@NotNull
                                                                             Object instance,
                                                                             @NotNull
                                                                             Element element)

Loads an outline pane from a given element

Parameters:

instance - the instance class

element - the element

Returns:

the outline pane