org.mini2Dx.ui.element

Class TextBox

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.TextBox

All Implemented Interfaces:

Actionable, Hoverable

public class TextBox
extends UiElement
implements Actionable

A text box UiElement. Can optionally function as a password field.

Field Summary

Fields

Modifier and Type	Field and Description
protected TextBoxRenderNode	renderNode

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

deferred, effects, styleId, visibility, zIndex

Constructor Summary

Constructors

Constructor and Description
TextBox() Constructor.
TextBox(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
java.lang.String	getHorizontalLayout() Returns the current horizontal layout rules
java.lang.String	getValue() Returns the text value entered into this TextBox
java.lang.String	getVerticalLayout() Returns the current vertical layout rules
boolean	isEnabled()
boolean	isPasswordField() Returns if this TextBox is a password field
void	notifyActionListenersOfBeginEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)
void	notifyActionListenersOfEndEvent(EventTrigger eventTrigger, EventTriggerParams eventTriggerParams)
void	removeActionListener(ActionListener listener)
void	setEnabled(boolean enabled)
void	setHorizontalLayout(java.lang.String sizeRuleset) Sets the current horizontal layout rules
void	setPasswordField(boolean passwordField) Sets if this TextBox is a password field
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
void	setValue(java.lang.String value) Sets the text value entered into this TextBox
void	setVerticalLayout(java.lang.String sizeRuleset) Sets the current vertical layout rules
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

Field Detail

renderNode

protected TextBoxRenderNode renderNode

Constructor Detail

TextBox

public TextBox()

Constructor. Generates a unique ID for this TextBox

TextBox

public TextBox(java.lang.String id)

Constructor

Parameters:

id - The unique ID for this TextBox

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

getValue

public java.lang.String getValue()

Returns the text value entered into this TextBox

Returns:

An empty String by default

setValue

public void setValue(java.lang.String value)

Sets the text value entered into this TextBox

Parameters:

value - A non-null String

isPasswordField

public boolean isPasswordField()

Returns if this TextBox is a password field

Returns:

True if characters are hidden by * characters

setPasswordField

public void setPasswordField(boolean passwordField)

Sets if this TextBox is a password field

Parameters:

passwordField - True if characters should be hidden by * characters

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

getHorizontalLayout

public java.lang.String getHorizontalLayout()

Returns the current horizontal layout rules

Returns:

setHorizontalLayout

public void setHorizontalLayout(java.lang.String sizeRuleset)

Sets the current horizontal layout rules

Parameters:

sizeRuleset -

getVerticalLayout

public java.lang.String getVerticalLayout()

Returns the current vertical layout rules

Returns:

setVerticalLayout

public void setVerticalLayout(java.lang.String sizeRuleset)

Sets the current vertical layout rules

Parameters:

sizeRuleset -