Top Description Inners Fields Constructors Methods
com.dlsc.gemsfx

public abstract Class ArcProgressIndicator

extends ProgressIndicator
Class Inheritance
Known Direct Subclasses
com.dlsc.gemsfx.CircleProgressIndicator, com.dlsc.gemsfx.SemiCircleProgressIndicator
Imports
javafx.beans.property.ObjectProperty, .SimpleObjectProperty, javafx.css.CssMetaData, .PseudoClass, .Styleable, .StyleableObjectProperty, .StyleableProperty, javafx.css.converter.EnumConverter, javafx.scene.Node, javafx.scene.control.ProgressIndicator, javafx.scene.shape.ArcType, javafx.util.StringConverter, java.util.ArrayList, .Collections, .List

ArcProgressIndicator is a visual control used to indicate the progress of a task. It represents progress in an arc form, with options to show determinate or indeterminate states.

In a determinate state, the arc fills up based on the progress value, which ranges from 0.0 to 1.0, where 0.0 indicates no progress and 1.0 indicates completion.

In an indeterminate state, the arc shows a cyclic animation, indicating that progress is ongoing but the exact status is unknown. This state is useful for tasks where the progress cannot be determined.

The control also supports displaying a text or graphic inside the arc to provide additional information or visual feedback to the user.

Usage examples include file downloads, file transfers, or any long-running tasks where visual feedback on progress is beneficial.

Pseudo class: Beyond the inherited, indeterminate, and determinate pseudo-classes from ProgressIndicator, ArcProgressIndicator introduces a completed pseudo-class. This pseudo-class can be used in CSS to apply custom styles when the progress reaches 1.0 (100%).

Tips: If you prefer not to instantiate the animation object during initialization, pass a 0.0 as the initial progress. This setup indicates no progress but avoids entering the indeterminate state, which would otherwise instantiate and start the animation.

Usage examples:

    // Initializes with no progress and no animation.
    ArcProgressIndicator progressIndicator = new ArcProgressIndicator(0.0);

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
public static enum

Field Summary

Modifier and TypeField and Description
private final ObjectProperty<StringConverter<Double>>
private static final StringConverter<Double>
private static final ArcType
private static final String
private static final ArcProgressIndicator.StyleType
private static final ArcType
private final ObjectProperty<Node>
private ObjectProperty<ArcType>
private ObjectProperty<ArcProgressIndicator.StyleType>
private ObjectProperty<ArcType>
Inherited from javafx.scene.control.ProgressIndicator:
INDETERMINATE_PROGRESS

Constructor Summary

AccessConstructor and Description
public
public
ArcProgressIndicator(double progress)

Method Summary

Modifier and TypeMethod and Description
public final ObjectProperty<StringConverter<Double>>

Returns:

the converter property
converterProperty
()

The converter is used to convert the progress value to a string that is displayed

public static List<CssMetaData<? extends Styleable, ?>>
getClassCssMetaData()

Hides javafx.scene.control.Control.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

protected List<CssMetaData<? extends Styleable, ?>>
getControlCssMetaData()

Overrides javafx.scene.control.Control.getControlCssMetaData.

Gets the unmodifiable list of the control's CSS-styleable properties.

public final StringConverter<Double>
public final Node
public final ArcType
public final ArcProgressIndicator.StyleType
public final ArcType
public final ObjectProperty<Node>

Returns:

the graphic property
graphicProperty
()

The graphic property is used to display a custom node within the progress indicator.

public final ObjectProperty<ArcType>

Returns:

the arc type property for the progress
progressArcTypeProperty
()

The arc type property defines the type of the arc that is used to display the progress.

public final void
public final void
setGraphic(Node graphic)

public final void
setProgressArcType(ArcType progressArcType)

public final void
public final void
setTrackArcType(ArcType trackArcType)

public final ObjectProperty<ArcProgressIndicator.StyleType>

Returns:

the style type property for the progress
styleTypeProperty
()

The style type property defines the visualization type of the arc that is used to display the progress.

public final ObjectProperty<ArcType>

Returns:

the arc type property for the track
trackArcTypeProperty
()

The arc type property defines the type of the arc that is used to display the track.

private void
Inherited from javafx.scene.control.ProgressIndicator:
createDefaultSkingetInitialFocusTraversablegetProgressindeterminatePropertyisIndeterminateprogressPropertyqueryAccessibleAttributesetProgress

Field Detail

converterback to summary
private final ObjectProperty<StringConverter<Double>> converter
DEFAULT_CONVERTERback to summary
private static final StringConverter<Double> DEFAULT_CONVERTER
DEFAULT_PROGRESS_ARC_TYPEback to summary
private static final ArcType DEFAULT_PROGRESS_ARC_TYPE
DEFAULT_STYLE_CLASSback to summary
private static final String DEFAULT_STYLE_CLASS

Hides javafx.scene.control.ProgressIndicator.DEFAULT_STYLE_CLASS.

DEFAULT_STYLE_TYPEback to summary
private static final ArcProgressIndicator.StyleType DEFAULT_STYLE_TYPE
DEFAULT_TRACK_ARC_TYPEback to summary
private static final ArcType DEFAULT_TRACK_ARC_TYPE
graphicback to summary
private final ObjectProperty<Node> graphic
progressArcTypeback to summary
private ObjectProperty<ArcType> progressArcType
styleTypeback to summary
private ObjectProperty<ArcProgressIndicator.StyleType> styleType
trackArcTypeback to summary
private ObjectProperty<ArcType> trackArcType

Constructor Detail

ArcProgressIndicatorback to summary
public ArcProgressIndicator()
ArcProgressIndicatorback to summary
public ArcProgressIndicator(double progress)

Method Detail

converterPropertyback to summary
public final ObjectProperty<StringConverter<Double>> converterProperty()

The converter is used to convert the progress value to a string that is displayed

Returns:ObjectProperty<StringConverter<Double>>

the converter property

getClassCssMetaDataback to summary
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.control.Control.getClassCssMetaData.

Doc from javafx.scene.control.Control.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

getControlCssMetaDataback to summary
protected List<CssMetaData<? extends Styleable, ?>> getControlCssMetaData()

Overrides javafx.scene.control.Control.getControlCssMetaData.

Doc from javafx.scene.control.Control.getControlCssMetaData.

Gets the unmodifiable list of the control's CSS-styleable properties.

Annotations
@Override
getConverterback to summary
public final StringConverter<Double> getConverter()
getGraphicback to summary
public final Node getGraphic()
getProgressArcTypeback to summary
public final ArcType getProgressArcType()
getStyleTypeback to summary
public final ArcProgressIndicator.StyleType getStyleType()
getTrackArcTypeback to summary
public final ArcType getTrackArcType()
graphicPropertyback to summary
public final ObjectProperty<Node> graphicProperty()

The graphic property is used to display a custom node within the progress indicator. progress label's graphic property is bound to this property.

Returns:ObjectProperty<Node>

the graphic property

progressArcTypePropertyback to summary
public final ObjectProperty<ArcType> progressArcTypeProperty()

The arc type property defines the type of the arc that is used to display the progress.

Returns:ObjectProperty<ArcType>

the arc type property for the progress

setConverterback to summary
public final void setConverter(StringConverter<Double> converter)
setGraphicback to summary
public final void setGraphic(Node graphic)
setProgressArcTypeback to summary
public final void setProgressArcType(ArcType progressArcType)
setStyleTypeback to summary
public final void setStyleType(ArcProgressIndicator.StyleType styleType)
setTrackArcTypeback to summary
public final void setTrackArcType(ArcType trackArcType)
styleTypePropertyback to summary
public final ObjectProperty<ArcProgressIndicator.StyleType> styleTypeProperty()

The style type property defines the visualization type of the arc that is used to display the progress. Possible values are: default, bold, thin, sector.

Returns:ObjectProperty<ArcProgressIndicator.StyleType>

the style type property for the progress

trackArcTypePropertyback to summary
public final ObjectProperty<ArcType> trackArcTypeProperty()

The arc type property defines the type of the arc that is used to display the track.

Returns:ObjectProperty<ArcType>

the arc type property for the track

updatePseudoClassesback to summary
private void updatePseudoClasses()
com.dlsc.gemsfx back to summary

private Class ArcProgressIndicator.StyleableProperties

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final CssMetaData<ArcProgressIndicator, ArcType>
private static final CssMetaData<ArcProgressIndicator, ArcProgressIndicator.StyleType>
private static final List<CssMetaData<? extends Styleable, ?>>
private static final CssMetaData<ArcProgressIndicator, ArcType>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

PROGRESS_ARC_TYPEback to summary
private static final CssMetaData<ArcProgressIndicator, ArcType> PROGRESS_ARC_TYPE
STYLE_TYPEback to summary
private static final CssMetaData<ArcProgressIndicator, ArcProgressIndicator.StyleType> STYLE_TYPE
STYLEABLESback to summary
private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES
TRACK_ARC_TYPEback to summary
private static final CssMetaData<ArcProgressIndicator, ArcType> TRACK_ARC_TYPE

Constructor Detail

StyleablePropertiesback to summary
private StyleableProperties()
com.dlsc.gemsfx back to summary

public final Enum ArcProgressIndicator.StyleType

extends Enum<ArcProgressIndicator.StyleType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final ArcProgressIndicator.StyleType
public static final ArcProgressIndicator.StyleType
public static final ArcProgressIndicator.StyleType
public static final ArcProgressIndicator.StyleType

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ArcProgressIndicator.StyleType
public static ArcProgressIndicator.StyleType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

BOLDback to summary
public static final ArcProgressIndicator.StyleType BOLD
DEFAULTback to summary
public static final ArcProgressIndicator.StyleType DEFAULT
SECTORback to summary
public static final ArcProgressIndicator.StyleType SECTOR
THINback to summary
public static final ArcProgressIndicator.StyleType THIN

Constructor Detail

StyleTypeback to summary
private StyleType()

Method Detail

valueOfback to summary
public static ArcProgressIndicator.StyleType valueOf(String name)
valuesback to summary
public static ArcProgressIndicator.StyleType[] values()