javafx.scene.control

Class ProgressIndicator

java.lang.Object

Region

javafx.scene.control.Control

javafx.scene.control.ProgressIndicator

All Implemented Interfaces:

Skinnable

Direct Known Subclasses:

ProgressBar

public class ProgressIndicator
extends Control

A circular control which is used for indicating progress, either infinite (aka indeterminate) or finite. Often used with the Task API for representing progress of background Tasks.

ProgressIndicator sets focusTraversable to false.

This first example creates a ProgressIndicator with an indeterminate value :

 import javafx.scene.control.ProgressIndicator;
 ProgressIndicator p1 = new ProgressIndicator();
 

This next example creates a ProgressIndicator which is 25% complete :

 import javafx.scene.control.ProgressIndicator;
 ProgressIndicator p2 = new ProgressIndicator();
 p2.setProgress(0.25F);
 

Implementation of ProgressIndicator According to JavaFX UI Control API Specification

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
ReadOnlyBooleanProperty	indeterminate A flag indicating whether it is possible to determine the progress of the ProgressIndicator.
DoubleProperty	progress The actual progress of the ProgressIndicator.

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	DEFAULT_STYLE_CLASS Initialize the style class to 'progress-indicator'.
private ReadOnlyBooleanWrapper	indeterminate A flag indicating whether it is possible to determine the progress of the ProgressIndicator.
static double	INDETERMINATE_PROGRESS Value for progress indicating that the progress is indeterminate.
private DoubleProperty	progress The actual progress of the ProgressIndicator.
private static PseudoClass	PSEUDO_CLASS_DETERMINATE Pseudoclass indicating this is a determinate (i.e., progress can be determined) progress indicator.
private static PseudoClass	PSEUDO_CLASS_INDETERMINATE Pseudoclass indicating this is an indeterminate (i.e., progress cannot be determined) progress indicator.

Constructor Summary

Constructors

Constructor and Description
ProgressIndicator() Creates a new indeterminate ProgressIndicator.
ProgressIndicator(double progress) Creates a new ProgressIndicator with the given progress value.

Method Summary

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin() Create a new instance of the default skin for this control.
protected java.lang.Boolean	getInitialFocusTraversable() Returns the initial focus traversable state of this control, for use by the JavaFX CSS engine to correctly set its initial value.
double	getProgress() Gets the value of the property progress.
ReadOnlyBooleanProperty	indeterminateProperty() A flag indicating whether it is possible to determine the progress of the ProgressIndicator.
private ReadOnlyBooleanWrapper	indeterminatePropertyImpl()
boolean	isIndeterminate() Gets the value of the property indeterminate.
DoubleProperty	progressProperty() The actual progress of the ProgressIndicator.
java.lang.Object	queryAccessibleAttribute(AccessibleAttribute attribute, java.lang.Object... parameters)
private void	setIndeterminate(boolean value)
void	setProgress(double value) Sets the value of the property progress.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlChildren, getControlCssMetaData, getCssMetaData, getSkin, getTooltip, isResizable, layoutChildren, loadSkinClass, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class java.lang.Object

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

Property Detail

indeterminate

public final ReadOnlyBooleanProperty indeterminateProperty

A flag indicating whether it is possible to determine the progress of the ProgressIndicator. Typically indeterminate progress bars are rendered with some form of animation indicating potentially "infinite" progress.

See Also:

isIndeterminate()

progress

public final DoubleProperty progressProperty

The actual progress of the ProgressIndicator. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%.

See Also:

getProgress(), setProgress(double)

Field Detail

INDETERMINATE_PROGRESS

public static final double INDETERMINATE_PROGRESS

Value for progress indicating that the progress is indeterminate.

See Also:

setProgress(double), Constant Field Values

indeterminate

private ReadOnlyBooleanWrapper indeterminate

A flag indicating whether it is possible to determine the progress of the ProgressIndicator. Typically indeterminate progress bars are rendered with some form of animation indicating potentially "infinite" progress.

progress

private DoubleProperty progress

The actual progress of the ProgressIndicator. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%.

DEFAULT_STYLE_CLASS

private static final java.lang.String DEFAULT_STYLE_CLASS

Initialize the style class to 'progress-indicator'. This is the selector class from which CSS can be used to style this control.

See Also:

Constant Field Values

PSEUDO_CLASS_DETERMINATE

private static final PseudoClass PSEUDO_CLASS_DETERMINATE

Pseudoclass indicating this is a determinate (i.e., progress can be determined) progress indicator.

PSEUDO_CLASS_INDETERMINATE

private static final PseudoClass PSEUDO_CLASS_INDETERMINATE

Pseudoclass indicating this is an indeterminate (i.e., progress cannot be determined) progress indicator.

Constructor Detail

ProgressIndicator

public ProgressIndicator()

Creates a new indeterminate ProgressIndicator.

ProgressIndicator

public ProgressIndicator(double progress)

Creates a new ProgressIndicator with the given progress value.

Parameters:

progress - the progress, represented as a value between 0 and 1

Method Detail

setIndeterminate

private void setIndeterminate(boolean value)

isIndeterminate

public final boolean isIndeterminate()

Gets the value of the property indeterminate.

indeterminateProperty

public final ReadOnlyBooleanProperty indeterminateProperty()

A flag indicating whether it is possible to determine the progress of the ProgressIndicator. Typically indeterminate progress bars are rendered with some form of animation indicating potentially "infinite" progress.

See Also:

isIndeterminate()

indeterminatePropertyImpl

private ReadOnlyBooleanWrapper indeterminatePropertyImpl()

setProgress

public final void setProgress(double value)

Sets the value of the property progress.

getProgress

public final double getProgress()

Gets the value of the property progress.

progressProperty

public final DoubleProperty progressProperty()

The actual progress of the ProgressIndicator. A negative value for progress indicates that the progress is indeterminate. A positive value between 0 and 1 indicates the percentage of progress where 0 is 0% and 1 is 100%. Any value greater than 1 is interpreted as 100%.

See Also:

getProgress(), setProgress(double)

createDefaultSkin

protected Skin<?> createDefaultSkin()

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Overrides:

createDefaultSkin in class Control

Returns:

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

getInitialFocusTraversable

protected java.lang.Boolean getInitialFocusTraversable()

Returns the initial focus traversable state of this control, for use by the JavaFX CSS engine to correctly set its initial value. This method is overridden as by default UI controls have focus traversable set to true, but that is not appropriate for this control.

Overrides:

getInitialFocusTraversable in class Control

Returns:

the initial focus traversable state of this control

Since:

9

queryAccessibleAttribute

public java.lang.Object queryAccessibleAttribute(AccessibleAttribute attribute,
                                                 java.lang.Object... parameters)

Overrides:

queryAccessibleAttribute in class Control