org.mini2Dx.ui.element

Class Select<V>

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.Select<V>

All Implemented Interfaces:

Actionable, Hoverable

public class Select<V>
extends UiElement
implements Actionable

A UiElement with preset options. Uses left/right buttons to change the selection.

Field Summary

Fields

Modifier and Type	Field and Description
protected SelectRenderNode	renderNode

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

deferredQueue, effects, styleId, visibility, zIndex

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener listener)
void	addOption(SelectOption<V> option) Adds a selectable option to this Select
SelectOption<V>	addOption(java.lang.String label, V value) Adds a selectable option to this Select
void	attach(ParentRenderNode<?,?> parentRenderNode) Attaches a RenderNode for this element to a parent RenderNode
void	defer(java.lang.Runnable runnable) Defers the execution of a Runnable instance until the next frame update
void	detach(ParentRenderNode<?,?> parentRenderNode) Detaches this element's RenderNode from a parent RenderNode
com.badlogic.gdx.graphics.Color	getDisabledTextColor()
com.badlogic.gdx.graphics.Color	getEnabledTextColor()
LayoutRuleset	getLayout()
java.lang.String	getLeftButtonText()
java.lang.String	getRightButtonText()
int	getSelectedIndex() Returns the index of the currently selected option
java.lang.String	getSelectedLabel() Returns the label of the currently selected option
SelectOption<V>	getSelectedOption() Returns the currently selected option
V	getSelectedValue() Returns the value of the currently selected option
int	getTotalOptions() Returns the total amount of options
boolean	isEnabled()
void	nextOption() Changes the current selection to the next available option.
void	notifyActionListenersOfBeginEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)
void	notifyActionListenersOfEndEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)
void	previousOption() Changes the current selection to the option before the currently selected option.
void	removeActionListener(ActionListener listener)
void	removeOption(SelectOption<V> option) Removes a selectable option from this Select
boolean	removeOptionByLabel(java.lang.String label) Removes a selectable option from this Select based on the option's label
boolean	removeOptionByValue(V value) Removes a selectable option from this Select based on the option's value
void	setDisabledTextColor(com.badlogic.gdx.graphics.Color disabledTextColor)
void	setEnabled(boolean enabled)
void	setEnabledTextColor(com.badlogic.gdx.graphics.Color enabledTextColor)
void	setLayout(LayoutRuleset layoutRuleset)
void	setLayout(java.lang.String layoutRuleset)
void	setLeftButtonText(java.lang.String leftButtonText)
void	setRightButtonText(java.lang.String rightButtonText)
void	setSelectedIndex(int index) Sets the index of the currently selected option
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
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, equals, getElementById, getId, getStyleId, getVisibility, getZIndex, hashCode, isDebugEnabled, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, 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

Field Detail

renderNode

protected SelectRenderNode renderNode

Constructor Detail

Select

public Select()

Constructor. Generates a unique ID for this Select

Select

public Select(java.lang.String id)

Constructor

Parameters:

id - The unique ID for this Select

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

defer

public void defer(java.lang.Runnable runnable)

Description copied from class: UiElement

Defers the execution of a Runnable instance until the next frame update

Specified by:

defer in class UiElement

Parameters:

runnable - The Runnable to execute

syncWithRenderNode

public void syncWithRenderNode()

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode

Specified by:

syncWithRenderNode in class UiElement

addOption

public SelectOption<V> addOption(java.lang.String label,
                                 V value)

Adds a selectable option to this Select

Parameters:

label - The visible text of the option

value - The value of the option

Returns:

The SelectOption that was generated

addOption

public void addOption(SelectOption<V> option)

Adds a selectable option to this Select

Parameters:

option - The SelectOption to add

removeOption

public void removeOption(SelectOption<V> option)

Removes a selectable option from this Select

Parameters:

option - The SelectOption to remove

removeOptionByLabel

public boolean removeOptionByLabel(java.lang.String label)

Removes a selectable option from this Select based on the option's label

Parameters:

label - The label to search for

Returns:

True if the option was found

removeOptionByValue

public boolean removeOptionByValue(V value)

Removes a selectable option from this Select based on the option's value

Parameters:

value - The value to search for

Returns:

True if the option was found

getSelectedOption

public SelectOption<V> getSelectedOption()

Returns the currently selected option

Returns:

The selected SelectOption

getSelectedLabel

public java.lang.String getSelectedLabel()

Returns the label of the currently selected option

Returns:

The text that the player sees

getSelectedValue

public V getSelectedValue()

Returns the value of the currently selected option

Returns:

The selected value

getTotalOptions

public int getTotalOptions()

Returns the total amount of options

Returns:

0 if no options have been added

getSelectedIndex

public int getSelectedIndex()

Returns the index of the currently selected option

Returns:

0 by default

setSelectedIndex

public void setSelectedIndex(int index)

Sets the index of the currently selected option

Parameters:

index - The index to set as selected

nextOption

public void nextOption()

Changes the current selection to the next available option. If the current selection is the last option then this method does nothing.

previousOption

public void previousOption()

Changes the current selection to the option before the currently selected option. If this current selection is the first option then this method does nothing.

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

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Actionable

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface Actionable

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

getLayout

public LayoutRuleset getLayout()

setLayout

public void setLayout(java.lang.String layoutRuleset)

setLayout

public void setLayout(LayoutRuleset layoutRuleset)

getEnabledTextColor

public com.badlogic.gdx.graphics.Color getEnabledTextColor()

setEnabledTextColor

public void setEnabledTextColor(com.badlogic.gdx.graphics.Color enabledTextColor)

getDisabledTextColor

public com.badlogic.gdx.graphics.Color getDisabledTextColor()

setDisabledTextColor

public void setDisabledTextColor(com.badlogic.gdx.graphics.Color disabledTextColor)

getLeftButtonText

public java.lang.String getLeftButtonText()

setLeftButtonText

public void setLeftButtonText(java.lang.String leftButtonText)

getRightButtonText

public java.lang.String getRightButtonText()

setRightButtonText

public void setRightButtonText(java.lang.String rightButtonText)