Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ProgressIndicator

[112:7] extends: Node, Control, Region

The ProgressIndicator class wraps the JavaFX ProgressIndicator control, a circular spinner that displays the progress of a long-running operation. A progress value between 0.0 and 1.0 shows a proportional arc indicating how much work is complete, while a negative value switches the indicator into indeterminate mode where it spins continuously. The number of spinner segments, the progress color, and spin behavior are all configurable through CSS. This wrapper defaults progress to 0.0 to avoid the resource-heavy indeterminate animation on startup.

CSS Pseudo-classes -- ProgressIndicator

Pseudo-class Description
determinate Applies when the indeterminate property is false (a specific progress value is set).
indeterminate Applies when the indeterminate property is true (progress is negative or unknown).

CSS Properties -- ProgressIndicator

Property Values Default Description
-fx-indeterminate-segment-count <number> 8 Number of segments in the indeterminate spinner graphic.
-fx-progress-color <paint> null Color of the progress arc or bar. When null, the default theme color is used.
-fx-spin-enabled true | false false When true, the indeterminate indicator rotates as it animates.

CSS Properties -- Control

Property Values Default Description
-fx-skin <string> null Fully qualified class name of the Skin to use for rendering this control.
-fx-focus-traversable true | false false When true, the control participates in focus traversal via the keyboard Tab key. Default is false for ProgressIndicator.

CSS Properties -- Region

Background fills

Property Values Default Description
-fx-background-color <paint> [, <paint>]* transparent One or more paint values for background fill layers, rendered back to front.
-fx-background-insets <size> or <t> <r> <b> <l> [, ...]* 0 0 0 0 Insets from the region edges for each background fill layer.
-fx-background-radius <size> [/ <size>]* [, ...]* 0 0 0 0 Corner radii for each background fill layer.

Background images

Property Values Default Description
-fx-background-image <uri> [, <uri>]* null One or more image URIs for background image layers.
-fx-background-position <bg-position> [, ...]* 0% 0% Position of each background image within the region. Accepts keywords or size values.
-fx-background-repeat <repeat-style> [, ...]* repeat repeat Tiling behavior for each background image. Values: repeat, no-repeat, round, space applied per axis.
-fx-background-size <bg-size> [, ...]* auto auto Dimensions for each background image. Supports cover, contain, stretch, or explicit sizes.

Stroked borders

Property Values Default Description
-fx-border-color <paint> or <t> <r> <b> <l> [, ...]* null Paint colors for the border stroke layers.
-fx-border-insets <size> or <t> <r> <b> <l> [, ...]* null Insets from region edges for each border layer.
-fx-border-radius <size> [, ...]* null Corner radii for border stroke layers.
-fx-border-style <border-style> [, ...]* null Border line style (solid, dotted, dashed) plus phase and line cap/join options per layer.
-fx-border-width <size> or <t> <r> <b> <l> [, ...]* null Thickness of each border stroke layer, per side.

Border images

Property Values Default Description
-fx-border-image-source <uri> [, <uri>]* null Image URIs used to paint the border.
-fx-border-image-insets <size> or <t> <r> <b> <l> [, ...]* 0 0 0 0 Insets for each border image layer.
-fx-border-image-repeat <repeat-style> [, ...]* repeat repeat Tiling behavior for each border image.
-fx-border-image-slice <size> or <t> <r> <b> <l> [fill] [, ...]* 100% Divides each border image into nine regions. Adding fill preserves the center region.
-fx-border-image-width <size> or <t> <r> <b> <l> [, ...]* 1 1 1 1 Width of each border image slice per side.

Other Region properties

Property Values Default Description
-fx-padding <size> or <t> <r> <b> <l> 0 0 0 0 Interior padding between the region border and its content.
-fx-shape <string> null SVG path string that defines a custom clip shape for the region.
-fx-scale-shape true | false true When true, the shape is scaled to fit the region.
-fx-position-shape true | false true When true, the shape is centered within the region.
-fx-snap-to-pixel true | false true When true, positions and sizes are rounded to whole pixel boundaries.
-fx-min-width <size> -1 Minimum width. -1 uses the computed minimum.
-fx-pref-width <size> -1 Preferred width. -1 uses the computed preferred.
-fx-max-width <size> -1 Maximum width. -1 uses the computed maximum.
-fx-min-height <size> -1 Minimum height. -1 uses the computed minimum.
-fx-pref-height <size> -1 Preferred height. -1 uses the computed preferred.
-fx-max-height <size> -1 Maximum height. -1 uses the computed maximum.

CSS Properties -- Node

Property Values Default Description
-fx-blend-mode add | blue | color-burn | color-dodge | darken | difference | exclusion | green | hard-light | lighten | multiply | overlay | red | screen | soft-light | src-atop | src-in | src-out | src-over null Blend mode used when compositing this node with nodes beneath it.
-fx-cursor null | crosshair | default | hand | move | e-resize | h-resize | ne-resize | nw-resize | n-resize | se-resize | sw-resize | s-resize | w-resize | v-resize | text | wait | <url> null (inherits) Mouse cursor shape shown when the pointer is over this node. Inherits from parent by default.
-fx-effect <effect> null A visual effect (e.g. DropShadow, InnerShadow) applied to the rendered node.
-fx-focus-traversable true | false false Whether this node participates in focus traversal. Overridden to true by Control.
-fx-view-order <number> 0 Adjusts rendering and hit-test order within the parent without changing the scene graph order.
-fx-opacity <number> [0.0 - 1.0] 1 Opacity of the node. 0 is fully transparent, 1 is fully opaque.
-fx-rotate <number> 0 Rotation angle in degrees applied around the node's center point. Positive values are clockwise.
-fx-scale-x <number> 1 Scale factor along the X axis about the node's center.
-fx-scale-y <number> 1 Scale factor along the Y axis about the node's center.
-fx-scale-z <number> 1 Scale factor along the Z axis about the node's center.
-fx-translate-x <number> 0 Translation offset along the X axis in pixels.
-fx-translate-y <number> 0 Translation offset along the Y axis in pixels.
-fx-translate-z <number> 0 Translation offset along the Z axis in pixels.
visibility visible | hidden | collapse | inherit visible Controls whether the node is rendered and participates in layout. collapse removes it from layout; hidden keeps the space.
-fx-managed true | false true When false, the parent layout does not manage this node's position or size.

Methods

  • ProgressIndicator ()

    Initializes a new ProgressIndicator instance. The progress is defaulted to 0.0 to avoid processor-intensive animations.

    • @r this object
  • setProgress (double Progress)

    Sets the current progress level of the ProgressIndicator.

    • @p Progress The progress value to display, where 0.0 is no progress and 1.0 is complete.
    • @r this object for chaining
  • getProgress ()

    Returns the current progress value of the ProgressIndicator.

    • @r A double with the current progress between 0.0 and 1.0.
  • setId (string Id)

    Sets the CSS id of this ProgressIndicator node.

    • @p Id is a string with the CSS id.
    • @r this object for chaining
  • setStyle (string Style)

    Sets the inline CSS style string for this ProgressIndicator.

    • @p Style is a string with the CSS style rules.
    • @r this object for chaining
  • setPrefSize (double Width, double Height)

    Sets the preferred width and height of the ProgressIndicator.

    • @p Width is a double with the preferred width in pixels.
    • @p Height is a double with the preferred height in pixels.
    • @r this object for chaining