org.mini2Dx.ui.element

Class TextButton

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.Button

org.mini2Dx.ui.element.TextButton

All Implemented Interfaces:

Actionable, Hoverable

public class TextButton
extends Button

Implementation of Button that only contains text

Field Summary

Fields

Modifier and Type	Field and Description
protected TextButtonRenderNode	renderNode

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

layout

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

effects, styleId, visibility, zIndex

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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	getText() Returns the text of this TextButton
HorizontalAlignment	getTextAlignment() Returns the HorizontalAlignment of the button's text
void	setLayout(java.lang.String layout) Sets the current layout for this Button
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
void	setText(java.lang.String text) Sets the text of this TextButton
void	setTextAlignment(HorizontalAlignment textAlignment) Sets the HorizontalAlignment of the button's text
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.Button

addActionListener, getLayout, isEnabled, notifyActionListenersOfBeginEvent, notifyActionListenersOfEndEvent, removeActionListener, setEnabled

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 TextButtonRenderNode renderNode

Constructor Detail

TextButton

public TextButton()

Constructor. Generates a unique ID for this TextButton

TextButton

public TextButton(java.lang.String id)

Constructor

Parameters:

id - The unique ID for this TextButton

Method Detail

getText

public java.lang.String getText()

Returns the text of this TextButton

Returns:

An empty String by default

setText

public void setText(java.lang.String text)

Sets the text of this TextButton

Parameters:

text - A non-null String

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

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

syncWithRenderNode

public void syncWithRenderNode()

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode

Specified by:

syncWithRenderNode in class UiElement

getTextAlignment

public HorizontalAlignment getTextAlignment()

Returns the HorizontalAlignment of the button's text

Returns:

HorizontalAlignment.CENTER by default

setTextAlignment

public void setTextAlignment(HorizontalAlignment textAlignment)

Sets the HorizontalAlignment of the button's text

Parameters:

textAlignment - The text alignment

setLayout

public void setLayout(java.lang.String layout)

Description copied from class: Button

Sets the current layout for this Button

Specified by:

setLayout in class Button