Package com.spinyowl.legui.component

Class Slider

java.lang.Object

com.spinyowl.legui.component.Component

com.spinyowl.legui.component.Slider

All Implemented Interfaces:

Serializable

public class Slider
extends Component

Implementation of slider controller.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final float	DEFAULT_MAX_VALUE	Default maximum value for a slider.
static final float	DEFAULT_MIN_VALUE	Default minimum value for a slider.

Constructor Summary

Constructors

Constructor	Description
Slider()	Default constructor.
Slider(float value)	Used to create slider with predefined value.
Slider(float x, float y, float width, float height)	Constructor with position and size parameters.
Slider(float x, float y, float width, float height, float value)	Constructor with position and size parameters and predefined value.
Slider(org.joml.Vector2f position, org.joml.Vector2f size)	Constructor with position and size parameters.
Slider(org.joml.Vector2f position, org.joml.Vector2f size, float value)	Constructor with position and size parameters and predefined value.

Method Summary

Modifier and Type	Method	Description
void	addSliderChangeValueEventListener(EventListener<SliderChangeValueEvent> eventListener)	Used to add event listener for slider change value event.
boolean	equals(Object o)
float	getMaxValue()	Returns the maximum value.
float	getMinValue()	Returns the minimum value.
Orientation	getOrientation()	Returns slider orientation.
org.joml.Vector4f	getSliderActiveColor()	Returns slider active color.
List<EventListener<SliderChangeValueEvent>>	getSliderChangeValueEvents()	Returns all event listeners for slider change value event.
org.joml.Vector4f	getSliderColor()	Returns slider color.
float	getSliderSize()	Returns slider size.
float	getStepSize()	Returns the step size.
float	getValue()	Returns slider value as a float.
int	hashCode()
void	removeSliderChangeValueEventListener(EventListener<SliderChangeValueEvent> eventListener)	Used to remove event listener for slider change value event.
void	setIntersector(Intersector intersector)	Used to set slider intersector.
void	setMaxValue(float maxValue)	Sets the maximum value.
void	setMinValue(float minValue)	Sets the minimum value.
void	setOrientation(Orientation orientation)	Used to set slider orientation.
void	setSliderActiveColor(org.joml.Vector4f sliderActiveColor)	Used to set slider active color.
void	setSliderColor(org.joml.Vector4f sliderColor)	Used to set slider color.
void	setSliderSize(float sliderSize)	Used to set slider size.
void	setStepSize(float stepSize)	Sets the step size.
void	setValue(float value)	Used to set slider value from a float value.
String	toString()

Methods inherited from class com.spinyowl.legui.component.Component

add, add, addAll, clearChildComponents, containerIterator, contains, containsAll, count, forEach, getAbsolutePosition, getChildComponents, getFocusedStyle, getFrame, getHoveredStyle, getIntersector, getLayer, getListenerMap, getMetadata, getParent, getPosition, getPressedStyle, getSize, getStyle, getTabIndex, getTooltip, indexOfChild, intersects, isEmpty, isEnabled, isFocusable, isFocused, isHovered, isPressed, isTabFocusable, isVisible, keepRendering, keepRendering, parallelStream, remove, remove, removeAll, removeIf, setEnabled, setFocusable, setFocused, setHovered, setListenerMap, setParent, setPosition, setPosition, setPressed, setSize, setSize, setStyle, setTabFocusable, setTabIndex, setTooltip, stream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_MAX_VALUE

public static final float DEFAULT_MAX_VALUE

Default maximum value for a slider.

See Also:

• Constant Field Values

DEFAULT_MIN_VALUE

public static final float DEFAULT_MIN_VALUE

Default minimum value for a slider.

See Also:

• Constant Field Values

Constructor Details

Slider

public Slider(float value)

Used to create slider with predefined value.

Parameters:

value - value to set.

Slider

public Slider(org.joml.Vector2f position,
 org.joml.Vector2f size,
 float value)

Constructor with position and size parameters and predefined value.

Parameters:

position - position position in parent component.

size - size of component.

value - value to set.

Slider

public Slider(float x,
 float y,
 float width,
 float height,
 float value)

Constructor with position and size parameters and predefined value.

Parameters:

x - x position position in parent component.

y - y position position in parent component.

width - width of component.

height - height of component.

value - value to set.

Slider

public Slider()

Default constructor. Used to create component instance without any parameters.

Also if you want to make it easy to use with Json marshaller/unmarshaller component should contain empty constructor.

Slider

public Slider(float x,
 float y,
 float width,
 float height)

Constructor with position and size parameters.

Parameters:

x - x position position in parent component.

y - y position position in parent component.

width - width of component.

height - height of component.

Slider

public Slider(org.joml.Vector2f position,
 org.joml.Vector2f size)

Constructor with position and size parameters.

Parameters:

position - position position in parent component.

size - size of component.

Method Details

getMinValue

public float getMinValue()

Returns the minimum value.

Returns:

the minimum value.

setMinValue

public void setMinValue(float minValue)

Sets the minimum value.

Parameters:

minValue - the minimum value.

getMaxValue

public float getMaxValue()

Returns the maximum value.

Returns:

the maximum value.

setMaxValue

public void setMaxValue(float maxValue)

Sets the maximum value.

Parameters:

maxValue - the maximum value.

getStepSize

public float getStepSize()

Returns the step size. Step size equal to 0 means that there is no step size.

Returns:

the step size.

setStepSize

public void setStepSize(float stepSize)

Sets the step size. Step size equal to 0 means that there is no step size.

Parameters:

stepSize - the step size.

setIntersector

public void setIntersector(Intersector intersector)

Used to set slider intersector.

Overrides:

setIntersector in class Component

Parameters:

intersector - intersector.

getValue

public float getValue()

Returns slider value as a float.

Returns:

slider value as a float.

setValue

public void setValue(float value)

Used to set slider value from a float value.

Parameters:

value - new slider value.

getSliderColor

public org.joml.Vector4f getSliderColor()

Returns slider color. (Inactive slider color).

Returns:

slider color.

setSliderColor

public void setSliderColor(org.joml.Vector4f sliderColor)

Used to set slider color. (Inactive slider color).

Parameters:

sliderColor - new slider color.

getSliderSize

public float getSliderSize()

Returns slider size. (Knob size).

Returns:

slider size.

setSliderSize

public void setSliderSize(float sliderSize)

Used to set slider size. (Knob size).

Parameters:

sliderSize - new slider size.

getSliderActiveColor

public org.joml.Vector4f getSliderActiveColor()

Returns slider active color.

Returns:

slider active color.

setSliderActiveColor

public void setSliderActiveColor(org.joml.Vector4f sliderActiveColor)

Used to set slider active color.

Parameters:

sliderActiveColor - new slider active color.

getOrientation

public Orientation getOrientation()

Returns slider orientation.

Returns:

slider orientation.

setOrientation

public void setOrientation(Orientation orientation)

Used to set slider orientation.

Parameters:

orientation - new slider orientation.

addSliderChangeValueEventListener

public void addSliderChangeValueEventListener(EventListener<SliderChangeValueEvent> eventListener)

Used to add event listener for slider change value event.

Parameters:

eventListener - event listener to add.

getSliderChangeValueEvents

public List<EventListener<SliderChangeValueEvent>> getSliderChangeValueEvents()

Returns all event listeners for slider change value event.

Returns:

all event listeners for slider change value event.

removeSliderChangeValueEventListener

public void removeSliderChangeValueEventListener(EventListener<SliderChangeValueEvent> eventListener)

Used to remove event listener for slider change value event.

Parameters:

eventListener - event listener to remove.

equals

public boolean equals(Object o)

Overrides:

equals in class Component

hashCode

public int hashCode()

Overrides:

hashCode in class Component

toString

public String toString()

Overrides:

toString in class Component