Package arc.graphics.g2d

Class GlyphLayout

java.lang.Object

arc.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	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	Description
float	height
boolean	ignoreMarkup
final Seq<GlyphLayout.GlyphRun>	runs
float	width

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	free()
static GlyphLayout	obtain()
void	reset()	Resets the object for reuse.
void	setText(Font font, CharSequence str)
void	setText(Font font, CharSequence str, int start, int end, Color color, float targetWidth, int halign, boolean wrap, String truncate)
void	setText(Font font, CharSequence str, Color color, float targetWidth, int halign, boolean wrap)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

runs

public final Seq<GlyphLayout.GlyphRun> runs

ignoreMarkup

public boolean ignoreMarkup

width

public float width

height

public float height

Constructor Details

GlyphLayout

public GlyphLayout()

Creates an empty GlyphLayout.

GlyphLayout

public GlyphLayout(boolean ignoreMarkup)

GlyphLayout

public GlyphLayout(Font font,
 CharSequence str)

GlyphLayout

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

GlyphLayout

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

Method Details

obtain

public static GlyphLayout obtain()

free

public void free()

setText

public void setText(Font font,
 CharSequence str)

setText

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

setText

public void setText(Font 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 Font.FontData.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