Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXProgressSpinner

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.ProgressIndicator

io.github.palexdev.materialfx.controls.MFXProgressSpinner

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

public class MFXProgressSpinner
extends ProgressIndicator

Implementation of a spinning ProgressIndicator.

Extends ProgressIndicator.

MFXProgressSpinner introduces three new css pseudo classes:

- ":range1", activated when the spinner value is contained in any of the ranges specified in here getRanges1()

- ":range2", activated when the spinner value is contained in any of the ranges specified in here getRanges2()

- ":range3", activated when the spinner value is contained in any of the ranges specified in here getRanges3()

I know this may seem a strange approach, but it is much more flexible and allows for a lot more customization.

Property Summary

Properties

Type	Property	Description
StyleableObjectProperty<Color>	color1	Specifies the first color of the spinner arc.
StyleableObjectProperty<Color>	color2	Specifies the second color of the spinner arc.
StyleableObjectProperty<Color>	color3	Specifies the third color of the spinner arc.
StyleableObjectProperty<Color>	color4	Specifies the fourth color of the spinner arc.
StyleableDoubleProperty	radius	Specifies the radius of the progress spinner.
StyleableDoubleProperty	startingAngle	Specifies the angle at which the spinner will start.

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, 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 PseudoClass	RANGE1_PSEUDO_CLASS
protected final PseudoClass	RANGE2_PSEUDO_CLASS
protected final PseudoClass	RANGE3_PSEUDO_CLASS

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
MFXProgressSpinner()
MFXProgressSpinner(double progress)

Method Summary

Modifier and Type	Method	Description
StyleableObjectProperty<Color>	color1Property()	Specifies the first color of the spinner arc.
StyleableObjectProperty<Color>	color2Property()	Specifies the second color of the spinner arc.
StyleableObjectProperty<Color>	color3Property()	Specifies the third color of the spinner arc.
StyleableObjectProperty<Color>	color4Property()	Specifies the fourth color of the spinner arc.
protected Skin<?>	createDefaultSkin()
Color	getColor1()	Gets the value of the property color1.
Color	getColor2()	Gets the value of the property color2.
Color	getColor3()	Gets the value of the property color3.
Color	getColor4()	Gets the value of the property color4.
protected List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
static List<CssMetaData<? extends Styleable,?>>	getControlCssMetaDataList()
double	getRadius()	Gets the value of the property radius.
ObservableList<NumberRange<Double>>	getRanges1()	Returns the first list of ranges.
ObservableList<NumberRange<Double>>	getRanges2()	Returns the second list of ranges.
ObservableList<NumberRange<Double>>	getRanges3()	Returns the third list of ranges.
double	getStartingAngle()	Gets the value of the property startingAngle.
String	getUserAgentStylesheet()
StyleableDoubleProperty	radiusProperty()	Specifies the radius of the progress spinner.
void	setColor1(Color color1)	Sets the value of the property color1.
void	setColor2(Color color2)	Sets the value of the property color2.
void	setColor3(Color color3)	Sets the value of the property color3.
void	setColor4(Color color4)	Sets the value of the property color4.
void	setRadius(double radius)	Sets the value of the property radius.
void	setStartingAngle(double startingAngle)	Sets the value of the property startingAngle.
StyleableDoubleProperty	startingAngleProperty()	Specifies the angle at which the spinner will start.

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, 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, 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, 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, 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

color1

public StyleableObjectProperty<Color> color1Property

Specifies the first color of the spinner arc.

See Also:

• getColor1()
• setColor1(Color)

color2

public StyleableObjectProperty<Color> color2Property

Specifies the second color of the spinner arc.

See Also:

• getColor2()
• setColor2(Color)

color3

public StyleableObjectProperty<Color> color3Property

Specifies the third color of the spinner arc.

See Also:

• getColor3()
• setColor3(Color)

color4

public StyleableObjectProperty<Color> color4Property

Specifies the fourth color of the spinner arc.

See Also:

• getColor4()
• setColor4(Color)

radius

public StyleableDoubleProperty radiusProperty

Specifies the radius of the progress spinner.

startingAngle

public StyleableDoubleProperty startingAngleProperty

Specifies the angle at which the spinner will start.

Field Details

RANGE1_PSEUDO_CLASS

protected final PseudoClass RANGE1_PSEUDO_CLASS

RANGE2_PSEUDO_CLASS

protected final PseudoClass RANGE2_PSEUDO_CLASS

RANGE3_PSEUDO_CLASS

protected final PseudoClass RANGE3_PSEUDO_CLASS

Constructor Details

MFXProgressSpinner

public MFXProgressSpinner()

MFXProgressSpinner

public MFXProgressSpinner(double progress)

Method Details

getRanges1

public ObservableList<NumberRange<Double>> getRanges1()

Returns the first list of ranges.

getRanges2

public ObservableList<NumberRange<Double>> getRanges2()

Returns the second list of ranges.

getRanges3

public ObservableList<NumberRange<Double>> getRanges3()

Returns the third list of ranges.

getColor1

public Color getColor1()

Gets the value of the property color1.

Property description:

Specifies the first color of the spinner arc.

color1Property

public StyleableObjectProperty<Color> color1Property()

Specifies the first color of the spinner arc.

See Also:

• getColor1()
• setColor1(Color)

setColor1

public void setColor1(Color color1)

Sets the value of the property color1.

Property description:

Specifies the first color of the spinner arc.

getColor2

public Color getColor2()

Gets the value of the property color2.

Property description:

Specifies the second color of the spinner arc.

color2Property

public StyleableObjectProperty<Color> color2Property()

Specifies the second color of the spinner arc.

See Also:

• getColor2()
• setColor2(Color)

setColor2

public void setColor2(Color color2)

Sets the value of the property color2.

Property description:

Specifies the second color of the spinner arc.

getColor3

public Color getColor3()

Gets the value of the property color3.

Property description:

Specifies the third color of the spinner arc.

color3Property

public StyleableObjectProperty<Color> color3Property()

Specifies the third color of the spinner arc.

See Also:

• getColor3()
• setColor3(Color)

setColor3

public void setColor3(Color color3)

Sets the value of the property color3.

Property description:

Specifies the third color of the spinner arc.

getColor4

public Color getColor4()

Gets the value of the property color4.

Property description:

Specifies the fourth color of the spinner arc.

color4Property

public StyleableObjectProperty<Color> color4Property()

Specifies the fourth color of the spinner arc.

See Also:

• getColor4()
• setColor4(Color)

setColor4

public void setColor4(Color color4)

Sets the value of the property color4.

Property description:

Specifies the fourth color of the spinner arc.

getRadius

public double getRadius()

Gets the value of the property radius.

Property description:

Specifies the radius of the spinner.

radiusProperty

public StyleableDoubleProperty radiusProperty()

Specifies the radius of the progress spinner.

setRadius

public void setRadius(double radius)

Sets the value of the property radius.

Property description:

Specifies the radius of the spinner.

getStartingAngle

public double getStartingAngle()

Gets the value of the property startingAngle.

Property description:

Specifies the starting angle of the animation.

startingAngleProperty

public StyleableDoubleProperty startingAngleProperty()

Specifies the angle at which the spinner will start.

setStartingAngle

public void setStartingAngle(double startingAngle)

Sets the value of the property startingAngle.

Property description:

Specifies the starting angle of the animation.

getControlCssMetaDataList

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

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class ProgressIndicator

getUserAgentStylesheet

public String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class Region

getControlCssMetaData

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

Overrides:

getControlCssMetaData in class Control