com.github.stefvanschie.inventoryframework.pane.component.util

Class VariableBar

java.lang.Object

com.github.stefvanschie.inventoryframework.pane.Pane

com.github.stefvanschie.inventoryframework.pane.component.util.VariableBar

All Implemented Interfaces:

Flippable, Orientable

Direct Known Subclasses:

PercentageBar, Slider

public abstract class VariableBar
extends Pane
implements Orientable, Flippable

A variable bar for UI elements that require some sort of bar

Since:

0.5.0

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

Modifier and Type	Field and Description
protected OutlinePane	backgroundPane The green and the red parts of the slider
protected OutlinePane	fillPane The green and the red parts of the slider
protected boolean	flipHorizontally Whether the pane is flipped horizontally or vertically
protected boolean	flipVertically Whether the pane is flipped horizontally or vertically
protected Orientable.Orientation	orientation The orientation of the slider
protected float	value The value this slider is at.

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

height, length, onClick, x, y

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VariableBar(int length, int height)
protected	VariableBar(int x, int y, int length, int height)
protected	VariableBar(int x, int y, int length, int height, Pane.Priority priority)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the entire pane of any items/panes.
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	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
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
boolean	isFlippedHorizontally() Gets whether this pane's items are flipped horizontally
boolean	isFlippedVertically() Gets whether this pane's items are flipped vertically
void	setBackgroundItem(GuiItem item) Sets the background item
void	setFillItem(GuiItem item) Sets the fill item (foreground)
void	setHeight(int height) Set the height of this pane
void	setLength(int length) Set the length of this pane
void	setOrientation(Orientable.Orientation orientation) Sets the orientation of this outline pane
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 com.github.stefvanschie.inventoryframework.pane.Pane

click, getHeight, getLength, getPriority, getPropertyMappings, getX, getY, isVisible, load, loadItem, setOnClick, setOnLocalClick, setPriority, setVisible

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.Orientable

load

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

load

Field Detail

fillPane

@NotNull
protected final OutlinePane fillPane

The green and the red parts of the slider

backgroundPane

@NotNull
protected final OutlinePane backgroundPane

The green and the red parts of the slider

value

protected float value

The value this slider is at. This is a value between 0 and 1 (both inclusive).

orientation

@NotNull
protected Orientable.Orientation orientation

The orientation of the slider

flipHorizontally

protected boolean flipHorizontally

Whether the pane is flipped horizontally or vertically

flipVertically

protected boolean flipVertically

Whether the pane is flipped horizontally or vertically

Constructor Detail

VariableBar

protected VariableBar(int length,
                      int height)

VariableBar

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

VariableBar

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

Method Detail

setLength

public void setLength(int length)

Set the length of this pane

Overrides:

setLength in class Pane

Parameters:

length - the new length

setHeight

public void setHeight(int height)

Set the height of this pane

Overrides:

setHeight in class Pane

Parameters:

height - the new height

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

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

setX

public void setX(int x)

Set the x coordinate of this pane

Overrides:

setX in class Pane

Parameters:

x - the new x coordinate

setY

public void setY(int y)

Set the y coordinate of this pane

Overrides:

setY in class Pane

Parameters:

y - the new y coordinate

setFillItem

public void setFillItem(@NotNull
                        GuiItem item)

Sets the fill item (foreground)

Parameters:

item - the new item

Since:

0.5.0

setBackgroundItem

public void setBackgroundItem(@NotNull
                              GuiItem item)

Sets the background item

Parameters:

item - the new item

Since:

0.5.0

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

getPanes

@NotNull
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

getOrientation

@NotNull
public Orientable.Orientation getOrientation()

Gets the orientation of this outline pane

Specified by:

getOrientation in interface Orientable

Returns:

the orientation

isFlippedHorizontally

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

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

clear

public void clear()

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

Specified by:

clear in class Pane