Package com.ardor3d.extension.ui

Class UIProgressBar

java.lang.Object

com.ardor3d.scenegraph.Spatial

com.ardor3d.scenegraph.Node

com.ardor3d.extension.ui.UIComponent

com.ardor3d.extension.ui.UIContainer

com.ardor3d.extension.ui.UIPanel

com.ardor3d.extension.ui.UIProgressBar

All Implemented Interfaces:

UIKeyHandler, Hintable, Savable

public class UIProgressBar
extends UIPanel

This component shows progress as "percent complete" via a proportionally sized bar and an optional text label.

Field Summary

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

_textureRenderer, STANDIN_TEXTURE_SIZE

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
UIProgressBar()	Construct a new, horizontal progress bar.
UIProgressBar(String labelText, boolean horizontal)	Construct a new progress bar with the given attributes.

Method Summary

Modifier and Type	Method	Description
UIPanel	getBar()
UILabel	getBarLabel()
UIPanel	getMainPanel()
double	getPercentFilled()
UILabel	getTextLabel()
boolean	isHorizontal()
void	layout()	Override this to perform actual layout.
void	setBarText(String text)
void	setHorizontal(boolean horizontal)	Takes affect on next call to layout()
void	setLabelText(String text)
void	setPercentFilled(double value)	Triggers layout if value is not same as current value.

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

add, attachedToHud, clearStandin, contains, contains, detachAllChildren, detachedFromHud, draw, drawComponent, fireComponentDirty, fireStyleChanged, getLayout, getMinificationFilter, getUIComponent, isDirty, isDoClip, isDrawingStandin, isUseStandin, remove, removeAllComponents, setDirty, setDoClip, setLayout, setMinificationFilter, setUseStandin, updateMinimumSizeFromContents

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

addFontStyle, applySkin, cancelTooltipTimer, centerOn, centerOn, clearFontStyle, clearMaximumContentSize, clearMinimumContentSize, compact, fitComponentIn, gainedFocus, getBackdrop, getBorder, getCombinedOpacity, getContentHeight, getContentWidth, getCurrentOpacity, getDefaultFontFamily, getDefaultFontSize, getDefaultFontStyles, getFontStyles, getForegroundColor, getHud, getHudX, getHudY, 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, hasVirginContentArea, insideMargin, isAttachedToHUD, isConsumeKeyEvents, isConsumeMouseEvents, isEnabled, isUseTransparency, isVisible, keyHeld, keyPressed, keyReleased, 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, updateWorldTransform, updateWorldTransform, validateContentSize

Methods inherited from class com.ardor3d.scenegraph.Node

acceptVisitor, attachChild, attachChildAt, 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

Constructor Details

UIProgressBar

public UIProgressBar()

Construct a new, horizontal progress bar.

UIProgressBar

public UIProgressBar(String labelText,
 boolean horizontal)

Construct a new progress bar with the given attributes.

Parameters:

labelText - text to show next to the progress bar

horizontal - true for horizontal bar, false for vertical.

Method Details

layout

public void layout()

Description copied from class: UIComponent

Override this to perform actual layout.

Overrides:

layout in class UIContainer

isHorizontal

public boolean isHorizontal()

setHorizontal

public void setHorizontal(boolean horizontal)

Takes affect on next call to layout()

Parameters:

horizontal - true for horizontal bar, false for vertical.

getPercentFilled

public double getPercentFilled()

setPercentFilled

public void setPercentFilled(double value)

Triggers layout if value is not same as current value.

Parameters:

value - the value

setLabelText

public void setLabelText(String text)

setBarText

public void setBarText(String text)

getBar

public UIPanel getBar()

getTextLabel

public UILabel getTextLabel()

getBarLabel

public UILabel getBarLabel()

getMainPanel

public UIPanel getMainPanel()