Package com.ardor3d.extension.ui

Class LabelState

java.lang.Object

com.ardor3d.scenegraph.Spatial

com.ardor3d.scenegraph.Node

com.ardor3d.extension.ui.UIComponent

com.ardor3d.extension.ui.UIState

com.ardor3d.extension.ui.LabelState

All Implemented Interfaces:

UIKeyHandler, Hintable, Savable

public class LabelState
extends UIState

A state useful for maintaining and setting label properties such as text, icon, gap, and alignment.

Field Summary

Fields

Modifier and Type	Field	Description
protected Alignment	_alignment	Alignment to set on component, or null if to leave unchanged.
protected Integer	_gap	Gap to set on component, or null if to leave unchanged.
protected SubTex	_icon	Icon to set on component, or null if to leave unchanged.
protected Dimension	_iconDimensions	Icon size to set on component, or null if to leave unchanged.
protected Boolean	_styled	If true, our text could be marked up with style information - null to leave unchanged.
protected String	_text	Text to set on component, or null if to leave unchanged.

Fields inherited from class com.ardor3d.extension.ui.UIComponent

_tooltipPopTime, _tooltipText, DEFAULT_FOREGROUND_COLOR

Fields inherited from class com.ardor3d.scenegraph.Node

_children

Fields inherited from class com.ardor3d.scenegraph.Spatial

_controllers, _delegateMap, _dirtyMark, _frustumIntersects, _listener, _localTransform, _name, _parent, _queueDistance, _renderStateList, _sceneHints, _userData, _worldBound, _worldTransform, ON_DIRTY_ATTACHED, ON_DIRTY_BOUNDING, ON_DIRTY_RENDERSTATE, ON_DIRTY_TRANSFORM, ON_DIRTY_TRANSFORM_ONLY

Constructor Summary

Constructors

Constructor	Description
LabelState()

Method Summary

Modifier and Type	Method	Description
Alignment	getAlignment()
Integer	getGap()
SubTex	getIcon()
Dimension	getIconDimensions()
String	getText()
Boolean	isStyledText()
void	setAlignment(Alignment align)
void	setGap(int gap)
void	setIcon(SubTex icon)
void	setIconDimensions(Dimension iconDimensions)
void	setStyledText(Boolean value)
void	setText(String text)
void	setupAppearance(UIComponent component)	Applies the local characteristics of this state to the given UIComponent.

Methods inherited from class com.ardor3d.extension.ui.UIState

getHudX, getHudY, release

Methods inherited from class com.ardor3d.extension.ui.UIComponent

addFontStyle, applySkin, attachedToHud, cancelTooltipTimer, centerOn, centerOn, clearFontStyle, clearMaximumContentSize, clearMinimumContentSize, compact, detachedFromHud, draw, drawComponent, fireComponentDirty, fireStyleChanged, fitComponentIn, gainedFocus, getBackdrop, getBorder, getCombinedOpacity, getContentHeight, getContentWidth, getCurrentOpacity, getDefaultFontFamily, getDefaultFontSize, getDefaultFontStyles, getFontStyles, getForegroundColor, getHud, getKeyFocusTarget, getLayoutData, getLocalComponentHeight, getLocalComponentWidth, getLocalFontStyles, getLocalForegroundColor, getLocalOpacity, getLocalX, getLocalY, getMargin, getMaximumContentHeight, getMaximumContentWidth, getMaximumLocalComponentHeight, getMaximumLocalComponentWidth, getMinimumContentHeight, getMinimumContentWidth, getMinimumLocalComponentHeight, getMinimumLocalComponentWidth, getPadding, getRelativeComponentBounds, getRelativeMaxComponentBounds, getRelativeMinComponentBounds, getTooltipPopTime, getTooltipText, getTopLevelComponent, getTotalBottom, getTotalLeft, getTotalRight, getTotalTop, getUIComponent, hasVirginContentArea, insideMargin, isAttachedToHUD, isConsumeKeyEvents, isConsumeMouseEvents, isEnabled, isUseTransparency, isVisible, keyHeld, keyPressed, keyReleased, layout, lostFocus, mouseClicked, mouseDeparted, mouseEntered, mouseMoved, mousePressed, mouseReleased, mouseWheel, pack, postdrawComponent, predrawComponent, requestFocus, setBackdrop, setBorder, setConsumeKeyEvents, setConsumeMouseEvents, setContentHeight, setContentSize, setContentWidth, setDefaultFontFamily, setDefaultFontSize, setDefaultFontStyles, setEnabled, setFontStyles, setForegroundColor, setHudX, setHudXY, setHudY, setKeyFocusTarget, setLayoutData, setLayoutMinimumContentSize, setLocalComponentHeight, setLocalComponentSize, setLocalComponentWidth, setLocalX, setLocalXY, setLocalY, setMargin, setMaximumContentHeight, setMaximumContentSize, setMaximumContentWidth, setMinimumContentHeight, setMinimumContentSize, setMinimumContentWidth, setOpacity, setPadding, setTooltipPopTime, setTooltipText, setUseTransparency, setVirginContentArea, setVisible, updateMinimumSizeFromContents, updateWorldTransform, updateWorldTransform, validateContentSize

Methods inherited from class com.ardor3d.scenegraph.Node

acceptVisitor, attachChild, attachChildAt, detachAllChildren, detachChild, detachChildAt, detachChildNamed, getChild, getChild, getChildIndex, getChildren, getClassTag, getNumberOfChildren, hasChild, makeCopy, makeInstanced, propagateDirtyDown, read, sortLights, swapChildren, updateChildren, updateWorldBound, updateWorldRenderStates, write

Methods inherited from class com.ardor3d.scenegraph.Spatial

addController, addTranslation, addTranslation, applyWorldRenderStates, clearControllers, clearDirty, clearDirty, clearRenderState, getController, getControllerCount, getControllers, getCurrentRenderDelegate, getLastFrustumIntersection, getListener, getLocalLastFrustumIntersection, getLocalRenderState, getLocalRenderStates, getName, getParent, getParentHintable, getRenderDelegate, getRotation, getScale, getSceneHints, getTransform, getTranslation, getUserData, getWorldBound, getWorldRotation, getWorldScale, getWorldTransform, getWorldTranslation, hasAncestor, isDirty, localToWorld, markDirty, markDirty, onDraw, propagateBoundToRoot, propagateDirtyUp, propagateStatesFromRoot, propageEventUp, removeController, removeController, removeFromParent, setLastFrustumIntersection, setListener, setName, setParent, setRenderDelegate, setRenderState, setRotation, setRotation, setScale, setScale, setScale, setTransform, setTranslation, setTranslation, setUserData, setWorldRotation, setWorldRotation, setWorldScale, setWorldScale, setWorldScale, setWorldTransform, setWorldTranslation, setWorldTranslation, toString, updateControllers, updateGeometricState, updateGeometricState, updateWorldRenderStates, worldToLocal

Methods inherited from class java.lang.Object

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

Field Details

_text

protected String _text

Text to set on component, or null if to leave unchanged.

_icon

protected SubTex _icon

Icon to set on component, or null if to leave unchanged.

_iconDimensions

protected Dimension _iconDimensions

Icon size to set on component, or null if to leave unchanged.

_alignment

protected Alignment _alignment

Alignment to set on component, or null if to leave unchanged.

_gap

protected Integer _gap

Gap to set on component, or null if to leave unchanged.

_styled

protected Boolean _styled

If true, our text could be marked up with style information - null to leave unchanged.

Constructor Details

LabelState

public LabelState()

Method Details

setupAppearance

public void setupAppearance(UIComponent component)

Description copied from class: UIState

Applies the local characteristics of this state to the given UIComponent.

Overrides:

setupAppearance in class UIState

Parameters:

component - the UI component to apply this state to

getAlignment

public Alignment getAlignment()

setAlignment

public void setAlignment(Alignment align)

getGap

public Integer getGap()

setGap

public void setGap(int gap)

getIcon

public SubTex getIcon()

setIcon

public void setIcon(SubTex icon)

getIconDimensions

public Dimension getIconDimensions()

setIconDimensions

public void setIconDimensions(Dimension iconDimensions)

getText

public String getText()

setText

public void setText(String text)

isStyledText

public Boolean isStyledText()

setStyledText

public void setStyledText(Boolean value)