Package com.simsilica.lemur

Class ProgressBar

java.lang.Object

com.jme3.scene.Spatial

com.jme3.scene.Node

com.simsilica.lemur.Panel

com.simsilica.lemur.ProgressBar

All Implemented Interfaces:

HasLocalTransform, CloneableSmartAsset, Collidable, Savable, JmeCloneable, Cloneable

public class ProgressBar
extends Panel

A horizontal progress indicator supporting an optional text overlay. This is a composite component where an indicator panel overlays the base panel.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ProgressBar.ResizeListener

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	CONTAINER_ID
static final String	ELEMENT_ID
static final String	LABEL_ID
static final String	VALUE_ID

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
	ProgressBar()
	ProgressBar(RangedValueModel model)
protected	ProgressBar(RangedValueModel model, boolean applyStyles, ElementId elementId, String style)
	ProgressBar(RangedValueModel model, String style)
	ProgressBar(ElementId elementId, String style)
	ProgressBar(String style)

Method Summary

Modifier and Type	Method	Description
Label	getLabel()	Returns the GUI element that is used for the main progress bar area and overlay label.
String	getMessage()	Returns the message text that currently appears in the progress bar text overlay.
RangedValueModel	getModel()	Returns the current range model for this progress bar.
double	getProgressPercent()	Returns the current progress value as a percentage (0-1.0) of the current range.
double	getProgressValue()	Returns the raw progress value.
Panel	getValueIndicator()	Returns the GUI element that is used for the value indicator.
protected void	resetStateView()
void	setMessage(String message)	Sets the message text that appears in the progress bar text overlay.
void	setModel(RangedValueModel model)	Sets the ranged value model that will be used to calculate progress percentage.
void	setProgressPercent(double percent)	Sets the current progress value as a percentage (0-1.0) of the current range.
void	setProgressValue(double val)	Sets the raw progress value.
void	updateLogicalState(float tpf)	updateLogicalState calls the update() method for all controls attached to this 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, toString

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, 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

CONTAINER_ID

public static final String CONTAINER_ID

See Also:

• Constant Field Values

LABEL_ID

public static final String LABEL_ID

See Also:

• Constant Field Values

VALUE_ID

public static final String VALUE_ID

See Also:

• Constant Field Values

Constructor Details

ProgressBar

public ProgressBar()

ProgressBar

public ProgressBar(String style)

ProgressBar

public ProgressBar(ElementId elementId,
 String style)

ProgressBar

public ProgressBar(RangedValueModel model)

ProgressBar

public ProgressBar(RangedValueModel model,
 String style)

ProgressBar

protected ProgressBar(RangedValueModel model,
 boolean applyStyles,
 ElementId elementId,
 String style)

Method Details

setProgressPercent

public void setProgressPercent(double percent)

Sets the current progress value as a percentage (0-1.0) of the current range.

getProgressPercent

public double getProgressPercent()

Returns the current progress value as a percentage (0-1.0) of the current range.

setProgressValue

public void setProgressValue(double val)

Sets the raw progress value.

getProgressValue

public double getProgressValue()

Returns the raw progress value.

setModel

public void setModel(RangedValueModel model)

Sets the ranged value model that will be used to calculate progress percentage. The default model is is a DefaultRangedValueModel() where the range is 0 to 100. If setModel(null) is called then a new default range is created.

getModel

public RangedValueModel getModel()

Returns the current range model for this progress bar.

setMessage

public void setMessage(String message)

Sets the message text that appears in the progress bar text overlay.

getMessage

public String getMessage()

Returns the message text that currently appears in the progress bar text overlay.

getLabel

public Label getLabel()

Returns the GUI element that is used for the main progress bar area and overlay label. This can be used to apply special styling.

getValueIndicator

public Panel getValueIndicator()

Returns the GUI element that is used for the value indicator. This can be used to apply special styling.

updateLogicalState

public void updateLogicalState(float tpf)

Description copied from class: Spatial

updateLogicalState calls the update() method for all controls attached to this Spatial.

Overrides:

updateLogicalState in class Node

Parameters:

tpf - Time per frame.

See Also:

• Spatial.addControl(com.jme3.scene.control.Control)

resetStateView

protected void resetStateView()