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, FlexUiElement, Hoverable

public class Select<V>
extends UiElement
implements Actionable, FlexUiElement

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

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

Constructor Summary

Constructors

Constructor and Description
Select() Constructor.
Select(float x, float y, float width, float height) Constructor
Select(java.lang.String id) Constructor
Select(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	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	detach(ParentRenderNode<?,?> parentRenderNode) Detaches this element's RenderNode from a parent RenderNode
Color	getDisabledTextColor()
Color	getEnabledTextColor()
java.lang.String	getFlexLayout() Returns the currently used flex layout
java.lang.String	getLeftButtonText()
SelectOption<V>	getOption(int index) Returns the option at the specified index
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
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
StyleRule	getStyleRule()
int	getTotalOptions() Returns the total amount of options
void	invokeBeginHover() Triggers the begin hover event
void	invokeEndHover() Triggers the end hover event
boolean	isEnabled()
boolean	isFlexLayout() Returns if this UiElement is using a flex layout
boolean	isInitialLayoutOccurred()
boolean	isInitialUpdateOccurred()
boolean	isRenderNodeDirty()
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(Color disabledTextColor)
void	setEnabled(boolean enabled)
void	setEnabledTextColor(Color enabledTextColor)
void	setFlex(float x, float y, float width, float height) Equivalent to UiElement.set(float, float, float, float) for usage with flex layout
void	setFlexLayout(java.lang.String flexLayout) Sets the current flex layout
void	setHeightFlex(float height) Equivalent to UiElement.setHeight(float) for usage with flex layout
void	setLeftButtonText(java.lang.String leftButtonText)
void	setRenderNodeDirty()
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	setWidthFlex(float width) Equivalent to UiElement.setWidth(float) for usage with flex layout
void	setXFlex(float x) Equivalent to UiElement.setX(float) for usage with flex layout
void	setXYFlex(float x, float y) Equivalent to UiElement.setXY(float, float) for usage with flex layout
void	setYFlex(float y) Equivalent to UiElement.setY(float) for usage with flex layout
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, 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

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

Select

public Select(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

Select

public Select(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

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

getOption

public SelectOption<V> getOption(int index)

Returns the option at the specified index

Parameters:

index - The index to get

Returns:

The SelectOption instance

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

getStyleRule

public StyleRule getStyleRule()

Specified by:

getStyleRule in class UiElement

getFlexLayout

public java.lang.String getFlexLayout()

Description copied from interface: FlexUiElement

Returns the currently used flex layout

Specified by:

getFlexLayout in interface FlexUiElement

Returns:

null if no flex layout is used

setFlexLayout

public void setFlexLayout(java.lang.String flexLayout)

Description copied from interface: FlexUiElement

Sets the current flex layout

Specified by:

setFlexLayout in interface FlexUiElement

Parameters:

flexLayout - see: FlexLayoutRuleset

getEnabledTextColor

public Color getEnabledTextColor()

setEnabledTextColor

public void setEnabledTextColor(Color enabledTextColor)

getDisabledTextColor

public Color getDisabledTextColor()

setDisabledTextColor

public void setDisabledTextColor(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)

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

isFlexLayout

public boolean isFlexLayout()

Description copied from class: UiElement

Returns if this UiElement is using a flex layout

Specified by:

isFlexLayout in interface FlexUiElement

Overrides:

isFlexLayout in class UiElement

Returns:

False by default

setFlex

public void setFlex(float x,
                    float y,
                    float width,
                    float height)

Equivalent to UiElement.set(float, float, float, float) for usage with flex layout

Parameters:

x - The x coordinate (in pixels) relative to its parent

y - The y coordinate (in pixels) relative to its parent

width - The width in pixels

height - The height in pixels

setXYFlex

public void setXYFlex(float x,
                      float y)

Equivalent to UiElement.setXY(float, float) for usage with flex layout

Parameters:

x - The x coordinate (in pixels) relative to its parent

y - The y coordinate (in pixels) relative to its parent

setXFlex

public void setXFlex(float x)

Equivalent to UiElement.setX(float) for usage with flex layout

Parameters:

x - The x coordinate (in pixels) relative to its parent

setYFlex

public void setYFlex(float y)

Equivalent to UiElement.setY(float) for usage with flex layout

Parameters:

y - The y coordinate (in pixels) relative to its parent

setWidthFlex

public void setWidthFlex(float width)

Equivalent to UiElement.setWidth(float) for usage with flex layout

Parameters:

width - The width in pixels

setHeightFlex

public void setHeightFlex(float height)

Equivalent to UiElement.setHeight(float) for usage with flex layout

Parameters:

height - The height in pixels