Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXProgressBar

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.ProgressIndicator

javafx.scene.control.ProgressBar

io.github.palexdev.materialfx.controls.MFXProgressBar

All Implemented Interfaces:

Themable, Styleable, EventTarget, Skinnable

public class MFXProgressBar
extends ProgressBar
implements Themable

This is the implementation of a progress bar following Google's material design guidelines.

Extends ProgressBar and redefines the style class to "mfx-progress-bar" for usage in CSS.

MFXProgressBar introduces three new css pseudo classes:

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

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

- ":range3", activated when the bar 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
StyleableDoubleProperty	animationSpeed	Specifies the indeterminate animation speed.

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

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.palexdev.materialfx.controls.base.Themable

Themable.Helper

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

Method Summary

Modifier and Type	Method	Description
StyleableDoubleProperty	animationSpeedProperty()	Specifies the indeterminate animation speed.
protected Skin<?>	createDefaultSkin()
double	getAnimationSpeed()	Gets the value of the animationSpeed property.
static List<CssMetaData<? extends Styleable,?>>	getClassCssMetaData()
protected List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
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.
Theme	getTheme()	Implementations of this should return the Theme responsible for styling themselves, most MaterialFX controls return one of the constants offered by Stylesheets.
void	setAnimationSpeed(double animationSpeed)	Sets the value of the animationSpeed property.
Parent	toParent()	Implementations should return the Parent node onto which themes and stylesheets will be applied.

Methods inherited from class javafx.scene.control.ProgressBar

getInitialFocusTraversable, queryAccessibleAttribute

Methods inherited from class javafx.scene.control.ProgressIndicator

getProgress, indeterminateProperty, isIndeterminate, progressProperty, setProgress

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, 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, 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

Methods inherited from interface io.github.palexdev.materialfx.controls.base.Themable

sceneBuilderIntegration

Property Details

animationSpeed

public StyleableDoubleProperty animationSpeedProperty

Specifies the indeterminate animation speed.

See Also:

• getAnimationSpeed()
• setAnimationSpeed(double)
• animationSpeedProperty()

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

MFXProgressBar

public MFXProgressBar()

MFXProgressBar

public MFXProgressBar(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.

getAnimationSpeed

public double getAnimationSpeed()

Gets the value of the animationSpeed property.

Property description:

Specifies the indeterminate animation speed.

Returns:

the value of the animationSpeed property

See Also:

• setAnimationSpeed(double)
• animationSpeedProperty()

animationSpeedProperty

public StyleableDoubleProperty animationSpeedProperty()

Specifies the indeterminate animation speed.

Returns:

the animationSpeed property

See Also:

• getAnimationSpeed()
• setAnimationSpeed(double)

setAnimationSpeed

public void setAnimationSpeed(double animationSpeed)

Sets the value of the animationSpeed property.

Property description:

Specifies the indeterminate animation speed.

Parameters:

animationSpeed - the value for the animationSpeed property

See Also:

• getAnimationSpeed()
• animationSpeedProperty()

getClassCssMetaData

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

toParent

public Parent toParent()

Description copied from interface: Themable

Implementations should return the Parent node onto which themes and stylesheets will be applied. Most of the case its themselves.

Specified by:

toParent in interface Themable

getTheme

public Theme getTheme()

Description copied from interface: Themable

Implementations of this should return the Theme responsible for styling themselves, most MaterialFX controls return one of the constants offered by Stylesheets.

Specified by:

getTheme in interface Themable

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class ProgressBar

getControlCssMetaData

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

Overrides:

getControlCssMetaData in class Control