Modifier and Type	Class and Description
public static class	ProgressBar.ProgressBarStyle The style for a progress bar, see `ProgressBar`.

Modifier and Type	Field and Description
private float	animateDuration
private float	animateFromValue
private Interpolation	animateInterpolation
private float	animateTime
pack-priv boolean	disabled
pack-priv float	max
pack-priv float	min
pack-priv float	position
private boolean	programmaticChangeEvents
private boolean	round
pack-priv float	stepSize
private ProgressBar.ProgressBarStyle	style
private float	value
pack-priv final boolean	vertical
private Interpolation	visualInterpolation

Access	Constructor and Description
public	ProgressBar(float min, float max, float stepSize, boolean vertical, Skin skin)
public	ProgressBar(float min, float max, float stepSize, boolean vertical, Skin skin, String styleName)
public	ProgressBar(float the minimum value min, float the maximum value max, float the step size between values stepSize, boolean vertical, ProgressBar.ProgressBarStyle the `ProgressBarStyle` style) Creates a new progress bar.

Method Summary

Modifier and Type	Method and Description
public void	act(float delta) Overrides com.badlogic.gdx.scenes.scene2d.Actor.act. Updates the actor based on time.
protected float	clamp(float value) Clamps the value to the progress bar's min/max range.
public void	draw(Batch batch, float parentAlpha) Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.draw. If this method is overridden, the super method or `validate()` should be called to ensure the widget is laid out.
private void	drawRound(Batch batch, Drawable drawable, float x, float y, float w, float h)
protected Drawable	getBackgroundDrawable()
protected Drawable	getKnobAfterDrawable()
protected Drawable	getKnobBeforeDrawable()
protected Drawable	getKnobDrawable()
protected float	getKnobPosition() Returns progress bar visual position within the range (as it was last calculated in `draw(Batch, float)`).
public float	getMaxValue()
public float	getMinValue()
public float	getPercent()
public float	getPrefHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.
public float	getPrefWidth() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefWidth. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.
public boolean	getProgrammaticChangeEvents()
public float	getStepSize()
public ProgressBar.ProgressBarStyle	getStyle() Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle. Returns the progress bar's style.
public float	getValue()
public float	getVisualPercent()
public float	getVisualValue() If `animating` the progress bar value, this returns the value current displayed.
public boolean	isAnimating()
public boolean	isDisabled() Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.isDisabled.
public boolean	isVertical() True if the progress bar is vertical, false if it is horizontal.
protected float	round(float value) Rouinds the value using the progress bar's step size.
public void	setAnimateDuration(float duration) If > 0, changes to the progress bar value via `setValue(float)` will happen over this duration in seconds.
public void	setAnimateInterpolation(Interpolation animateInterpolation) Sets the interpolation to use for `setAnimateDuration(float)`.
public void	setDisabled(boolean disabled) Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.setDisabled.
public void	setProgrammaticChangeEvents(boolean programmaticChangeEvents) If false, `setValue(float)` will not fire `ChangeEvent`.
public void	setRange(float min, float max) Sets the range of this progress bar.
public void	setRound(boolean round) If true (the default), inner Drawable positions and sizes are rounded to integers.
public void	setStepSize(float stepSize)
public void	setStyle(ProgressBar.ProgressBarStyle style) Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle. Set the current style of the actor
public boolean	Returns: false if the value was not changed because the progress bar already had the value or it was canceled by a listener. setValue(float value) Sets the progress bar position, rounded to the nearest step size and clamped to the minimum and maximum values.
public void	setVisualInterpolation(Interpolation interpolation) Sets the interpolation to use for display.
public void	updateVisualValue() Sets the visual value equal to the actual value.

Inherited from com.badlogic.gdx.scenes.scene2d.ui.Widget:: getMaxHeight getMaxWidth getMinHeight getMinWidth invalidate invalidateHierarchy layout needsLayout pack setFillParent setLayoutEnabled sizeChanged validate

Field Detail

animateDuration	back to summary
private float animateDuration

animateFromValue	back to summary
private float animateFromValue

animateInterpolation	back to summary
private Interpolation animateInterpolation

animateTime	back to summary
private float animateTime

disabled	back to summary
pack-priv boolean disabled

max	back to summary
pack-priv float max

min	back to summary
pack-priv float min

position	back to summary
pack-priv float position

programmaticChangeEvents	back to summary
private boolean programmaticChangeEvents

round	back to summary
private boolean round

stepSize	back to summary
pack-priv float stepSize

style	back to summary
private ProgressBar.ProgressBarStyle style

value	back to summary
private float value

vertical	back to summary
pack-priv final boolean vertical

visualInterpolation	back to summary
private Interpolation visualInterpolation

Constructor Detail

ProgressBar	back to summary
public ProgressBar(float min, float max, float stepSize, boolean vertical, Skin skin)

ProgressBar	back to summary
public ProgressBar(float min, float max, float stepSize, boolean vertical, Skin skin, String styleName)

ProgressBar back to summary

ProgressBar	back to summary
public ProgressBar(float min, float max, float stepSize, boolean vertical, ProgressBar.ProgressBarStyle style) Creates a new progress bar. If horizontal, its width is determined by the prefWidth parameter, and its height is determined by the maximum of the height of either the progress bar `NinePatch` or progress bar handle `TextureRegion`. The min and max values determine the range the values of this progress bar can take on, the stepSize parameter specifies the distance between individual values. E.g. min could be 4, max could be 10 and stepSize could be 0.2, giving you a total of 30 values, 4.0 4.2, 4.4 and so on. Parameters min:float the minimum value max:float the maximum value stepSize:float the step size between values style:ProgressBar.ProgressBarStyle the `ProgressBarStyle`

public ProgressBar(float min, float max, float stepSize, boolean vertical, ProgressBar.ProgressBarStyle style)

Creates a new progress bar. If horizontal, its width is determined by the prefWidth parameter, and its height is determined by the maximum of the height of either the progress bar NinePatch or progress bar handle TextureRegion. The min and max values determine the range the values of this progress bar can take on, the stepSize parameter specifies the distance between individual values.

E.g. min could be 4, max could be 10 and stepSize could be 0.2, giving you a total of 30 values, 4.0 4.2, 4.4 and so on.

Parameters

min:float: the minimum value
max:float: the maximum value
stepSize:float: the step size between values
style:ProgressBar.ProgressBarStyle: the ProgressBarStyle

Method Detail

act back to summary

act	back to summary
public void act(float delta) Overrides com.badlogic.gdx.scenes.scene2d.Actor.act. Doc from com.badlogic.gdx.scenes.scene2d.Actor.act. Updates the actor based on time. Typically this is called each frame by `Stage#act(float)`. The default implementation calls `Action#act(float)` on each action and removes actions that are complete.

public void act(float delta)

Overrides com.badlogic.gdx.scenes.scene2d.Actor.act.

Doc from com.badlogic.gdx.scenes.scene2d.Actor.act.

Updates the actor based on time. Typically this is called each frame by Stage#act(float).

The default implementation calls Action#act(float) on each action and removes actions that are complete.

clamp	back to summary
protected float clamp(float value) Clamps the value to the progress bar's min/max range. This can be overridden to allow a range different from the progress bar knob's range.

draw back to summary

draw	back to summary
public void draw(Batch batch, float parentAlpha) Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.draw. Doc from com.badlogic.gdx.scenes.scene2d.ui.Widget.draw. If this method is overridden, the super method or `validate()` should be called to ensure the widget is laid out.

public void draw(Batch batch, float parentAlpha)

Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.draw.

Doc from com.badlogic.gdx.scenes.scene2d.ui.Widget.draw.

If this method is overridden, the super method or validate() should be called to ensure the widget is laid out.

drawRound	back to summary
private void drawRound(Batch batch, Drawable drawable, float x, float y, float w, float h)

getBackgroundDrawable	back to summary
protected Drawable getBackgroundDrawable() Annotations @Null

getKnobAfterDrawable	back to summary
protected Drawable getKnobAfterDrawable()

getKnobBeforeDrawable	back to summary
protected Drawable getKnobBeforeDrawable()

getKnobDrawable	back to summary
protected Drawable getKnobDrawable() Annotations @Null

getKnobPosition	back to summary
protected float getKnobPosition() Returns progress bar visual position within the range (as it was last calculated in `draw(Batch, float)`).

getMaxValue	back to summary
public float getMaxValue()

getMinValue	back to summary
public float getMinValue()

getPercent	back to summary
public float getPercent()

getPrefHeight	back to summary
public float getPrefHeight() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefHeight. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.

getPrefHeight

back to summary

public float getPrefHeight()

Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefHeight.

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefHeight.

getPrefWidth	back to summary
public float getPrefWidth() Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefWidth. Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.

getPrefWidth

back to summary

public float getPrefWidth()

Overrides com.badlogic.gdx.scenes.scene2d.ui.Widget.getPrefWidth.

Implements com.badlogic.gdx.scenes.scene2d.utils.Layout.getPrefWidth.

getProgrammaticChangeEvents	back to summary
public boolean getProgrammaticChangeEvents()

getStepSize	back to summary
public float getStepSize()

getStyle back to summary

getStyle	back to summary
public ProgressBar.ProgressBarStyle getStyle() Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle. Returns the progress bar's style. Modifying the returned style may not have an effect until `setStyle(ProgressBarStyle)` is called.

public ProgressBar.ProgressBarStyle getStyle()

Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.getStyle.

Returns the progress bar's style. Modifying the returned style may not have an effect until setStyle(ProgressBarStyle) is called.

getValue	back to summary
public float getValue()

getVisualPercent	back to summary
public float getVisualPercent()

getVisualValue	back to summary
public float getVisualValue() If `animating` the progress bar value, this returns the value current displayed.

isAnimating	back to summary
public boolean isAnimating()

isDisabled	back to summary
public boolean isDisabled() Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.isDisabled.

isVertical	back to summary
public boolean isVertical() True if the progress bar is vertical, false if it is horizontal.

round	back to summary
protected float round(float value) Rouinds the value using the progress bar's step size. This can be overridden to customize or disable rounding.

setAnimateDuration	back to summary
public void setAnimateDuration(float duration) If > 0, changes to the progress bar value via `setValue(float)` will happen over this duration in seconds.

setAnimateInterpolation	back to summary
public void setAnimateInterpolation(Interpolation animateInterpolation) Sets the interpolation to use for `setAnimateDuration(float)`.

setDisabled	back to summary
public void setDisabled(boolean disabled) Implements com.badlogic.gdx.scenes.scene2d.utils.Disableable.setDisabled.

setProgrammaticChangeEvents	back to summary
public void setProgrammaticChangeEvents(boolean programmaticChangeEvents) If false, `setValue(float)` will not fire `ChangeEvent`. The event will only be fired when the user changes the slider.

setRange	back to summary
public void setRange(float min, float max) Sets the range of this progress bar. The progress bar's current value is clamped to the range.

setRound	back to summary
public void setRound(boolean round) If true (the default), inner Drawable positions and sizes are rounded to integers.

setStepSize	back to summary
public void setStepSize(float stepSize)

setStyle

back to summary

public void setStyle(ProgressBar.ProgressBarStyle style)

Implements com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle.

Doc from com.badlogic.gdx.scenes.scene2d.ui.Styleable.setStyle.

Set the current style of the actor

setValue back to summary

public boolean setValue(float value)

Sets the progress bar position, rounded to the nearest step size and clamped to the minimum and maximum values. clamp(float) can be overridden to allow values outside of the progress bar's min/max range.

Returns:boolean: false if the value was not changed because the progress bar already had the value or it was canceled by a listener.

setVisualInterpolation	back to summary
public void setVisualInterpolation(Interpolation interpolation) Sets the interpolation to use for display.

updateVisualValue	back to summary
public void updateVisualValue() Sets the visual value equal to the actual value. This can be used to set the value without animating.

com.badlogic.gdx.scenes.scene2d.ui back to summary

public Class ProgressBar.ProgressBarStyle

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.scenes.scene2d.ui.ProgressBar.ProgressBarStyle

Known Direct Subclasses

com.badlogic.gdx.scenes.scene2d.ui.Slider.SliderStyle

The style for a progress bar, see ProgressBar.

Authors: mzechner, Nathan Sweet

Field Summary

Modifier and Type	Field and Description
public Drawable	background The progress bar background, stretched only in one direction.
public Drawable	disabledBackground The progress bar background, stretched only in one direction.
public Drawable	disabledKnob
public Drawable	disabledKnobAfter
public Drawable	disabledKnobBefore
public Drawable	knob
public Drawable	knobAfter
public Drawable	knobBefore

Constructor Summary

Access	Constructor and Description
public	ProgressBarStyle()
public	ProgressBarStyle(Drawable background, Drawable knob)
public	ProgressBarStyle(ProgressBar.ProgressBarStyle style)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

background	back to summary
public Drawable background The progress bar background, stretched only in one direction. Annotations @Null

disabledBackground	back to summary
public Drawable disabledBackground The progress bar background, stretched only in one direction. Annotations @Null

disabledKnob	back to summary
public Drawable disabledKnob Annotations @Null

disabledKnobAfter	back to summary
public Drawable disabledKnobAfter Annotations @Null

disabledKnobBefore	back to summary
public Drawable disabledKnobBefore Annotations @Null

knob	back to summary
public Drawable knob Annotations @Null

knobAfter	back to summary
public Drawable knobAfter Annotations @Null

knobBefore	back to summary
public Drawable knobBefore Annotations @Null

Constructor Detail

ProgressBarStyle	back to summary
public ProgressBarStyle()

ProgressBarStyle	back to summary
public ProgressBarStyle(Drawable background, Drawable knob)

ProgressBarStyle	back to summary
public ProgressBarStyle(ProgressBar.ProgressBarStyle style)

public Class ProgressBar

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ProgressBar.ProgressBarStyle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail