com.github.stefvanschie.inventoryframework.pane.component

Class PercentageBar

java.lang.Object

com.github.stefvanschie.inventoryframework.pane.Pane

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

com.github.stefvanschie.inventoryframework.pane.component.PercentageBar

All Implemented Interfaces:

Flippable, Orientable

public class PercentageBar
extends VariableBar

A percentage bar for a graphical interface into what amount of a whole is set.

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 inherited from class com.github.stefvanschie.inventoryframework.pane.component.util.VariableBar

backgroundPane, fillPane, flipHorizontally, flipVertically, orientation, value

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

height, length, onClick, x, y

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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
float	getPercentage() Gets the percentage as a float in between (0,1) this bar is currently set at.
static PercentageBar	load(Object instance, Element element) Loads a percentage bar from a given element
void	setPercentage(float percentage) Sets the percentage of this bar.

Methods inherited from class com.github.stefvanschie.inventoryframework.pane.component.util.VariableBar

clear, display, flipHorizontally, flipVertically, getItems, getOrientation, getPanes, isFlippedHorizontally, isFlippedVertically, setBackgroundItem, setFillItem, setHeight, setLength, setOrientation, setX, setY

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

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

Constructor Detail

PercentageBar

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

PercentageBar

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

PercentageBar

public PercentageBar(int length,
                     int height)

Method Detail

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

setPercentage

public void setPercentage(float percentage)

Sets the percentage of this bar. The percentage has to be in (0,1). If not, this method will throw an IllegalArgumentException.

Parameters:

percentage - the new percentage.

Throws:

IllegalArgumentException - when the percentage is out of range

Since:

0.5.0

getPercentage

public float getPercentage()

Gets the percentage as a float in between (0,1) this bar is currently set at.

Returns:

the percentage

Since:

0.5.0

load

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

Loads a percentage bar from a given element

Parameters:

instance - the instance class

element - the element

Returns:

the percentage bar