com.github.tommyettinger.textra

Class TextraLabel

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

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

com.github.tommyettinger.textra.TextraLabel

All Implemented Interfaces:

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

Direct Known Subclasses:

TypingLabel

public class TextraLabel
extends com.badlogic.gdx.scenes.scene2d.ui.Widget

A scene2d.ui Widget that displays text using a Font rather than a libGDX BitmapFont. This supports being laid out in a Table just like the typical Label.

Field Summary

Fields

Modifier and Type	Field and Description
int	align
protected Font	font
Layout	layout
java.lang.String	storedText
com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle	style
boolean	wrap

Constructor Summary

Constructors

Constructor and Description
TextraLabel() Creates a TextraLabel that uses the default libGDX font (lsans-15 in the current version) with white color.
TextraLabel(java.lang.String text, Font font) Creates a TextraLabel with the given text (which may be multi-line) and using the given Font.
TextraLabel(java.lang.String text, Font font, com.badlogic.gdx.graphics.Color color) Creates a TextraLabel with the given text (which may be multi-line), using the given Font, and using the given default color.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle style) Creates a TextraLabel with the given text (which may be multi-line) and using the given style.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle style, boolean makeGridGlyphs) Creates a TextraLabel with the given text (which may be multi-line) and using the given style.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle style, Font replacementFont) Creates a TextraLabel with the given text (which may be multi-line) and using the given style.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin) Creates a TextraLabel with the given text (which may be multi-line) and using the specified Skin's LabelStyle.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, boolean makeGridGlyphs) Creates a TextraLabel with the given text (which may be multi-line) and using the specified Skin's LabelStyle.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, Font replacementFont) Creates a TextraLabel with the given text (which may be multi-line) and using the default style from a Skin, replacing any font that would be drawn from the style with replacementFont.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, java.lang.String styleName) Creates a TextraLabel with the given text (which may be multi-line) and using the specified style from the given Skin.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, java.lang.String styleName, boolean makeGridGlyphs) Creates a TextraLabel with the given text (which may be multi-line) and using the specified style from the given Skin.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, java.lang.String styleName, com.badlogic.gdx.graphics.Color color) Creates a TextraLabel with the given text (which may be multi-line), using the specified style from the given Skin, with the default Color overridden by the given one.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, java.lang.String styleName, Font replacementFont) Creates a TextraLabel with the given text (which may be multi-line) and using the given style taken by name from a Skin, replacing any font that would be drawn from the style with replacementFont.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, java.lang.String styleName, Font replacementFont, com.badlogic.gdx.graphics.Color color) Creates a TextraLabel with the given text (which may be multi-line) and using the given style taken by name from a Skin, replacing any font that would be drawn from the style with replacementFont.
TextraLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, java.lang.String styleName, java.lang.String colorName) Creates a TextraLabel with the given text (which may be multi-line), using the specified style from the given Skin, with the default Color overridden by the color with the given name in the skin.

Method Summary

Modifier and Type	Method and Description
void	draw(com.badlogic.gdx.graphics.g2d.Batch batch, float parentAlpha)
int	getAlignment() Gets the alignment for the text in this TextraLabel.
Font	getFont()
float	getPrefHeight()
float	getPrefWidth()
boolean	isWrap() Gets the current wrapping mode.
void	layout()
void	setAlignment(int alignment) Sets the alignment for the text in this TextraLabel.
void	setFont(Font font) Sets the font to the specified Font and then regenerates the layout using Font.regenerateLayout(Layout).
void	setFont(Font font, boolean regenerate) Just like setFont(Font), except this only regenerates the layout if regenerate is true.
void	setSize(float width, float height)
void	setText(java.lang.String markupText) Changes the text in this TextraLabel to the given String, parsing any markup in it.
TextraLabel	setWrap(boolean wrap) Sets the wrapping mode; if this changes the mode, then this invalidates the hierarchy.
void	skipToTheEnd() By default, does nothing; this is overridden in TypingLabel to skip its text progression ahead.
TextraLabel	useIntegerPositions(boolean integer)

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

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

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

act, addAction, addCaptureListener, addListener, ancestorsVisible, ascendantsVisible, 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, hasKeyboardFocus, hasParent, hasScrollFocus, hit, isAscendantOf, isDescendantOf, isTouchable, isTouchFocusListener, isTouchFocusTarget, isVisible, localToActorCoordinates, localToAscendantCoordinates, localToParentCoordinates, localToScreenCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, positionChanged, remove, removeAction, removeCaptureListener, removeListener, rotateBy, rotationChanged, scaleBy, scaleBy, scaleChanged, screenToLocalCoordinates, setBounds, setColor, setColor, setDebug, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setStage, setTouchable, setUserObject, setVisible, setWidth, setX, setX, setY, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront, toString

Methods inherited from class java.lang.Object

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

Field Detail

layout

public Layout layout

font

protected Font font

align

public int align

wrap

public boolean wrap

storedText

public java.lang.String storedText

style

public com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle style

Constructor Detail

TextraLabel

public TextraLabel()

Creates a TextraLabel that uses the default libGDX font (lsans-15 in the current version) with white color.

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin)

Creates a TextraLabel with the given text (which may be multi-line) and using the specified Skin's LabelStyle.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

skin - the default Label.LabelStyle will be obtained from this and used

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
                   boolean makeGridGlyphs)

Creates a TextraLabel with the given text (which may be multi-line) and using the specified Skin's LabelStyle.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

skin - the default Label.LabelStyle will be obtained from this and used

makeGridGlyphs - if true, the font should have a solid block glyph available, and underline/strikethrough may be drawn more clearly; if false, underline/strikethrough will use underscore/dash

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
                   java.lang.String styleName)

Creates a TextraLabel with the given text (which may be multi-line) and using the specified style from the given Skin.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

skin - the named Label.LabelStyle will be obtained from this and used

styleName - the name of a Label.LabelStyle to use from the Skin

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
                   java.lang.String styleName,
                   boolean makeGridGlyphs)

Creates a TextraLabel with the given text (which may be multi-line) and using the specified style from the given Skin.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

skin - the named Label.LabelStyle will be obtained from this and used

styleName - the name of a Label.LabelStyle to use from the Skin

makeGridGlyphs - if true, the font should have a solid block glyph available, and underline/strikethrough may be drawn more clearly; if false, underline/strikethrough will use underscore/dash

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
                   java.lang.String styleName,
                   com.badlogic.gdx.graphics.Color color)

Creates a TextraLabel with the given text (which may be multi-line), using the specified style from the given Skin, with the default Color overridden by the given one.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

skin - the named Label.LabelStyle will be obtained from this and used

styleName - the name of a Label.LabelStyle to use from the Skin

color - the color to use for the font when unspecified (at the start and when reset)

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
                   java.lang.String styleName,
                   java.lang.String colorName)

Creates a TextraLabel with the given text (which may be multi-line), using the specified style from the given Skin, with the default Color overridden by the color with the given name in the skin.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

skin - the named Label.LabelStyle will be obtained from this and used

styleName - the name of a Label.LabelStyle to use from the Skin

colorName - the name in the skin of the color to use for the font when unspecified (at the start and when reset)

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle style)

Creates a TextraLabel with the given text (which may be multi-line) and using the given style.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

style - the Label.LabelStyle to use

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle style,
                   boolean makeGridGlyphs)

Creates a TextraLabel with the given text (which may be multi-line) and using the given style.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

style - the Label.LabelStyle to use

makeGridGlyphs - if true, the font should have a solid block glyph available, and underline/strikethrough may be drawn more clearly; if false, underline/strikethrough will use underscore/dash

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
                   Font replacementFont)

Creates a TextraLabel with the given text (which may be multi-line) and using the default style from a Skin, replacing any font that would be drawn from the style with replacementFont.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

skin - the default Label.LabelStyle will be obtained from this and used

replacementFont - a Font that will be used in place of the one in style

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
                   java.lang.String styleName,
                   Font replacementFont)

Creates a TextraLabel with the given text (which may be multi-line) and using the given style taken by name from a Skin, replacing any font that would be drawn from the style with replacementFont.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

skin - the named Label.LabelStyle will be obtained from this and used

styleName - the name of a Label.LabelStyle to use from the Skin

replacementFont - a Font that will be used in place of the one in style

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
                   java.lang.String styleName,
                   Font replacementFont,
                   com.badlogic.gdx.graphics.Color color)

Creates a TextraLabel with the given text (which may be multi-line) and using the given style taken by name from a Skin, replacing any font that would be drawn from the style with replacementFont.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

skin - the named Label.LabelStyle will be obtained from this and used

styleName - the name of a Label.LabelStyle to use from the Skin

replacementFont - a Font that will be used in place of the one in style

color - the base color to use for the label, used when reset

TextraLabel

public TextraLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle style,
                   Font replacementFont)

Creates a TextraLabel with the given text (which may be multi-line) and using the given style.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

style - the Label.LabelStyle to use, except for its font

replacementFont - a Font that will be used in place of the one in style

TextraLabel

public TextraLabel(java.lang.String text,
                   Font font)

Creates a TextraLabel with the given text (which may be multi-line) and using the given Font.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

font - a Font from this library, such as one obtained from KnownFonts

TextraLabel

public TextraLabel(java.lang.String text,
                   Font font,
                   com.badlogic.gdx.graphics.Color color)

Creates a TextraLabel with the given text (which may be multi-line), using the given Font, and using the given default color.

Parameters:

text - the text to use; may be multi-line, but will default to not wrapping

font - a Font from this library, such as one obtained from KnownFonts

color - the color to use for the font when unspecified (at the start and when reset)

Method Detail

draw

public void draw(com.badlogic.gdx.graphics.g2d.Batch batch,
                 float parentAlpha)

Overrides:

draw in class com.badlogic.gdx.scenes.scene2d.ui.Widget

getPrefWidth

public float getPrefWidth()

Specified by:

getPrefWidth in interface com.badlogic.gdx.scenes.scene2d.utils.Layout

Overrides:

getPrefWidth in class com.badlogic.gdx.scenes.scene2d.ui.Widget

getPrefHeight

public float getPrefHeight()

Specified by:

getPrefHeight in interface com.badlogic.gdx.scenes.scene2d.utils.Layout

Overrides:

getPrefHeight in class com.badlogic.gdx.scenes.scene2d.ui.Widget

useIntegerPositions

public TextraLabel useIntegerPositions(boolean integer)

isWrap

public boolean isWrap()

Gets the current wrapping mode. When wrap is enabled, the preferred and/or min/max sizes must be used so this knows where to wrap. If wrap is disabled, lines that are too wide will just widen the size of the widget.

Returns:

whether this is currently wrapping

setWrap

public TextraLabel setWrap(boolean wrap)

Sets the wrapping mode; if this changes the mode, then this invalidates the hierarchy. When wrap is enabled, the preferred and/or min/max sizes must be used so this knows where to wrap. If wrap is disabled, lines that are too wide will just widen the size of the widget.

Parameters:

wrap - whether to wrap or not

setSize

public void setSize(float width,
                    float height)

Overrides:

setSize in class com.badlogic.gdx.scenes.scene2d.Actor

layout

public void layout()

Specified by:

layout in interface com.badlogic.gdx.scenes.scene2d.utils.Layout

Overrides:

layout in class com.badlogic.gdx.scenes.scene2d.ui.Widget

getAlignment

public int getAlignment()

Gets the alignment for the text in this TextraLabel. This is a constant in Align.

Returns:

the alignment used by this TextraLabel, as a constant from Align

See Also:

Align

setAlignment

public void setAlignment(int alignment)

Sets the alignment for the text in this TextraLabel.

Parameters:

alignment - a constant from Align

See Also:

Align

getFont

public Font getFont()

setFont

public void setFont(Font font)

Sets the font to the specified Font and then regenerates the layout using Font.regenerateLayout(Layout). This is equivalent to calling setFont(Font, boolean) with true for regenerate. This won't regenerate the layout if the given font is equal to the current font for this TextraLabel.

Parameters:

font - the non-null font to use for this TextraLabel

setFont

public void setFont(Font font,
                    boolean regenerate)

Just like setFont(Font), except this only regenerates the layout if regenerate is true. (To contrast, setFont(Font) always regenerates the layout.) This won't regenerate the layout if the given font is equal to the current font for this TextraLabel.

Parameters:

font - the non-null font to use for this TextraLabel

regenerate - if true, the layout will be re-wrapped and its size re-calculated for the new font

setText

public void setText(java.lang.String markupText)

Changes the text in this TextraLabel to the given String, parsing any markup in it.

Parameters:

markupText - a String that can contain Font markup

skipToTheEnd

public void skipToTheEnd()

By default, does nothing; this is overridden in TypingLabel to skip its text progression ahead.