org.mini2Dx.ui.element

Class TextButton

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.ParentUiElement

org.mini2Dx.ui.element.Button

org.mini2Dx.ui.element.TextButton

All Implemented Interfaces:

Actionable, FlexUiElement, Hoverable

public class TextButton
extends Button

Utility implementation of Button that contains a Label

Field Summary

Fields

Modifier and Type	Field and Description
protected Label	label

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

asyncRemoveAll, children, 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
TextButton() Constructor.
TextButton(float x, float y, float width, float height) Constructor
TextButton(java.lang.String id) Constructor
TextButton(java.lang.String id, float x, float y, float width, float height) Constructor

Method Summary

Modifier and Type	Method and Description
Label	getLabel() Returns the backing label for the button
java.lang.String	getText() Returns the text of this TextButton
HorizontalAlignment	getTextAlignment() Returns the HorizontalAlignment of the button's text
void	setText(java.lang.String text) Sets the text of this TextButton
void	setTextAlignment(HorizontalAlignment textAlignment) Sets the HorizontalAlignment of the button's text

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

addActionListener, createRenderNode, getStyleRule, isEnabled, notifyActionListenersOfBeginEvent, notifyActionListenersOfEndEvent, removeActionListener, setEnabled

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

add, add, attach, detach, get, getChild, getElementById, getFlexLayout, getRenderHeight, getRenderWidth, getRenderX, getRenderY, getTotalChildren, invokeBeginHover, invokeEndHover, isFlexLayout, isInitialLayoutOccurred, isInitialUpdateOccurred, isOverflowClipped, isRenderNodeDirty, remove, remove, removeAll, removeAllAsync, setFlex, setFlexLayout, setHeightFlex, setOverflowClipped, setRenderNodeDirty, setStyleId, setVisibility, setWidthFlex, setXFlex, setXYFlex, setYFlex, setZIndex, shrinkToContents, shrinkToContents, syncWithUpdate

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, 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, invokeBeginHover, invokeEndHover, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, removeHoverListener

Field Detail

label

protected Label label

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

TextButton

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

TextButton

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

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

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

getLabel

public Label getLabel()

Returns the backing label for the button

Returns: