com.simsilica.lemur.component

Class TextComponent

java.lang.Object

com.simsilica.lemur.component.AbstractGuiComponent

com.simsilica.lemur.component.TextComponent

All Implemented Interfaces:

ColoredComponent, GuiComponent

public class TextComponent
extends AbstractGuiComponent
implements ColoredComponent

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

Constructor Summary

Constructors

Constructor and Description
TextComponent(java.lang.String text, com.jme3.font.BitmapFont font)

Method Summary

Modifier and Type	Method and Description
void	attach(GuiControl parent)
void	calculatePreferredSize(com.jme3.math.Vector3f size)
TextComponent	clone()
TextComponent	color(com.jme3.math.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.
com.jme3.math.ColorRGBA	getColor() Returns the current color of this component.
com.jme3.font.BitmapFont	getFont()
float	getFontSize()
HAlignment	getHAlignment()
int	getLayer()
float	getMaxWidth()
com.jme3.math.Vector3f	getOffset()
java.lang.String	getText()
float	getTextSize()
VAlignment	getVAlignment()
TextComponent	offset(float x, float y, float z)
protected void	resetAlignment()
protected void	resetLayer()
void	reshape(com.jme3.math.Vector3f pos, com.jme3.math.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(com.jme3.math.ColorRGBA color) Sets the color for this component.
void	setFont(com.jme3.font.BitmapFont font)
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(com.jme3.math.Vector3f offset)
void	setText(java.lang.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

Constructor Detail

TextComponent

public TextComponent(java.lang.String text,
                     com.jme3.font.BitmapFont font)

Method Detail

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(java.lang.String text)

getText

public java.lang.String getText()

setLayer

public void setLayer(int layer)

getLayer

public int getLayer()

setHAlignment

public void setHAlignment(HAlignment a)

getHAlignment

public HAlignment getHAlignment()

setVAlignment

public void setVAlignment(VAlignment a)

getVAlignment

public VAlignment getVAlignment()

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.

getMaxWidth

public float getMaxWidth()

setFont

public void setFont(com.jme3.font.BitmapFont font)

getFont

public com.jme3.font.BitmapFont getFont()

setFontSize

public void setFontSize(float size)

getFontSize

public float getFontSize()

setColor

public void setColor(com.jme3.math.ColorRGBA color)

Description copied from interface: ColoredComponent

Sets the color for this component.

Specified by:

setColor in interface ColoredComponent

getColor

public com.jme3.math.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(com.jme3.math.ColorRGBA color)

offset

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

setOffset

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

setOffset

public void setOffset(com.jme3.math.Vector3f offset)

getOffset

public com.jme3.math.Vector3f getOffset()

setTextSize

public void setTextSize(float f)

getTextSize

public float getTextSize()

reshape

public void reshape(com.jme3.math.Vector3f pos,
                    com.jme3.math.Vector3f size)

Specified by:

reshape in interface GuiComponent

calculatePreferredSize

public void calculatePreferredSize(com.jme3.math.Vector3f size)

Specified by:

calculatePreferredSize in interface GuiComponent

resetAlignment

protected void resetAlignment()

resetLayer

protected void resetLayer()