org.mini2Dx.ui.element

Class Label

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.Label

All Implemented Interfaces:

Hoverable

public class Label
extends UiElement

A text label UiElement

Field Summary

Fields

Modifier and Type	Field and Description
static com.badlogic.gdx.graphics.Color	COLOR_BLACK A blending-safe black Color value
static com.badlogic.gdx.graphics.Color	COLOR_WHITE A blending-safe white Color value
protected LabelRenderNode	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
Label() Constructor.
Label(float x, float y, float width, float height) Constructor
Label(java.lang.String id) Constructor
Label(java.lang.String id, float x, float y, float width, float height) 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
com.badlogic.gdx.graphics.Color	getColor() Returns the Color of the label
HorizontalAlignment	getHorizontalAlignment() Returns the HorizontalAlignment of the text
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
StyleRule	getStyleRule()
java.lang.String	getText() Returns the current text of the label
TextAnimation	getTextAnimation() Returns the current TextAnimation of the label
void	invokeBeginHover() Triggers the begin hover event
void	invokeEndHover() Triggers the end hover event
boolean	isInitialLayoutOccurred()
boolean	isInitialUpdateOccurred()
boolean	isRenderNodeDirty()
boolean	isResponsive() Returns if this label should fill its available space
void	setColor(com.badlogic.gdx.graphics.Color color) Sets the Color of the label
void	setHorizontalAlignment(HorizontalAlignment horizontalAlignment) Sets the HorizontalAlignment of the text
void	setRenderNodeDirty()
void	setResponsive(boolean responsive) Sets if this label should fill its available space
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
void	setText(java.lang.String text) Sets the current text of the label
void	setTextAnimation(TextAnimation textAnimation) Sets the current TextAnimation of the label
void	setVisibility(Visibility visibility) Sets the current Visibility of this UiElement
void	setZIndex(int zIndex) Sets the Z index of this UiElement.
void	shrinkToTextSize()
void	shrinkToTextSize(float maxWidth)
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, isFlexLayout, 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

Field Detail

COLOR_WHITE

public static final com.badlogic.gdx.graphics.Color COLOR_WHITE

A blending-safe white Color value

COLOR_BLACK

public static final com.badlogic.gdx.graphics.Color COLOR_BLACK

A blending-safe black Color value

renderNode

protected LabelRenderNode renderNode

Constructor Detail

Label

public Label()

Constructor. Generates a unique ID for the Label

Label

public Label(java.lang.String id)

Constructor

Parameters:

id - The unique ID of the Label

Label

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

Label

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

shrinkToTextSize

public void shrinkToTextSize()

shrinkToTextSize

public void shrinkToTextSize(float maxWidth)

getText

public java.lang.String getText()

Returns the current text of the label

Returns:

A non-null String

setText

public void setText(java.lang.String text)

Sets the current text of the label

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

invokeBeginHover

public void invokeBeginHover()

Description copied from interface: Hoverable

Triggers the begin hover event

invokeEndHover

public void invokeEndHover()

Description copied from interface: Hoverable

Triggers the end hover event

getStyleRule

public StyleRule getStyleRule()

Specified by:

getStyleRule in class UiElement

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

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

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

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()

Returns the HorizontalAlignment of the text

Returns:

HorizontalAlignment.LEFT by default

setHorizontalAlignment

public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)

Sets the HorizontalAlignment of the text

Parameters:

horizontalAlignment -

isResponsive

public boolean isResponsive()

Returns if this label should fill its available space

Returns:

False if the width matches the text width

setResponsive

public void setResponsive(boolean responsive)

Sets if this label should fill its available space

Parameters:

responsive - False if the width should match the text width

getColor

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

Returns the Color of the label

Returns:

Null if the Color is set by the UiTheme

setColor

public void setColor(com.badlogic.gdx.graphics.Color color)

Sets the Color of the label

Parameters:

color - Null if the Color should be retrieved from the UiTheme

getTextAnimation

public TextAnimation getTextAnimation()

Returns the current TextAnimation of the label

Returns:

Null by default

setTextAnimation

public void setTextAnimation(TextAnimation textAnimation)

Sets the current TextAnimation of the label

Parameters:

textAnimation - Null if no animation is to be played

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