In a determinate state, the circle 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 circle 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 circle 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.
The CircleProgressIndicator extends ArcProgressIndicator and adds a start angle property that defines the starting angle of the arc used to display the progress. The default start angle is 90 degrees, which corresponds to the top of the circle.
Pseudo class: Beyond the inherited , indeterminate and determinate pseudo-classes from ProgressIndicator, CircleProgressIndicator 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.
CircleProgressIndicator progressIndicator = new CircleProgressIndicator(0.0);
| Modifier and Type | Field and Description |
|---|---|
| private static final double | |
| private static final String | |
| private DoubleProperty |
| Access | Constructor and Description |
|---|---|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| protected Skin | createDefaultSkin()
Overrides javafx. Create a new instance of the default skin for this control. |
| public final double | |
| public String | getUserAgentStylesheet()
Overrides javafx. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. |
| public final void | |
| public final DoubleProperty | Returns: the start angle propertyThe start angle property defines the starting angle of the arc that is used to display the progress. |
| DEFAULT_START_ANGLE | back to summary |
|---|---|
| private static final double DEFAULT_START_ANGLE | |
| DEFAULT_STYLE_CLASS | back to summary |
|---|---|
| private static final String DEFAULT_STYLE_CLASS Hides com. | |
| startAngle | back to summary |
|---|---|
| private DoubleProperty startAngle | |
| CircleProgressIndicator | back to summary |
|---|---|
| public CircleProgressIndicator() | |
| CircleProgressIndicator | back to summary |
|---|---|
| public CircleProgressIndicator(double progress) | |
| createDefaultSkin | back to summary |
|---|---|
| protected Skin Overrides javafx. Doc from javafx. 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
| |
| getStartAngle | back to summary |
|---|---|
| public final double getStartAngle() | |
| getUserAgentStylesheet | back to summary |
|---|---|
| public String getUserAgentStylesheet() Overrides javafx. Doc from javafx. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls. The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath. Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called.
For additional information about using CSS with the scene graph,
see the CSS Reference Guide.
| |
| setStartAngle | back to summary |
|---|---|
| public final void setStartAngle(double startAngle) | |
| startAngleProperty | back to summary |
|---|---|
| public final DoubleProperty startAngleProperty() The start angle property defines the starting angle of the arc that is used to display the progress. The default value is 90 degrees, which corresponds to the top of the circle.
| |