org.mini2Dx.ui.element

Class Slider

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.Slider

All Implemented Interfaces:

Actionable, Hoverable

public class Slider
extends UiElement
implements Actionable

A slider UI element that wraps a float value

Field Summary

Fields inherited from class org.mini2Dx.ui.element.UiElement

deferred, effects, styleId, visibility, zIndex

Constructor Summary

Constructors

Constructor and Description
Slider() Constructor.
Slider(java.lang.String id) Constructor

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener listener)
void	attach(ParentRenderNode<?,?> parentRenderNode) Attaches a RenderNode for this element to a parent RenderNode
void	detach(ParentRenderNode<?,?> parentRenderNode) Detaches this element's RenderNode from a parent RenderNode
float	getValue() Returns the Slider value
float	getValueStep() Returns the amount to change the value by on each keyboard/controller event
boolean	isChangedOnBeginEvent() Returns if the value should change when a keyboard/controller event begins and change the value until the event ends.
boolean	isEnabled()
void	notifyActionListenersOfBeginEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)
void	notifyActionListenersOfEndEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)
void	removeActionListener(ActionListener listener)
void	setChangedOnBeginEvent(boolean changedOnBeginEvent) Sets if the value should change when a keyboard/controller event begins and change the value until the event ends.
void	setEnabled(boolean enabled)
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
void	setValue(float value) Sets the Slider value.
void	setValueStep(float valueStep) Sets the amount to change the value by on each keyboard/controller event
void	setVisibility(Visibility visibility) Sets the current Visibility of this UiElement
void	setZIndex(int zIndex) Sets the Z index of this UiElement.
void	syncWithRenderNode() Syncs data between the UiElement and RenderNode

Methods inherited from class org.mini2Dx.ui.element.UiElement

addEffectListener, addHoverListener, applyEffect, defer, defer, equals, getElementById, getId, getStyleId, getVisibility, getZIndex, hashCode, isDebugEnabled, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, processDeferred, removeEffectListener, removeHoverListener, setDebugEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mini2Dx.ui.element.Hoverable

addHoverListener, getId, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, removeHoverListener

Constructor Detail

Slider

public Slider()

Constructor. Generates a unique ID for this Slider

Slider

public Slider(java.lang.String id)

Constructor

Parameters:

id - The unique ID for this Slider

Method Detail

attach

public void attach(ParentRenderNode<?,?> parentRenderNode)

Description copied from class: UiElement

Attaches a RenderNode for this element to a parent RenderNode

Specified by:

attach in class UiElement

Parameters:

parentRenderNode - The parent RenderNode to attach to

detach

public void detach(ParentRenderNode<?,?> parentRenderNode)

Description copied from class: UiElement

Detaches this element's RenderNode from a parent RenderNode

Specified by:

detach in class UiElement

Parameters:

parentRenderNode - The parent RenderNode to detach from

setVisibility

public void setVisibility(Visibility visibility)

Description copied from class: UiElement

Sets the current Visibility of this UiElement

Specified by:

setVisibility in class UiElement

Parameters:

visibility - The Visibility to set

setStyleId

public void setStyleId(java.lang.String styleId)

Description copied from class: UiElement

Sets the style if for this UiElement

Specified by:

setStyleId in class UiElement

Parameters:

styleId - The style id to set

syncWithRenderNode

public void syncWithRenderNode()

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode

Specified by:

syncWithRenderNode in class UiElement

setZIndex

public void setZIndex(int zIndex)

Description copied from class: UiElement

Sets the Z index of this UiElement. Elements will be rendered on different Z layers in ascending Z order (negatives values first, positive values last)

Specified by:

setZIndex in class UiElement

Parameters:

zIndex - The Z index

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Actionable

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface Actionable

notifyActionListenersOfBeginEvent

public void notifyActionListenersOfBeginEvent(EventTrigger eventTrigger,
                                              EventTriggerParams eventTriggerParams)

Specified by:

notifyActionListenersOfBeginEvent in interface Actionable

notifyActionListenersOfEndEvent

public void notifyActionListenersOfEndEvent(EventTrigger eventTrigger,
                                            EventTriggerParams eventTriggerParams)

Specified by:

notifyActionListenersOfEndEvent in interface Actionable

addActionListener

public void addActionListener(ActionListener listener)

Specified by:

addActionListener in interface Actionable

removeActionListener

public void removeActionListener(ActionListener listener)

Specified by:

removeActionListener in interface Actionable

getValue

public float getValue()

Returns the Slider value

Returns:

A value between 0.0 and 1.0

setValue

public void setValue(float value)

Sets the Slider value.

Parameters:

value - A value between 0.0 and 1.0

getValueStep

public float getValueStep()

Returns the amount to change the value by on each keyboard/controller event

Returns:

0.1 by default

setValueStep

public void setValueStep(float valueStep)

Sets the amount to change the value by on each keyboard/controller event

Parameters:

valueStep - A non-zero value

isChangedOnBeginEvent

public boolean isChangedOnBeginEvent()

Returns if the value should change when a keyboard/controller event begins and change the value until the event ends.

Returns:

False by default

setChangedOnBeginEvent

public void setChangedOnBeginEvent(boolean changedOnBeginEvent)

Sets if the value should change when a keyboard/controller event begins and change the value until the event ends.

Parameters:

changedOnBeginEvent - False to only change on the end event