Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
private BitmapFontCache	cache
private String	ellipsis
private boolean	fontScaleChanged
private float	fontScaleX
private float	fontScaleY
private int	intValue
private Justify	justify
private int	labelAlign
private float	lastPrefHeight
private final GlyphLayout	layout
private int	lineAlign
private float	prefHeight
private boolean	prefSizeInvalid
private static final GlyphLayout	prefSizeLayout
private float	prefWidth
private Label.LabelStyle	style
private static final Color	tempColor
private final CharArray	text
private boolean	wrap

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
protected void	computePrefSize(GlyphLayout layout)
public void	draw(Batch batch, float parentAlpha) Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.draw. If this method is overridden, the super method or `validate()` should be called to ensure the widget is laid out.
protected BitmapFontCache	getBitmapFontCache() Allows subclasses to access the cache in `draw(Batch, float)`.
public float	getFontScaleX()
public float	getFontScaleY()
public GlyphLayout	getGlyphLayout()
public Justify	getJustify()
public int	getLabelAlign()
public int	getLineAlign()
public float	getPrefHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.
public float	getPrefWidth() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefWidth. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.
public Label.LabelStyle	getStyle() Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle. Returns the label's style.
public CharArray	getText()
public boolean	getWrap()
public void	invalidate() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.invalidate. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.invalidate. Invalidates this actor's layout, causing `layout()` to happen the next time `validate()` is called.
public void	layout() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.layout. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.layout. Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls `invalidate()` on any each child whose width or height has changed, and calls `validate()` on each child.
private void	scaleAndComputePrefSize()
public void	setAlignment(int Aligns all the text within the label (default left center) and each line of text horizontally (default left). alignment)
public void	setAlignment(int Aligns all the text within the label (default left center). labelAlign, int Aligns each line of text horizontally (default left). lineAlign)
public void	setEllipsis(String ellipsis) When non-null the text will be truncated "..." if it does not fit within the width of the label.
public void	setEllipsis(boolean ellipsis) When true the text will be truncated "..." if it does not fit within the width of the label.
public void	setFontScale(float fontScale)
public void	setFontScale(float fontScaleX, float fontScaleY)
public void	setFontScaleX(float fontScaleX)
public void	setFontScaleY(float fontScaleY)
public void	setJustify(Justify Justifies text to the label widths (disabled by default). justify)
public void	setStyle(Label.LabelStyle style) Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle. Set the current style of the actor
public boolean	Returns: true if the text was changed. setText(int value) Sets the text to the specified integer value.
public void	setText(CharSequence If null, "" will be used. newText)
public void	setWrap(boolean wrap) If false, the text will only wrap where it contains newlines (\n).
public boolean	textEquals(CharSequence other)
public String	toString() Overrides com.badlogic.gdx.scenes.scene2d.Actor.toString. Returns a string representation of the object.

Inherited from com.badlogic.gdx.scenes.scene2d.ui.Widget:: getMaxHeight getMaxWidth getMinHeight getMinWidth invalidateHierarchy needsLayout pack setFillParent setLayoutEnabled sizeChanged validate

Field Detail

cache	back to summary
private BitmapFontCache cache

ellipsis	back to summary
private String ellipsis Annotations @Null

fontScaleChanged	back to summary
private boolean fontScaleChanged

fontScaleX	back to summary
private float fontScaleX

fontScaleY	back to summary
private float fontScaleY

intValue	back to summary
private int intValue

justify	back to summary
private Justify justify

labelAlign	back to summary
private int labelAlign

lastPrefHeight	back to summary
private float lastPrefHeight

layout	back to summary
private final GlyphLayout layout

layout

back to summary

private final GlyphLayout layout

lineAlign	back to summary
private int lineAlign

prefHeight	back to summary
private float prefHeight

prefSizeInvalid	back to summary
private boolean prefSizeInvalid

prefSizeLayout	back to summary
private static final GlyphLayout prefSizeLayout

prefWidth	back to summary
private float prefWidth

style	back to summary
private Label.LabelStyle style

tempColor	back to summary
private static final Color tempColor

text	back to summary
private final CharArray text

wrap	back to summary
private boolean wrap

Constructor Detail

Label	back to summary
public Label(CharSequence text, Skin skin)

Label	back to summary
public Label(CharSequence text, Skin skin, String styleName)

Label	back to summary
public Label(CharSequence text, Skin skin, String fontName, Color color) Creates a label, using a `LabelStyle` that has a BitmapFont with the specified name from the skin and the specified color.

Label	back to summary
public Label(CharSequence text, Skin skin, String fontName, String colorName) Creates a label, using a `LabelStyle` that has a BitmapFont with the specified name and the specified color from the skin.

Label	back to summary
public Label(CharSequence text, Label.LabelStyle style)

Method Detail

computePrefSize	back to summary
protected void computePrefSize(GlyphLayout layout)

draw back to summary

draw	back to summary
public void draw(Batch batch, float parentAlpha) Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.draw. Doc from com.badlogic.gdx.scenes.scene2d.ui.Widget.draw. If this method is overridden, the super method or `validate()` should be called to ensure the widget is laid out.

public void draw(Batch batch, float parentAlpha)

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

Doc from com.badlogic.gdx.scenes.scene2d.ui.Widget.draw.

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

getBitmapFontCache	back to summary
protected BitmapFontCache getBitmapFontCache() Allows subclasses to access the cache in `draw(Batch, float)`.

getFontScaleX	back to summary
public float getFontScaleX()

getFontScaleY	back to summary
public float getFontScaleY()

getGlyphLayout	back to summary
public GlyphLayout getGlyphLayout()

getJustify	back to summary
public Justify getJustify()

getLabelAlign	back to summary
public int getLabelAlign()

getLineAlign	back to summary
public int getLineAlign()

getPrefHeight	back to summary
public float getPrefHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.

getPrefHeight

back to summary

public float getPrefHeight()

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

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.

getPrefWidth	back to summary
public float getPrefWidth() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefWidth. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.

getPrefWidth

back to summary

public float getPrefWidth()

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

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.

getStyle back to summary

getStyle	back to summary
public Label.LabelStyle getStyle() Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle. Returns the label's style. Modifying the returned style may not have an effect until `setStyle(LabelStyle)` is called.

public Label.LabelStyle getStyle()

Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle.

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

getText	back to summary
public CharArray getText()

getWrap	back to summary
public boolean getWrap()

invalidate back to summary

invalidate	back to summary
public void invalidate() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.invalidate. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.invalidate. Doc from com.badlogic.gdx.scenes.scene2d.utils.Layout.invalidate. Invalidates this actor's layout, causing `layout()` to happen the next time `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).

public void invalidate()

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

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.invalidate.

Doc from com.badlogic.gdx.scenes.scene2d.utils.Layout.invalidate.

Invalidates this actor's layout, causing layout() to happen the next time 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).

layout back to summary

layout	back to summary
public void layout() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.layout. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.layout. Doc from com.badlogic.gdx.scenes.scene2d.utils.Layout.layout. Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls `invalidate()` on any each child whose width or height has changed, and calls `validate()` on each child. This method should almost never be called directly, instead `validate()` should be used.

public void layout()

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

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.layout.

Doc from com.badlogic.gdx.scenes.scene2d.utils.Layout.layout.

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

scaleAndComputePrefSize	back to summary
private void scaleAndComputePrefSize()

setAlignment	back to summary
public void setAlignment(int alignment) Parameters alignment:int Aligns all the text within the label (default left center) and each line of text horizontally (default left). See Also `Align`

setAlignment	back to summary
public void setAlignment(int labelAlign, int lineAlign) Parameters labelAlign:int Aligns all the text within the label (default left center). lineAlign:int Aligns each line of text horizontally (default left). See Also `Align`

setEllipsis	back to summary
public void setEllipsis(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	back to summary
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.

setFontScale	back to summary
public void setFontScale(float fontScale)

setFontScale	back to summary
public void setFontScale(float fontScaleX, float fontScaleY)

setFontScaleX	back to summary
public void setFontScaleX(float fontScaleX)

setFontScaleY	back to summary
public void setFontScaleY(float fontScaleY)

setJustify	back to summary
public void setJustify(Justify justify) Parameters justify:Justify Justifies text to the label widths (disabled by default). See Also `Justify`

setStyle

back to summary

public void setStyle(Label.LabelStyle style)

Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle.

Doc from com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle.

Set the current style of the actor

setText

back to summary

public boolean setText(int value)

Sets the text to the specified integer value. If the text is already equivalent to the specified value, a string is not allocated.

Returns:boolean: true if the text was changed.

setText	back to summary
public void setText(CharSequence newText) Parameters newText:CharSequence If null, "" will be used.

setWrap

back to summary

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.

textEquals	back to summary
public boolean textEquals(CharSequence other)

toString back to summary

public String toString()

Overrides com.badlogic.gdx.scenes.scene2d.Actor.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

com.badlogic.gdx.scenes.scene2d.ui back to summary

public Class Label.LabelStyle

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle

The style for a label, see Label.

Author: Nathan Sweet

Field Summary

Modifier and Type	Field and Description
public Drawable	background
public BitmapFont	font
public Color	fontColor

Constructor Summary

Access	Constructor and Description
public	LabelStyle()
public	LabelStyle(BitmapFont font, Color fontColor)
public	LabelStyle(Label.LabelStyle style)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

background	back to summary
public Drawable background Annotations @Null

font	back to summary
public BitmapFont font

fontColor	back to summary
public Color fontColor Annotations @Null

Constructor Detail

LabelStyle	back to summary
public LabelStyle()

LabelStyle	back to summary
public LabelStyle(BitmapFont font, Color fontColor)

LabelStyle	back to summary
public LabelStyle(Label.LabelStyle style)