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 Pane

Pane.Priority

Nested classes/interfaces inherited from interface Orientable

Orientable.Orientation

Field Summary

Fields inherited from class VariableBar

backgroundPane, fillPane, flipHorizontally, flipVertically, orientation, value

Fields inherited from class Pane

height, length, onClick, uuid

Constructor Summary

Constructors

Constructor	Description
PercentageBar(int length, int height)	Creates a new percentage bar
PercentageBar(int length, int height, @NotNull Pane.Priority priority)	Creates a new percentage bar
PercentageBar(int length, int height, @NotNull Pane.Priority priority, @NotNull Plugin plugin)	Creates a new percentage bar
PercentageBar(int length, int height, @NotNull Plugin plugin)	Creates a new percentage bar

Method Summary

Modifier and Type	Method	Description
boolean	click(@NotNull Gui gui, @NotNull GuiComponent guiComponent, @NotNull InventoryClickEvent event, @NotNull Slot slot)	Called whenever there is being clicked on this pane
@NotNull PercentageBar	copy()	Makes a copy of this pane and returns it.
float	getPercentage()	Gets the percentage as a float in between (0,1) this bar is currently set at.
static @NotNull PercentageBar	load(@NotNull Object instance, @NotNull Element element, @NotNull Plugin plugin)	Loads a percentage bar from a given element
void	setPercentage(float percentage)	Sets the percentage of this bar.

Methods inherited from class VariableBar

applyContents, clear, display, flipHorizontally, flipVertically, getItems, getOrientation, getPanes, isFlippedHorizontally, isFlippedVertically, setBackgroundItem, setFillItem, setHeight, setLength, setOrientation, setValue

Methods inherited from class Pane

callOnClick, createBorder, findMatchingItem, getHeight, getLength, getPriority, getUUID, isVisible, load, matchesItem, setOnClick, setPriority, setVisible

Methods inherited from class Object

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

Constructor Details

PercentageBar

public PercentageBar(int length,
 int height,
 @NotNull
 @NotNull Pane.Priority priority,
 @NotNull
 @NotNull Plugin plugin)

Creates a new percentage bar

Parameters:

length - the length of the bar

height - the height of the bar

priority - the priority of the bar

plugin - the plugin that will be the owner for this percentage bar's items

Since:

0.12.0

PercentageBar

public PercentageBar(int length,
 int height,
 @NotNull
 @NotNull Plugin plugin)

Creates a new percentage bar

Parameters:

length - the length of the bar

height - the height of the bar

plugin - the plugin that will be the owner for this percentage bar's items

Since:

0.12.0

PercentageBar

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

Creates a new percentage bar

Parameters:

length - the length of the bar

height - the height of the bar

priority - the priority of the bar

Since:

0.12.0

PercentageBar

public PercentageBar(int length,
 int height)

Creates a new percentage bar

Parameters:

length - the length of the bar

height - the height of the bar

Since:

0.12.0

Method Details

click

public boolean click(@NotNull
 @NotNull Gui gui,
 @NotNull
 @NotNull GuiComponent guiComponent,
 @NotNull
 @NotNull InventoryClickEvent event,
 @NotNull
 @NotNull Slot slot)

Description copied from class: Pane

Called whenever there is being clicked on this pane

Specified by:

click in class Pane

Parameters:

gui - the gui in which was clicked

guiComponent - the gui component in which this pane resides

event - the event that occurred while clicking on this item

slot - the slot that was clicked in

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

See Also:

• the implementation

copy

@NotNull
@Contract(pure=true)
public @NotNull PercentageBar copy()

Description copied from class: Pane

Makes a copy of this pane and returns it. This makes a deep copy of the pane. This entails that the underlying panes and/or items will be copied as well. The returned pane will never be reference equal to the current pane.

Overrides:

copy in class Pane

Returns:

a copy of this pane

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(pure=true)
public static @NotNull PercentageBar load(@NotNull
 @NotNull Object instance,
 @NotNull
 @NotNull Element element,
 @NotNull
 @NotNull Plugin plugin)

Loads a percentage bar from a given element

Parameters:

instance - the instance class

element - the element

plugin - the plugin that will be the owner of the underlying items

Returns:

the percentage bar

Since:

0.10.8