Package com.github.stefvanschie.inventoryframework.pane.component

Class Slider

java.lang.Object

com.github.stefvanschie.inventoryframework.pane.Pane

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

com.github.stefvanschie.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

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, slot, uuid, 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)
Slider(int x, int y, int length, int height, @NotNull Pane.Priority priority, @NotNull Plugin plugin)	Creates a new slider
Slider(int x, int y, int length, int height, @NotNull Plugin plugin)	Creates a new slider
Slider(int length, int height, @NotNull Plugin plugin)	Creates a new slider
Slider(@NotNull Slot slot, int length, int height)	Creates a new slider
Slider(@NotNull Slot slot, int length, int height, @NotNull Pane.Priority priority)	Creates a new slider
Slider(@NotNull Slot slot, int length, int height, @NotNull Pane.Priority priority, @NotNull Plugin plugin)	Creates a new slider
Slider(@NotNull Slot slot, int length, int height, @NotNull Plugin plugin)	Creates a new slider

Method Summary

Modifier and Type	Method	Description
boolean	click(@NotNull Gui gui, @NotNull InventoryComponent inventoryComponent, @NotNull InventoryClickEvent event, int slot, int paneOffsetX, int paneOffsetY, int maxLength, int maxHeight)	Called whenever there is being clicked on this pane
@NotNull Slider	copy()	Makes a copy of this pane and returns it.
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)	Deprecated. this method is no longer used internally and has been superseded by load(Object, Element, Plugin)
static @NotNull Slider	load(@NotNull Object instance, @NotNull Element element, @NotNull Plugin plugin)	Loads a percentage bar from a given element
void	setValue(float value)	Sets the value of this bar.

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

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

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

callOnClick, createBorder, createBorder, findMatchingItem, getHeight, getLength, getPriority, getSlot, getUUID, getX, getY, isVisible, load, loadItem, loadItem, matchesItem, registerProperty, setOnClick, setPriority, setSlot, setVisible, setX, setY

Methods inherited from class java.lang.Object

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

Constructor Details

Slider

public Slider(@NotNull
 @NotNull Slot slot,
 int length,
 int height,
 @NotNull
 @NotNull Pane.Priority priority,
 @NotNull
 @NotNull Plugin plugin)

Creates a new slider

Parameters:

slot - the slot of the slider

length - the length of the slider

height - the height of the slider

priority - the priority of the slider

plugin - the plugin that will be the owner of the slider's items

Since:

0.10.8

Slider

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

Creates a new slider

Parameters:

x - the x coordinate of the slider

y - the y coordinate of the slier

length - the length of the slider

height - the height of the slider

priority - the priority of the slider

plugin - the plugin that will be the owner of the slider's items

Since:

0.10.8

Slider

public Slider(@NotNull
 @NotNull Slot slot,
 int length,
 int height,
 @NotNull
 @NotNull Plugin plugin)

Creates a new slider

Parameters:

slot - the slot of the slider

length - the length of the slider

height - the height of the slider

plugin - the plugin that will be the owner of the slider's items

Since:

0.10.8

Slider

public Slider(int x,
 int y,
 int length,
 int height,
 @NotNull
 @NotNull Plugin plugin)

Creates a new slider

Parameters:

x - the x coordinate of the slider

y - the y coordinate of the slier

length - the length of the slider

height - the height of the slider

plugin - the plugin that will be the owner of the slider's items

Since:

0.10.8

Slider

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

Creates a new slider

Parameters:

length - the length of the slider

height - the height of the slider

plugin - the plugin that will be the owner of the slider's items

Since:

0.10.8

Slider

public Slider(@NotNull
 @NotNull Slot slot,
 int length,
 int height,
 @NotNull
 @NotNull Pane.Priority priority)

Creates a new slider

Parameters:

slot - the slot of the slider

length - the length of the slider

height - the height of the slider

priority - the priority of the slider

Since:

0.10.8

Slider

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

Slider

public Slider(@NotNull
 @NotNull Slot slot,
 int length,
 int height)

Creates a new slider

Parameters:

slot - the slot of the slider

length - the length of the slider

height - the height of the slider

Since:

0.10.8

Slider

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

Slider

public Slider(int length,
 int height)

Method Details

click

public boolean click(@NotNull
 @NotNull Gui gui,
 @NotNull
 @NotNull InventoryComponent inventoryComponent,
 @NotNull
 @NotNull InventoryClickEvent event,
 int slot,
 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 in which was clicked

inventoryComponent - the inventory component in which this pane resides

event - the event that occurred while clicking on this item

slot - the slot that was clicked in

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

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.

Overrides:

setValue in class VariableBar

Parameters:

value - the new value.

Throws:

IllegalArgumentException - when the value is out of range

Since:

0.5.0

See Also:

• the implementation

copy

@NotNull
@Contract(pure=true)
public @NotNull Slider 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

getValue

public float getValue()

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

Returns:

the value

Since:

0.5.0

load

@NotNull
@Contract(pure=true)
public static @NotNull Slider 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 udnerlying items

Returns:

the percentage bar

Since:

0.10.8

load

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

Deprecated.

this method is no longer used internally and has been superseded by load(Object, Element, Plugin)

Loads a percentage bar from a given element

Parameters:

instance - the instance class

element - the element

Returns:

the percentage bar