com.badlogic.gdx.graphics.g2d

Class GlyphLayout

java.lang.Object

com.badlogic.gdx.graphics.g2d.GlyphLayout

All Implemented Interfaces:

Pool.Poolable

public class GlyphLayout
extends Object
implements Pool.Poolable

Stores runs of glyphs for a piece of text. The text may contain newlines and color markup tags.

Author:

Nathan Sweet, davebaol, Alexander Dorokhov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlyphLayout.GlyphRun Stores glyphs and positions for a piece of text which is a single color and does not span multiple lines.

Field Summary

Fields

Modifier and Type	Field and Description
float	height
Array<GlyphLayout.GlyphRun>	runs
float	width

Constructor Summary

Constructors

Constructor and Description
GlyphLayout() Creates an empty GlyphLayout.
GlyphLayout(BitmapFont font, CharSequence str)
GlyphLayout(BitmapFont font, CharSequence str, Color color, float targetWidth, int halign, boolean wrap)
GlyphLayout(BitmapFont font, CharSequence str, int start, int end, Color color, float targetWidth, int halign, boolean wrap, String truncate)

Method Summary

Modifier and Type	Method and Description
void	reset() Resets the object for reuse.
void	setText(BitmapFont font, CharSequence str) Calls setText with the whole string, the font's current color, and no alignment or wrapping.
void	setText(BitmapFont font, CharSequence str, Color color, float targetWidth, int halign, boolean wrap) Calls setText with the whole string and no truncation.
void	setText(BitmapFont font, CharSequence str, int start, int end, Color color, float targetWidth, int halign, boolean wrap, String truncate)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

runs

public final Array<GlyphLayout.GlyphRun> runs

width

public float width

height

public float height

Constructor Detail

GlyphLayout

public GlyphLayout()

Creates an empty GlyphLayout.

GlyphLayout

public GlyphLayout(BitmapFont font,
                   CharSequence str)

See Also:

setText(BitmapFont, CharSequence)

GlyphLayout

public GlyphLayout(BitmapFont font,
                   CharSequence str,
                   Color color,
                   float targetWidth,
                   int halign,
                   boolean wrap)

See Also:

setText(BitmapFont, CharSequence)

GlyphLayout

public GlyphLayout(BitmapFont font,
                   CharSequence str,
                   int start,
                   int end,
                   Color color,
                   float targetWidth,
                   int halign,
                   boolean wrap,
                   String truncate)

See Also:

setText(BitmapFont, CharSequence)

Method Detail

setText

public void setText(BitmapFont font,
                    CharSequence str)

Calls setText with the whole string, the font's current color, and no alignment or wrapping.

setText

public void setText(BitmapFont font,
                    CharSequence str,
                    Color color,
                    float targetWidth,
                    int halign,
                    boolean wrap)

Calls setText with the whole string and no truncation.

setText

public void setText(BitmapFont font,
                    CharSequence str,
                    int start,
                    int end,
                    Color color,
                    float targetWidth,
                    int halign,
                    boolean wrap,
                    String truncate)

Parameters:

color - The default color to use for the text (the BitmapFont color is not used). If BitmapFont.BitmapFontData.markupEnabled is true, color markup tags in the specified string may change the color for portions of the text.

halign - Horizontal alignment of the text, see Align.

targetWidth - The width used for alignment, line wrapping, and truncation. May be zero if those features are not used.

truncate - If not null and the width of the glyphs exceed targetWidth, the glyphs are truncated and the glyphs for the specified truncate string are placed at the end. Empty string can be used to truncate without adding glyphs. Truncate should not be used with text that contains multiple lines. Wrap is ignored if truncate is not null.

reset

public void reset()

Description copied from interface: Pool.Poolable

Resets the object for reuse. Object references should be nulled and fields may be set to default values.

Specified by:

reset in interface Pool.Poolable

toString

public String toString()

Overrides:

toString in class Object