Package com.simsilica.lemur.component

Class TextComponent

java.lang.Object

com.simsilica.lemur.component.AbstractGuiComponent

com.simsilica.lemur.component.TextComponent

All Implemented Interfaces:

ColoredComponent, Text2d, GuiComponent

public class TextComponent
extends AbstractGuiComponent
implements ColoredComponent, Text2d

A component that renders a text string with a particular alignment and offset.

Constructor Summary

Constructors

Constructor	Description
TextComponent(String text, BitmapFont font)

Method Summary

Modifier and Type	Method	Description
void	attach(GuiControl parent)
void	calculatePreferredSize(Vector3f size)
TextComponent	clone()
TextComponent	color(ColorRGBA color)
void	detach(GuiControl parent)
float	getAlpha()	Returns the current alpha multiplier that is applied to the color when set to the actual visuals.
ColorRGBA	getColor()	Returns the current color of this component.
BitmapFont	getFont()
String	getFontName()
float	getFontSize()
HAlignment	getHAlignment()
int	getLayer()
float	getMaxWidth()
Vector3f	getOffset()
String	getText()
float	getTextSize()
VAlignment	getVAlignment()
TextComponent	offset(float x, float y, float z)
protected void	resetAlignment()
protected void	resetLayer()
void	reshape(Vector3f pos, Vector3f size)
void	setAlpha(float f)	Sets an alpha multiplier that will be applied to the color when set to the actual visuals.
void	setColor(ColorRGBA color)	Sets the color for this component.
void	setFont(BitmapFont font)
void	setFontName(String fontName)
void	setFontSize(float size)
void	setHAlignment(HAlignment a)
void	setLayer(int layer)
void	setMaxWidth(float f)	For values greater than 0, this will constrain the maximum width of the text box.
void	setOffset(float x, float y, float z)
void	setOffset(Vector3f offset)
void	setText(String text)
void	setTextSize(float f)
void	setVAlignment(VAlignment a)

Methods inherited from class com.simsilica.lemur.component.AbstractGuiComponent

getGuiControl, getNode, invalidate, isAttached

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.simsilica.lemur.core.GuiComponent

getGuiControl, isAttached

Constructor Details

TextComponent

public TextComponent(String text,
 BitmapFont font)

Method Details

clone

public TextComponent clone()

Specified by:

clone in interface GuiComponent

Overrides:

clone in class AbstractGuiComponent

attach

public void attach(GuiControl parent)

Specified by:

attach in interface GuiComponent

Overrides:

attach in class AbstractGuiComponent

detach

public void detach(GuiControl parent)

Specified by:

detach in interface GuiComponent

Overrides:

detach in class AbstractGuiComponent

setText

public void setText(String text)

Specified by:

setText in interface Text2d

getText

public String getText()

Specified by:

getText in interface Text2d

setLayer

public void setLayer(int layer)

Specified by:

setLayer in interface Text2d

getLayer

public int getLayer()

Specified by:

getLayer in interface Text2d

setHAlignment

public void setHAlignment(HAlignment a)

Specified by:

setHAlignment in interface Text2d

getHAlignment

public HAlignment getHAlignment()

Specified by:

getHAlignment in interface Text2d

setVAlignment

public void setVAlignment(VAlignment a)

Specified by:

setVAlignment in interface Text2d

getVAlignment

public VAlignment getVAlignment()

Specified by:

getVAlignment in interface Text2d

setMaxWidth

public void setMaxWidth(float f)

For values greater than 0, this will constrain the maximum width of the text box. Wrapping text will cause the text box to grow vertically.

Specified by:

setMaxWidth in interface Text2d

getMaxWidth

public float getMaxWidth()

Specified by:

getMaxWidth in interface Text2d

setFont

public void setFont(BitmapFont font)

getFont

public BitmapFont getFont()

setFontName

public void setFontName(String fontName)

Specified by:

setFontName in interface Text2d

getFontName

public String getFontName()

Specified by:

getFontName in interface Text2d

setFontSize

public void setFontSize(float size)

Specified by:

setFontSize in interface Text2d

getFontSize

public float getFontSize()

Specified by:

getFontSize in interface Text2d

setColor

public void setColor(ColorRGBA color)

Description copied from interface: ColoredComponent

Sets the color for this component.

Specified by:

setColor in interface ColoredComponent

getColor

public ColorRGBA getColor()

Description copied from interface: ColoredComponent

Returns the current color of this component.

Specified by:

getColor in interface ColoredComponent

setAlpha

public void setAlpha(float f)

Description copied from interface: ColoredComponent

Sets an alpha multiplier that will be applied to the color when set to the actual visuals.

Specified by:

setAlpha in interface ColoredComponent

getAlpha

public float getAlpha()

Description copied from interface: ColoredComponent

Returns the current alpha multiplier that is applied to the color when set to the actual visuals.

Specified by:

getAlpha in interface ColoredComponent

color

public TextComponent color(ColorRGBA color)

offset

public TextComponent offset(float x,
 float y,
 float z)

setOffset

public void setOffset(float x,
 float y,
 float z)

Specified by:

setOffset in interface Text2d

setOffset

public void setOffset(Vector3f offset)

Specified by:

setOffset in interface Text2d

getOffset

public Vector3f getOffset()

Specified by:

getOffset in interface Text2d

setTextSize

public void setTextSize(float f)

getTextSize

public float getTextSize()

reshape

public void reshape(Vector3f pos,
 Vector3f size)

Specified by:

reshape in interface GuiComponent

calculatePreferredSize

public void calculatePreferredSize(Vector3f size)

Specified by:

calculatePreferredSize in interface GuiComponent

resetAlignment

protected void resetAlignment()

resetLayer

protected void resetLayer()