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

deferredLayout, deferredRender, deferredUpdate, effects, height, styleId, visibility, width, x, y, zIndex

Constructor Summary

Constructors

Constructor and Description
Slider() Constructor.
Slider(float x, float y, float width, float height) Constructor
Slider(java.lang.String id) Constructor
Slider(java.lang.String id, float x, float y, float width, float height) 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
int	getRenderHeight() Returns the height this element is currently rendering at
int	getRenderWidth() Returns the width this element is currently rendering at
int	getRenderX() Returns X coordinate of where this element is currently rendering
int	getRenderY() Returns Y coordinate of where this element is currently rendering
StyleRule	getStyleRule()
float	getValue() Returns the Slider value
float	getValueStep() Returns the amount to change the value by on each keyboard/gamepad event
void	invokeBeginHover() Triggers the begin hover event
void	invokeEndHover() Triggers the end hover event
boolean	isChangedOnBeginEvent() Returns if the value should change when a keyboard/gamepad event begins and change the value until the event ends.
boolean	isEnabled()
boolean	isInitialLayoutOccurred()
boolean	isInitialUpdateOccurred()
boolean	isRenderNodeDirty()
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/gamepad event begins and change the value until the event ends.
void	setEnabled(boolean enabled)
void	setRenderNodeDirty()
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/gamepad event
void	setVisibility(Visibility visibility) Sets the current Visibility of this UiElement
void	setZIndex(int zIndex) Sets the Z index of this UiElement.
void	syncWithUpdate(UiContainerRenderTree rootNode) Syncs data between the UiElement and RenderNode during update

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

addEffectListener, addHoverListener, addNodeStateListener, alignAbove, alignBelow, alignEdgeToEdge, alignLeftOf, alignRightOf, applyEffect, deferUntilLayout, deferUntilLayout, deferUntilRender, deferUntilRender, deferUntilUpdate, deferUntilUpdate, deferUntilUpdate, deferUntilUpdate, equals, getContentHeight, getContentWidth, getElementById, getHeight, getId, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getStyleId, getVisibility, getWidth, getX, getY, getZIndex, hashCode, isDebugEnabled, isFlexLayout, isInitialised, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, notifyNodeStateListeners, removeEffectListener, removeHoverListener, removeNodeStateListener, set, setContentHeight, setContentWidth, setDebugEnabled, setHeight, setHeightToContentHeightOf, setHeightToHeightOf, setWidth, setWidthToContentWidthOf, setWidthToWidthOf, setX, setXY, setY, snapTo, snapTo, syncWithLayout, syncWithRender

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

Slider

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

Constructor

Parameters:

x - The x coordinate of this element relative to its parent

y - The y coordinate of this element relative to its parent

width - The width of this element

height - The height of this element

Slider

public Slider(java.lang.String id,
              float x,
              float y,
              float width,
              float height)

Constructor

Parameters:

id - The unique ID for this element (if null an ID will be generated)

x - The x coordinate of this element relative to its parent

y - The y coordinate of this element relative to its parent

width - The width of this element

height - The height of this element

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

invokeBeginHover

public void invokeBeginHover()

Description copied from interface: Hoverable

Triggers the begin hover event

Specified by:

invokeBeginHover in interface Hoverable

invokeEndHover

public void invokeEndHover()

Description copied from interface: Hoverable

Triggers the end hover event

Specified by:

invokeEndHover in interface Hoverable

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

syncWithUpdate

public void syncWithUpdate(UiContainerRenderTree rootNode)

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode during update

Overrides:

syncWithUpdate 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

getStyleRule

public StyleRule getStyleRule()

Specified by:

getStyleRule in class UiElement

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/gamepad event

Returns:

0.1 by default

setValueStep

public void setValueStep(float valueStep)

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

Parameters:

valueStep - A non-zero value

isChangedOnBeginEvent

public boolean isChangedOnBeginEvent()

Returns if the value should change when a keyboard/gamepad 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/gamepad event begins and change the value until the event ends.

Parameters:

changedOnBeginEvent - False to only change on the end event

isRenderNodeDirty

public boolean isRenderNodeDirty()

Specified by:

isRenderNodeDirty in class UiElement

setRenderNodeDirty

public void setRenderNodeDirty()

Specified by:

setRenderNodeDirty in class UiElement

isInitialLayoutOccurred

public boolean isInitialLayoutOccurred()

Specified by:

isInitialLayoutOccurred in class UiElement

isInitialUpdateOccurred

public boolean isInitialUpdateOccurred()

Specified by:

isInitialUpdateOccurred in class UiElement

getRenderX

public int getRenderX()

Description copied from class: UiElement

Returns X coordinate of where this element is currently rendering

Specified by:

getRenderX in class UiElement

Returns:

Integer.MIN_VALUE if not rendering

getRenderY

public int getRenderY()

Description copied from class: UiElement

Returns Y coordinate of where this element is currently rendering

Specified by:

getRenderY in class UiElement

Returns:

Integer.MIN_VALUE if not rendering

getRenderWidth

public int getRenderWidth()

Description copied from class: UiElement

Returns the width this element is currently rendering at

Specified by:

getRenderWidth in class UiElement

Returns:

-1 if not rendering

getRenderHeight

public int getRenderHeight()

Description copied from class: UiElement

Returns the height this element is currently rendering at

Specified by:

getRenderHeight in class UiElement

Returns:

-1 if not rendering