com.github.stefvanschie.inventoryframework.pane

Class OutlinePane

java.lang.Object

com.github.stefvanschie.inventoryframework.pane.Pane

com.github.stefvanschie.inventoryframework.pane.OutlinePane

All Implemented Interfaces:

Flippable, Orientable, Rotatable

Direct Known Subclasses:

Label

public class OutlinePane
extends Pane
implements Flippable, Orientable, Rotatable

A pane for items that should be outlined

Nested Class Summary

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

Pane.Priority

Nested classes/interfaces inherited from interface com.github.stefvanschie.inventoryframework.pane.Orientable

Orientable.Orientation

Field Summary

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

height, length, onClick, x, y

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addItem(GuiItem item) 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
boolean	doesRepeat() Gets whether this outline pane repeats itself
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
int	getGap() Gets the gap of the pane
List<GuiItem>	getItems() Gets all the items in this pane and all underlying panes
Orientable.Orientation	getOrientation() Gets the orientation of this outline pane
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.
void	insertItem(GuiItem item, int index) Adds a gui item in the specified index
boolean	isFlippedHorizontally() Gets whether this pane's items are flipped horizontally
boolean	isFlippedVertically() Gets whether this pane's items are flipped vertically
static OutlinePane	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	setGap(int gap) Sets the gap of the pane
void	setOrientation(Orientable.Orientation orientation) Sets the orientation of this outline pane
void	setRepeat(boolean repeat) Sets whether this pane should repeat itself
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.Orientable

load

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

load

Constructor Detail

OutlinePane

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

OutlinePane

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

OutlinePane

public OutlinePane(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

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.

insertItem

public void insertItem(@NotNull
                       GuiItem item,
                       int index)

Adds a gui item in the specified index

Parameters:

item - the item to add

index - the item's index

addItem

public void addItem(@NotNull
                    GuiItem item)

Adds a gui item at the specific spot in the pane

Parameters:

item - the item to set

removeItem

public void removeItem(@NotNull
                       GuiItem item)

Removes the specified item from the pane

Parameters:

item - the item to remove

Since:

0.5.8

clear

public void clear()

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

Specified by:

clear in class Pane

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

setGap

public void setGap(int gap)

Sets the gap of the pane

Parameters:

gap - the new gap

setOrientation

public void setOrientation(@NotNull
                           Orientable.Orientation orientation)

Sets the orientation of this outline pane

Specified by:

setOrientation in interface Orientable

Parameters:

orientation - the new orientation

setRepeat

public void setRepeat(boolean repeat)

Sets whether this pane should repeat itself

Parameters:

repeat - whether the pane should repeat

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

doesRepeat

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

Gets whether this outline pane repeats itself

Returns:

true if this pane repeats, false otherwise

getGap

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

Gets the gap of the pane

Returns:

the gap

getItems

@NotNull
public List<GuiItem> getItems()

Gets all the items in this pane and all underlying panes

Specified by:

getItems in class Pane

Returns:

all items

getOrientation

@NotNull
 @Contract(pure=true)
public Orientable.Orientation getOrientation()

Gets the orientation of this outline pane

Specified by:

getOrientation in interface Orientable

Returns:

the orientation

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 OutlinePane 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