Package me.despical.inventoryframework.pane.component

Class Slider

java.lang.Object

me.despical.inventoryframework.pane.Pane

me.despical.inventoryframework.pane.component.util.VariableBar

me.despical.inventoryframework.pane.component.Slider

All Implemented Interfaces:

Flippable, Orientable

public class Slider
extends VariableBar

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

Since:

0.5.0

Created at 04.09.2020

Author:

Despical

Nested Class Summary

Nested classes/interfaces inherited from class me.despical.inventoryframework.pane.Pane

Pane.Priority

Nested classes/interfaces inherited from interface me.despical.inventoryframework.pane.Orientable

Orientable.Orientation

Field Summary

Fields inherited from class me.despical.inventoryframework.pane.component.util.VariableBar

backgroundPane, fillPane, flipHorizontally, flipVertically, orientation, value

Fields inherited from class me.despical.inventoryframework.pane.Pane

height, length, onClick, x, y

Constructor Summary

Constructors

Constructor	Description
Slider(int length, int height)
Slider(int x, int y, int length, int height)
Slider(int x, int y, int length, int height, @NotNull Pane.Priority priority)

Method Summary

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

Methods inherited from class me.despical.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 me.despical.inventoryframework.pane.Pane

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

Methods inherited from class java.lang.Object

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

Constructor Details

Slider

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

Slider

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

Slider

public Slider(int length,
 int height)

Method Details

load

@NotNull
@Contract(pure=true)
public static @NotNull Slider load(@NotNull
 @NotNull Object instance,
 @NotNull
 @NotNull Element element)

Loads a percentage bar from a given element

Parameters:

instance - the instance class

element - the element

Returns:

the percentage bar

click

public boolean click(@NotNull
 @NotNull Gui gui,
 @NotNull
 @NotNull org.bukkit.event.inventory.InventoryClickEvent event,
 int paneOffsetX,
 int paneOffsetY,
 int maxLength,
 int maxHeight)

Description copied from class: Pane

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

getValue

public float getValue()

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

Returns:

the value

Since:

1.0.1

setValue

public void setValue(float value)

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

Parameters:

value - the new value.

Throws:

IllegalArgumentException - when the value is out of range

Since:

1.0.1