com.badlogic.gdx.scenes.scene2d.ui

Class Label

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.ui.Widget

com.badlogic.gdx.scenes.scene2d.ui.Label

All Implemented Interfaces:

Layout

public class Label
extends Widget

A text label, with optional word wrapping.

The preferred size of the label is determined by the actual text bounds, unless word wrap is enabled.

Author:

Nathan Sweet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Label.LabelStyle The style for a label, see Label.

Constructor Summary

Constructors

Constructor and Description
Label(java.lang.CharSequence text, Label.LabelStyle style)
Label(java.lang.CharSequence text, Skin skin)
Label(java.lang.CharSequence text, Skin skin, java.lang.String styleName)
Label(java.lang.CharSequence text, Skin skin, java.lang.String fontName, Color color) Creates a label, using a Label.LabelStyle that has a BitmapFont with the specified name from the skin and the specified color.
Label(java.lang.CharSequence text, Skin skin, java.lang.String fontName, java.lang.String colorName) Creates a label, using a Label.LabelStyle that has a BitmapFont with the specified name and the specified color from the skin.

Method Summary

Modifier and Type	Method and Description
void	draw(Batch batch, float parentAlpha) If this method is overridden, the super method or Widget.validate() should be called to ensure the widget is laid out.
protected BitmapFontCache	getBitmapFontCache() Allows subclasses to access the cache in draw(Batch, float).
float	getFontScaleX()
float	getFontScaleY()
GlyphLayout	getGlyphLayout()
int	getLabelAlign()
int	getLineAlign()
float	getPrefHeight()
float	getPrefWidth()
Label.LabelStyle	getStyle() Returns the label's style.
StringBuilder	getText()
void	invalidate() Invalidates this actor's layout, causing Layout.layout() to happen the next time Layout.validate() is called.
void	layout() Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls Layout.invalidate() on any each child whose width or height has changed, and calls Layout.validate() on each child.
void	setAlignment(int alignment)
void	setAlignment(int labelAlign, int lineAlign)
void	setEllipsis(boolean ellipsis) When true the text will be truncated "..." if it does not fit within the width of the label.
void	setEllipsis(java.lang.String ellipsis) When non-null the text will be truncated "..." if it does not fit within the width of the label.
void	setFontScale(float fontScale)
void	setFontScale(float fontScaleX, float fontScaleY)
void	setFontScaleX(float fontScaleX)
void	setFontScaleY(float fontScaleY)
void	setStyle(Label.LabelStyle style)
void	setText(java.lang.CharSequence newText)
void	setWrap(boolean wrap) If false, the text will only wrap where it contains newlines (\n).
boolean	textEquals(java.lang.CharSequence other)
java.lang.String	toString()

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Widget

getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, invalidateHierarchy, needsLayout, pack, setFillParent, setLayoutEnabled, sizeChanged, validate

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor

act, addAction, addCaptureListener, addListener, clear, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, debug, drawDebug, drawDebugBounds, fire, firstAscendant, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasActions, hasParent, hit, isAscendantOf, isDescendantOf, isTouchable, isVisible, localToAscendantCoordinates, localToParentCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, positionChanged, remove, removeAction, removeCaptureListener, removeListener, rotateBy, rotationChanged, scaleBy, scaleBy, screenToLocalCoordinates, setBounds, setColor, setColor, setDebug, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setStage, setTouchable, setUserObject, setVisible, setWidth, setX, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Label

public Label(java.lang.CharSequence text,
             Skin skin)

Label

public Label(java.lang.CharSequence text,
             Skin skin,
             java.lang.String styleName)

Label

public Label(java.lang.CharSequence text,
             Skin skin,
             java.lang.String fontName,
             Color color)

Creates a label, using a Label.LabelStyle that has a BitmapFont with the specified name from the skin and the specified color.

Label

public Label(java.lang.CharSequence text,
             Skin skin,
             java.lang.String fontName,
             java.lang.String colorName)

Creates a label, using a Label.LabelStyle that has a BitmapFont with the specified name and the specified color from the skin.

Label

public Label(java.lang.CharSequence text,
             Label.LabelStyle style)

Method Detail

setStyle

public void setStyle(Label.LabelStyle style)

getStyle

public Label.LabelStyle getStyle()

Returns the label's style. Modifying the returned style may not have an effect until setStyle(LabelStyle) is called.

setText

public void setText(java.lang.CharSequence newText)

Parameters:

newText - May be null, "" will be used.

textEquals

public boolean textEquals(java.lang.CharSequence other)

getText

public StringBuilder getText()

invalidate

public void invalidate()

Description copied from interface: Layout

Invalidates this actor's layout, causing Layout.layout() to happen the next time Layout.validate() is called. This method should be called when state changes in the actor that requires a layout but does not change the minimum, preferred, maximum, or actual size of the actor (meaning it does not affect the parent actor's layout).

Specified by:

invalidate in interface Layout

Overrides:

invalidate in class Widget

layout

public void layout()

Description copied from interface: Layout

Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls Layout.invalidate() on any each child whose width or height has changed, and calls Layout.validate() on each child. This method should almost never be called directly, instead Layout.validate() should be used.

Specified by:

layout in interface Layout

Overrides:

layout in class Widget

draw

public void draw(Batch batch,
                 float parentAlpha)

Description copied from class: Widget

If this method is overridden, the super method or Widget.validate() should be called to ensure the widget is laid out.

Overrides:

draw in class Widget

parentAlpha - Should be multiplied with the actor's alpha, allowing a parent's alpha to affect all children.

getPrefWidth

public float getPrefWidth()

Specified by:

getPrefWidth in interface Layout

Overrides:

getPrefWidth in class Widget

getPrefHeight

public float getPrefHeight()

Specified by:

getPrefHeight in interface Layout

Overrides:

getPrefHeight in class Widget

getGlyphLayout

public GlyphLayout getGlyphLayout()

setWrap

public void setWrap(boolean wrap)

If false, the text will only wrap where it contains newlines (\n). The preferred size of the label will be the text bounds. If true, the text will word wrap using the width of the label. The preferred width of the label will be 0, it is expected that something external will set the width of the label. Wrapping will not occur when ellipsis is enabled. Default is false.

When wrap is enabled, the label's preferred height depends on the width of the label. In some cases the parent of the label will need to layout twice: once to set the width of the label and a second time to adjust to the label's new preferred height.

getLabelAlign

public int getLabelAlign()

getLineAlign

public int getLineAlign()

setAlignment

public void setAlignment(int alignment)

Parameters:

alignment - Aligns all the text within the label (default left center) and each line of text horizontally (default left).

See Also:

Align

setAlignment

public void setAlignment(int labelAlign,
                         int lineAlign)

Parameters:

labelAlign - Aligns all the text within the label (default left center).

lineAlign - Aligns each line of text horizontally (default left).

See Also:

Align

setFontScale

public void setFontScale(float fontScale)

setFontScale

public void setFontScale(float fontScaleX,
                         float fontScaleY)

getFontScaleX

public float getFontScaleX()

setFontScaleX

public void setFontScaleX(float fontScaleX)

getFontScaleY

public float getFontScaleY()

setFontScaleY

public void setFontScaleY(float fontScaleY)

setEllipsis

public void setEllipsis(java.lang.String ellipsis)

When non-null the text will be truncated "..." if it does not fit within the width of the label. Wrapping will not occur when ellipsis is enabled. Default is false.

setEllipsis

public void setEllipsis(boolean ellipsis)

When true the text will be truncated "..." if it does not fit within the width of the label. Wrapping will not occur when ellipsis is true. Default is false.

getBitmapFontCache

protected BitmapFontCache getBitmapFontCache()

Allows subclasses to access the cache in draw(Batch, float).

toString

public java.lang.String toString()

Overrides:

toString in class Actor