Package com.simsilica.lemur

Class Label

java.lang.Object

com.jme3.scene.Spatial

com.jme3.scene.Node

com.simsilica.lemur.Panel

com.simsilica.lemur.Label

All Implemented Interfaces:

HasLocalTransform, CloneableSmartAsset, Collidable, Savable, JmeCloneable, Cloneable

Direct Known Subclasses:

Button, NLabel

public class Label
extends Panel

A standard GUI element for displaying text with an optional shadow.

Nested Class Summary

Nested classes/interfaces inherited from class com.jme3.scene.Spatial

Spatial.BatchHint, Spatial.CullHint, Spatial.DFSMode

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELEMENT_ID
static final String	LAYER_ICON
static final String	LAYER_SHADOW_TEXT
static final String	LAYER_TEXT

Fields inherited from class com.simsilica.lemur.Panel

EFFECT_CLOSE, EFFECT_OPEN, LAYER_BACKGROUND, LAYER_BORDER, LAYER_INSETS

Fields inherited from class com.jme3.scene.Node

children

Fields inherited from class com.jme3.scene.Spatial

batchHint, controls, cullHint, frustrumIntersects, key, localLights, localOverrides, localTransform, name, parent, queueBucket, queueDistance, refreshFlags, RF_BOUND, RF_CHILD_LIGHTLIST, RF_GLOBAL_LIGHTS, RF_LIGHTLIST, RF_MATPARAM_OVERRIDE, RF_TRANSFORM, shadowMode, userData, worldBound, worldLights, worldOverrides, worldTransform

Constructor Summary

Constructors

Modifier	Constructor	Description
	Label(String s)
protected	Label(String s, boolean applyStyles, ElementId elementId, String style)
	Label(String s, ElementId elementId)
	Label(String s, ElementId elementId, String style)
	Label(String s, String style)

Method Summary

Modifier and Type	Method	Description
protected Text2d	createText2d(ElementId elementId, String style)	Utility method to encapsulate the font shell game that we play for backwards compatibility.
ColorRGBA	getColor()
BitmapFont	getFont()
String	getFontName()
float	getFontSize()
GuiComponent	getIcon()
float	getMaxWidth()
ColorRGBA	getShadowColor()
Vector3f	getShadowOffset()
String	getText()
HAlignment	getTextHAlignment()
VAlignment	getTextVAlignment()
void	setColor(ColorRGBA color)
void	setFont(BitmapFont font)
void	setFontName(String fontName)
void	setFontSize(float f)
void	setIcon(GuiComponent icon)
void	setMaxWidth(float f)	Sets the maximum width of the label.
void	setShadowColor(ColorRGBA color)
void	setShadowOffset(Vector3f offset)
void	setText(String s)
void	setTextHAlignment(HAlignment a)
void	setTextVAlignment(VAlignment a)
String	toString()	Returns the Spatial's name followed by the class of the spatial Example: "MyNode (com.jme3.scene.Spatial)"

Methods inherited from class com.simsilica.lemur.Panel

addEffect, addMouseListener, getAlpha, getBackground, getBorder, getEffectControl, getEffects, getElementId, getInsets, getInsetsComponent, getPreferredSize, getSize, getStyle, hasEffect, removeEffect, removeMouseListener, runEffect, setAlpha, setAlpha, setBackground, setBorder, setChildAlpha, setEffects, setInsets, setInsetsComponent, setPreferredSize, setSize

Methods inherited from class com.jme3.scene.Node

attachChild, attachChildAt, breadthFirstTraversal, clone, cloneFields, collideWith, deepClone, depthFirstTraversal, descendantMatches, descendantMatches, descendantMatches, detachAllChildren, detachChild, detachChildAt, detachChildNamed, getChild, getChild, getChildIndex, getChildren, getQuantity, getTriangleCount, getVertexCount, hasChild, oldDeepClone, read, setLightListRefresh, setLodLevel, setMaterial, setMatParamOverrideRefresh, setModelBound, setParent, setTransformRefresh, swapChildren, updateGeometricState, updateLogicalState, updateModelBound, updateWorldBound, write

Methods inherited from class com.jme3.scene.Spatial

addControl, addControlAt, addLight, addMatParamOverride, breadthFirstTraversal, center, checkCulling, clearMatParamOverrides, clone, depthFirstTraversal, forceRefresh, getBatchHint, getControl, getControl, getCullHint, getKey, getLastFrustumIntersection, getLocalBatchHint, getLocalCullHint, getLocalLightList, getLocalMatParamOverrides, getLocalQueueBucket, getLocalRotation, getLocalScale, getLocalShadowMode, getLocalToWorldMatrix, getLocalTransform, getLocalTranslation, getName, getNumControls, getParent, getQueueBucket, getShadowMode, getUserData, getUserDataKeys, getWorldBound, getWorldLightList, getWorldMatParamOverrides, getWorldRotation, getWorldScale, getWorldTransform, getWorldTranslation, hasAncestor, hasGlobalLights, jmeClone, localToWorld, lookAt, matches, move, move, oldClone, removeControl, removeControl, removeFromParent, removeLight, removeMatParamOverride, rotate, rotate, rotateUpTo, runControlRender, scale, scale, setBatchHint, setBoundRefresh, setCullHint, setKey, setLastFrustumIntersection, setLocalRotation, setLocalRotation, setLocalScale, setLocalScale, setLocalScale, setLocalTransform, setLocalTranslation, setLocalTranslation, setName, setQueueBucket, setRequiresUpdates, setShadowMode, setUserData, updateMatParamOverrides, updateWorldLightList, updateWorldTransforms, worldToLocal

Methods inherited from class java.lang.Object

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

Field Details

ELEMENT_ID

public static final String ELEMENT_ID

See Also:

• Constant Field Values

LAYER_ICON

public static final String LAYER_ICON

See Also:

• Constant Field Values

LAYER_TEXT

public static final String LAYER_TEXT

See Also:

• Constant Field Values

LAYER_SHADOW_TEXT

public static final String LAYER_SHADOW_TEXT

See Also:

• Constant Field Values

Constructor Details

Label

public Label(String s)

Label

public Label(String s,
 String style)

Label

public Label(String s,
 ElementId elementId)

Label

public Label(String s,
 ElementId elementId,
 String style)

Label

protected Label(String s,
 boolean applyStyles,
 ElementId elementId,
 String style)

Method Details

createText2d

protected Text2d createText2d(ElementId elementId,
 String style)

Utility method to encapsulate the font shell game that we play for backwards compatibility. If a Label has overridden the default fontName somewhere in its style hierarchy then that will always be used here. Otherwise, the bitmap "font" styling is checked. If that is different than the default 'font' style then it is used. If the local 'font' style is the same as the default 'font' style then the font name is used, regardless of if it was overridden or not. In this way, any existing style hierarchies should continue to work with actual BitmapFonts will also seemlessly supporting 'fontName' styles. 'fontName' is preferred going forward because it better supports overriding Text2d implementations.

setText

@StyleAttribute(value="text",
                lookupDefault=false)
public void setText(String s)

getText

public String getText()

setTextVAlignment

@StyleAttribute(value="textVAlignment",
                lookupDefault=false)
public void setTextVAlignment(VAlignment a)

getTextVAlignment

public VAlignment getTextVAlignment()

setTextHAlignment

@StyleAttribute(value="textHAlignment",
                lookupDefault=false)
public void setTextHAlignment(HAlignment a)

getTextHAlignment

public HAlignment getTextHAlignment()

setMaxWidth

@StyleAttribute(value="maxWidth",
                lookupDefault=false)
public void setMaxWidth(float f)

Sets the maximum width of the label. If the text is longer than this width then it will be wrapped and the label will grow vertically (in a way that the layout's can use for proper positioning).

getMaxWidth

public float getMaxWidth()

setFont

public void setFont(BitmapFont font)

getFont

public BitmapFont getFont()

setFontName

@StyleAttribute("fontName")
public void setFontName(String fontName)

getFontName

public String getFontName()

setColor

@StyleAttribute("color")
public void setColor(ColorRGBA color)

getColor

public ColorRGBA getColor()

setFontSize

@StyleAttribute("fontSize")
public void setFontSize(float f)

getFontSize

public float getFontSize()

setShadowOffset

@StyleAttribute("shadowOffset")
public void setShadowOffset(Vector3f offset)

getShadowOffset

public Vector3f getShadowOffset()

setShadowColor

@StyleAttribute(value="shadowColor",
                lookupDefault=false)
public void setShadowColor(ColorRGBA color)

getShadowColor

public ColorRGBA getShadowColor()

setIcon

@StyleAttribute(value="icon",
                lookupDefault=false)
public void setIcon(GuiComponent icon)

getIcon

public GuiComponent getIcon()

toString

public String toString()

Description copied from class: Spatial

Returns the Spatial's name followed by the class of the spatial
Example: "MyNode (com.jme3.scene.Spatial)"

Overrides:

toString in class Panel

Returns:

Spatial's name followed by the class of the Spatial