Module atlantafx.base
Package atlantafx.base.controls

Class RingProgressIndicator

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.ProgressIndicator
atlantafx.base.controls.RingProgressIndicator
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class RingProgressIndicator extends javafx.scene.control.ProgressIndicator
A ProgressIndicator that displays progress value as a ring that gradually empties out as a task is completed.

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.ObjectProperty<javafx.scene.Node>
    graphic
    Represents the node to be displayed within the progress indicator.
    javafx.beans.property.ReadOnlyBooleanProperty
    reverse
    Reverses the progress indicator scale.
    javafx.beans.property.ObjectProperty<javafx.util.StringConverter<Double>>
    stringConverter
    Represents an optional converter to transform the progress value to a string.

    Properties inherited from class javafx.scene.control.ProgressIndicator

    indeterminate, progress

    Properties inherited from class javafx.scene.control.Control

    contextMenu, skin, tooltip

    Properties inherited from class javafx.scene.layout.Region

    background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

    Properties inherited from class javafx.scene.Parent

    needsLayout

    Properties inherited from class javafx.scene.Node

    accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    graphic
     
    protected final javafx.beans.property.ReadOnlyBooleanWrapper
    reverse
     
    protected final javafx.beans.property.ObjectProperty<javafx.util.StringConverter<Double>>
    stringConverter
     

    Fields inherited from class javafx.scene.control.ProgressIndicator

    INDETERMINATE_PROGRESS

    Fields inherited from class javafx.scene.layout.Region

    USE_COMPUTED_SIZE, USE_PREF_SIZE

    Fields inherited from class javafx.scene.Node

    BASELINE_OFFSET_SAME_AS_HEIGHT

  • Constructor Summary

    Constructors
    Constructor
    Description
    RingProgressIndicator()
    Creates a new indeterminate ProgressIndicator.
    RingProgressIndicator(double progress)
    Creates a new ProgressIndicator with the given progress value.
    RingProgressIndicator(double progress, boolean reverse)
    Creates a new ProgressIndicator with the given progress value and type.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
    javafx.scene.Node
    getGraphic()
    Gets the value of the property graphic.
    javafx.util.StringConverter<Double>
    getStringConverter()
    Gets the value of the property stringConverter.
    javafx.beans.property.ObjectProperty<javafx.scene.Node>
    graphicProperty()
    Represents the node to be displayed within the progress indicator.
    boolean
    isReverse()
    Gets the value of the property reverse.
    javafx.beans.property.ReadOnlyBooleanProperty
    reverseProperty()
    Reverses the progress indicator scale.
    void
    setGraphic(javafx.scene.Node graphic)
    Sets the value of the property graphic.
    void
    setStringConverter(javafx.util.StringConverter<Double> stringConverter)
    Sets the value of the property stringConverter.
    javafx.beans.property.ObjectProperty<javafx.util.StringConverter<Double>>
    stringConverterProperty()
    Represents an optional converter to transform the progress value to a string.

    Methods inherited from class javafx.scene.control.ProgressIndicator

    getInitialFocusTraversable, getProgress, indeterminateProperty, isIndeterminate, progressProperty, queryAccessibleAttribute, setProgress

    Methods inherited from class javafx.scene.control.Control

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

    Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

    Methods inherited from class javafx.scene.Node

    accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

    • graphic

      public javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicProperty
      Represents the node to be displayed within the progress indicator. If null, it will fall back to the Label with an integer progress value from 1 to 100.
      See Also:

    • stringConverter

      public javafx.beans.property.ObjectProperty<javafx.util.StringConverter<Double>> stringConverterProperty
      Represents an optional converter to transform the progress value to a string. It is only used if a custom graphic node is not set.
      See Also:

    • reverse

      public javafx.beans.property.ReadOnlyBooleanProperty reverseProperty
      Reverses the progress indicator scale. For the indeterminate variant, this means it will be rotated counterclockwise.
      See Also:

  • Field Details

    • graphic

      protected final javafx.beans.property.ObjectProperty<javafx.scene.Node> graphic

    • stringConverter

      protected final javafx.beans.property.ObjectProperty<javafx.util.StringConverter<Double>> stringConverter

    • reverse

      protected final javafx.beans.property.ReadOnlyBooleanWrapper reverse

  • Constructor Details

    • RingProgressIndicator

      public RingProgressIndicator()
      Creates a new indeterminate ProgressIndicator.

    • RingProgressIndicator

      public RingProgressIndicator(double progress)
      Creates a new ProgressIndicator with the given progress value.
      Parameters:
      progress - The progress, represented as a value between 0 and 1.

    • RingProgressIndicator

      public RingProgressIndicator(double progress, boolean reverse)
      Creates a new ProgressIndicator with the given progress value and type.
      Parameters:
      progress - The progress, represented as a value between 0 and 1.
      reverse - A flag to indicate whether the indicator is reversed or not.

  • Method Details

    • createDefaultSkin

      protected javafx.scene.control.Skin<?> createDefaultSkin()
      Overrides:
      createDefaultSkin in class javafx.scene.control.ProgressIndicator

    • graphicProperty

      public javafx.beans.property.ObjectProperty<javafx.scene.Node> graphicProperty()
      Represents the node to be displayed within the progress indicator. If null, it will fall back to the Label with an integer progress value from 1 to 100.
      See Also:

    • getGraphic

      public javafx.scene.Node getGraphic()
      Gets the value of the property graphic.
      Property description:
      Represents the node to be displayed within the progress indicator. If null, it will fall back to the Label with an integer progress value from 1 to 100.

    • setGraphic

      public void setGraphic(javafx.scene.Node graphic)
      Sets the value of the property graphic.
      Property description:
      Represents the node to be displayed within the progress indicator. If null, it will fall back to the Label with an integer progress value from 1 to 100.

    • stringConverterProperty

      public javafx.beans.property.ObjectProperty<javafx.util.StringConverter<Double>> stringConverterProperty()
      Represents an optional converter to transform the progress value to a string. It is only used if a custom graphic node is not set.
      See Also:

    • getStringConverter

      public javafx.util.StringConverter<Double> getStringConverter()
      Gets the value of the property stringConverter.
      Property description:
      Represents an optional converter to transform the progress value to a string. It is only used if a custom graphic node is not set.

    • setStringConverter

      public void setStringConverter(javafx.util.StringConverter<Double> stringConverter)
      Sets the value of the property stringConverter.
      Property description:
      Represents an optional converter to transform the progress value to a string. It is only used if a custom graphic node is not set.

    • reverseProperty

      public javafx.beans.property.ReadOnlyBooleanProperty reverseProperty()
      Reverses the progress indicator scale. For the indeterminate variant, this means it will be rotated counterclockwise.
      See Also:

    • isReverse

      public boolean isReverse()
      Gets the value of the property reverse.
      Property description:
      Reverses the progress indicator scale. For the indeterminate variant, this means it will be rotated counterclockwise.