Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXStepper

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

io.github.palexdev.materialfx.controls.MFXStepper

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

public class MFXStepper
extends Control

This is the implementation of a stepper/wizard following material design guidelines in JavaFX.

Steppers display progress through a sequence of logical and numbered steps. They may also be used for navigation.

Every stepper has a number of MFXStepperToggles that should be added to the list after instantiating the stepper. If the list is changed after the stepper has already been laid out then a reset() attempt is made.

The stepper has two properties to represent the current step index and the progress. The progress is computed as the number of COMPLETED toggles divided by the number of toggles. The progress is updated automatically, can be also forced by calling updateProgress().

NOTE: the stepper allows you to change the toggles even after it is already shown, it has been tested and it seems to work well. However, the stepper is intended to be a "static" control, that means you should plan ahead of time what toggles to place and their content.

See Also:

• MFXStepperToggle

Property Summary

Properties

Type	Property	Description
StyleableObjectProperty<Pos>	alignment	Specifies the alignment of the toggles.
StyleableObjectProperty<Paint>	altColor	Specifies the secondary color of the stepper.
StyleableBooleanProperty	animated	Specifies if the progress bar should be animated or not.
DoubleProperty	animationDuration	Specifies, in milliseconds, the duration of the progress bar animation.
StyleableObjectProperty<Paint>	baseColor	Specifies the base color of the stepper.
ReadOnlyObjectProperty<Node>	currentContent	Convenience property that holds the selected toggle content node.
ReadOnlyIntegerProperty	currentIndex	Specifies the selected toggle position in the toggles list.
StyleableDoubleProperty	extraSpacing	Specifies the extra length (at the start and at the end) of the progress bar.
ReadOnlyBooleanProperty	lastToggle	Convenience property that specifies if the last toggle is selected.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onBeforeNext	Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_NEXT_EVENT is fired.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onBeforePrevious	Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_PREVIOUS_EVENT is fired.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onLastNext	Specifies the action to perform when a MFXStepper.MFXStepperEvent.LAST_NEXT_EVENT is fired.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onNext	Specifies the action to perform when a MFXStepper.MFXStepperEvent.NEXT_EVENT is fired.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onPrevious	Specifies the action to perform when a MFXStepper.MFXStepperEvent.PREVIOUS_EVENT is fired.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onValidationFailed	Specifies the action to perform when a MFXStepper.MFXStepperEvent.VALIDATION_FAILED_EVENT is fired.
StyleableObjectProperty<Paint>	progressBarBackground	Specifies the progress bar background color (NOT THE PROGRESS COLOR).
StyleableDoubleProperty	progressBarBorderRadius	Specifies the borders radius of the progress bar.
StyleableObjectProperty<Paint>	progressColor	Specifies the progress color.
ReadOnlyDoubleProperty	progress	Specifies the stepper's progress, the number of COMPLETED toggles divided by the total number of toggles.
StyleableDoubleProperty	spacing	Specifies the spacing between toggles.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MFXStepper.MFXStepperEvent	Events class for MFXSteppers.

Field Summary

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
MFXStepper()
MFXStepper(List<MFXStepperToggle> stepperToggles)

Method Summary

Modifier and Type	Method	Description
StyleableObjectProperty<Pos>	alignmentProperty()	Specifies the alignment of the toggles.
StyleableObjectProperty<Paint>	altColorProperty()	Specifies the secondary color of the stepper.
StyleableBooleanProperty	animatedProperty()	Specifies if the progress bar should be animated or not.
DoubleProperty	animationDurationProperty()	Specifies, in milliseconds, the duration of the progress bar animation.
StyleableObjectProperty<Paint>	baseColorProperty()	Specifies the base color of the stepper.
protected Skin<?>	createDefaultSkin()
ReadOnlyObjectProperty<Node>	currentContentProperty()	Convenience property that holds the selected toggle content node.
ReadOnlyIntegerProperty	currentIndexProperty()	Specifies the selected toggle position in the toggles list.
StyleableDoubleProperty	extraSpacingProperty()	Specifies the extra length (at the start and at the end) of the progress bar.
void	fireEvent(EventType<MFXStepper.MFXStepperEvent> eventType)	Convenience method to fire MFXStepper.MFXStepperEvent events.
void	forceLayoutUpdate()	Forces the layout of the stepper to update.
Pos	getAlignment()	Gets the value of the property alignment.
Paint	getAltColor()	Gets the value of the property altColor.
double	getAnimationDuration()	Gets the value of the property animationDuration.
Paint	getBaseColor()	Gets the value of the property baseColor.
List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
static List<CssMetaData<? extends Styleable,?>>	getControlCssMetaDataList()
Node	getCurrentContent()	Gets the value of the property currentContent.
int	getCurrentIndex()	Gets the value of the property currentIndex.
MFXStepperToggle	getCurrentStepperNode()
double	getExtraSpacing()	Gets the value of the property extraSpacing.
EventHandler<MFXStepper.MFXStepperEvent>	getOnBeforeNext()	Gets the value of the property onBeforeNext.
EventHandler<MFXStepper.MFXStepperEvent>	getOnBeforePrevious()	Gets the value of the property onBeforePrevious.
EventHandler<MFXStepper.MFXStepperEvent>	getOnLastNext()	Gets the value of the property onLastNext.
EventHandler<MFXStepper.MFXStepperEvent>	getOnNext()	Gets the value of the property onNext.
EventHandler<MFXStepper.MFXStepperEvent>	getOnPrevious()	Gets the value of the property onPrevious.
EventHandler<MFXStepper.MFXStepperEvent>	getOnValidationFailed()	Gets the value of the property onValidationFailed.
double	getProgress()	Gets the value of the property progress.
Paint	getProgressBarBackground()	Gets the value of the property progressBarBackground.
double	getProgressBarBorderRadius()	Gets the value of the property progressBarBorderRadius.
Paint	getProgressColor()	Gets the value of the property progressColor.
double	getSpacing()	Gets the value of the property spacing.
ObservableList<MFXStepperToggle>	getStepperToggles()
String	getUserAgentStylesheet()
boolean	isAnimated()	Gets the value of the property animated.
boolean	isEnableContentValidationOnError()
boolean	isLastToggle()	Gets the value of the property lastToggle.
ReadOnlyBooleanProperty	lastToggleProperty()	Convenience property that specifies if the last toggle is selected.
void	next()	Goes to the next toggle if the validator's state is valid and updates the currentIndexProperty() accordingly.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onBeforeNextProperty()	Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_NEXT_EVENT is fired.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onBeforePreviousProperty()	Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_PREVIOUS_EVENT is fired.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onLastNextProperty()	Specifies the action to perform when a MFXStepper.MFXStepperEvent.LAST_NEXT_EVENT is fired.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onNextProperty()	Specifies the action to perform when a MFXStepper.MFXStepperEvent.NEXT_EVENT is fired.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onPreviousProperty()	Specifies the action to perform when a MFXStepper.MFXStepperEvent.PREVIOUS_EVENT is fired.
EventHandlerProperty<MFXStepper.MFXStepperEvent>	onValidationFailedProperty()	Specifies the action to perform when a MFXStepper.MFXStepperEvent.VALIDATION_FAILED_EVENT is fired.
void	previous()	Goes to the previous toggle and updates the currentIndexProperty() accordingly.
StyleableObjectProperty<Paint>	progressBarBackgroundProperty()	Specifies the progress bar background color (NOT THE PROGRESS COLOR).
StyleableDoubleProperty	progressBarBorderRadiusProperty()	Specifies the borders radius of the progress bar.
StyleableObjectProperty<Paint>	progressColorProperty()	Specifies the progress color.
ReadOnlyDoubleProperty	progressProperty()	Specifies the stepper's progress, the number of COMPLETED toggles divided by the total number of toggles.
void	reset()	Resets the stepper and all its toggles to the initial state.
void	setAlignment(Pos alignment)	Sets the value of the property alignment.
void	setAltColor(Paint altColor)	Sets the value of the property altColor.
void	setAnimated(boolean animated)	Sets the value of the property animated.
void	setAnimationDuration(double animationDuration)	Sets the value of the property animationDuration.
void	setBaseColor(Paint baseColor)	Sets the value of the property baseColor.
protected void	setCurrentContent(Node content)	Sets the value of the property currentContent.
protected void	setCurrentIndex(int currentIndex)	Sets the value of the property currentIndex.
void	setEnableContentValidationOnError(boolean enableContentValidationOnError)	Specifies if all the controls that implement Validated should be validated when the next button is pressed and the toggle state is ERROR.
void	setExtraSpacing(double extraSpacing)	Sets the value of the property extraSpacing.
protected void	setLastToggle(boolean lastToggle)	Sets the value of the property lastToggle.
void	setOnBeforeNext(EventHandler<MFXStepper.MFXStepperEvent> onBeforeNext)	Sets the value of the property onBeforeNext.
void	setOnBeforePrevious(EventHandler<MFXStepper.MFXStepperEvent> onBeforePrevious)	Sets the value of the property onBeforePrevious.
void	setOnLastNext(EventHandler<MFXStepper.MFXStepperEvent> onLastNext)	Sets the value of the property onLastNext.
void	setOnNext(EventHandler<MFXStepper.MFXStepperEvent> onNext)	Sets the value of the property onNext.
void	setOnPrevious(EventHandler<MFXStepper.MFXStepperEvent> onPrevious)	Sets the value of the property onPrevious.
void	setOnValidationFailed(EventHandler<MFXStepper.MFXStepperEvent> onValidationFailed)	Sets the value of the property onValidationFailed.
protected void	setProgress(double progress)	Sets the value of the property progress.
void	setProgressBarBackground(Paint progressBarBackground)	Sets the value of the property progressBarBackground.
void	setProgressBarBorderRadius(double progressBarBorderRadius)	Sets the value of the property progressBarBorderRadius.
void	setProgressColor(Paint progressColor)	Sets the value of the property progressColor.
void	setSpacing(double spacing)	Sets the value of the property spacing.
void	setStepperToggles(List<MFXStepperToggle> stepperToggles)	Replaces the stepper's toggles with the specified ones.
StyleableDoubleProperty	spacingProperty()	Specifies the spacing between toggles.
void	updateProgress()	Updates the progressProperty() by counting the number of COMPLETED toggles and dividing it by the total number of controls, so the progress values go from 0.0 to 1.0.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, 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

animationDuration

public DoubleProperty animationDurationProperty

Specifies, in milliseconds, the duration of the progress bar animation.

See Also:

• getAnimationDuration()
• setAnimationDuration(double)

progress

public ReadOnlyDoubleProperty progressProperty

Specifies the stepper's progress, the number of COMPLETED toggles divided by the total number of toggles. The values go from 0.0 to 1.0.

See Also:

• getProgress()
• setProgress(double)

currentIndex

public ReadOnlyIntegerProperty currentIndexProperty

Specifies the selected toggle position in the toggles list. The index is updated by next() and previous() methods.

See Also:

• getCurrentIndex()
• setCurrentIndex(int)

currentContent

public ReadOnlyObjectProperty<Node> currentContentProperty

Convenience property that holds the selected toggle content node.

In case one of the toggles has a null content the content pane's children list is cleared.

See Also:

• getCurrentContent()
• setCurrentContent(Node)

lastToggle

public ReadOnlyBooleanProperty lastToggleProperty

Convenience property that specifies if the last toggle is selected.

See Also:

• isLastToggle()
• setLastToggle(boolean)

spacing

public StyleableDoubleProperty spacingProperty

Specifies the spacing between toggles.

See Also:

• getSpacing()
• setSpacing(double)

extraSpacing

public StyleableDoubleProperty extraSpacingProperty

Specifies the extra length (at the start and at the end) of the progress bar.

See Also:

• getExtraSpacing()
• setExtraSpacing(double)

alignment

public StyleableObjectProperty<Pos> alignmentProperty

Specifies the alignment of the toggles. Steppers are usually centered though.

See Also:

• getAlignment()
• setAlignment(Pos)

baseColor

public StyleableObjectProperty<Paint> baseColorProperty

Specifies the base color of the stepper.

In the default CSS file this property affects: the progress color, the buttons background and borders when focused, also used for the buttons' ripple generators.

In the MFXStepperToggle CSS file this property affects:

- State NONE: the icon color

- State SELECTED: the background and borders, the label's text fill

- State COMPLETED: the borders

Default is: #7F0FFF (purple)

See Also:

• getBaseColor()
• setBaseColor(Paint)

altColor

public StyleableObjectProperty<Paint> altColorProperty

Specifies the secondary color of the stepper.

In the MFXStepperToggle CSS file this property affects:

- State NONE: the label's text fill

- State COMPLETED: the icon's color, the label's text fill

Default is: #BEBEBE (a light gray)

See Also:

• getAltColor()
• setAltColor(Paint)

progressBarBorderRadius

public StyleableDoubleProperty progressBarBorderRadiusProperty

Specifies the borders radius of the progress bar.

See Also:

• getProgressBarBorderRadius()
• setProgressBarBorderRadius(double)

progressBarBackground

public StyleableObjectProperty<Paint> progressBarBackgroundProperty

Specifies the progress bar background color (NOT THE PROGRESS COLOR).

In the MFXStepperToggle CSS file this property affects:

- State NONE: the toggle's background and borders. This is because if the toggle's background is transparent you will see the progress bar underneath them

Default is: #F8F8FF (almost white)

See Also:

• getProgressBarBackground()
• setProgressBarBackground(Paint)

progressColor

public StyleableObjectProperty<Paint> progressColorProperty

Specifies the progress color.

Default is: #7F0FFF (it's set to be the same as the base color)

See Also:

• getProgressColor()
• setProgressColor(Paint)

animated

public StyleableBooleanProperty animatedProperty

Specifies if the progress bar should be animated or not.

See Also:

• isAnimated()
• setAnimated(boolean)

onBeforeNext

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onBeforeNextProperty

Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_NEXT_EVENT is fired.

See Also:

• getOnBeforeNext()
• setOnBeforeNext(EventHandler)

onNext

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onNextProperty

Specifies the action to perform when a MFXStepper.MFXStepperEvent.NEXT_EVENT is fired.

See Also:

• getOnNext()
• setOnNext(EventHandler)

onBeforePrevious

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onBeforePreviousProperty

Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_PREVIOUS_EVENT is fired.

See Also:

• getOnBeforePrevious()
• setOnBeforePrevious(EventHandler)

onPrevious

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onPreviousProperty

Specifies the action to perform when a MFXStepper.MFXStepperEvent.PREVIOUS_EVENT is fired.

See Also:

• getOnPrevious()
• setOnPrevious(EventHandler)

onLastNext

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onLastNextProperty

Specifies the action to perform when a MFXStepper.MFXStepperEvent.LAST_NEXT_EVENT is fired.

See Also:

• getOnLastNext()
• setOnLastNext(EventHandler)

onValidationFailed

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onValidationFailedProperty

Specifies the action to perform when a MFXStepper.MFXStepperEvent.VALIDATION_FAILED_EVENT is fired.

See Also:

• getOnValidationFailed()
• setOnValidationFailed(EventHandler)

Constructor Details

MFXStepper

public MFXStepper()

MFXStepper

public MFXStepper(List<MFXStepperToggle> stepperToggles)

Method Details

next

public void next()

Goes to the next toggle if the validator's state is valid and updates the currentIndexProperty() accordingly.

Special case: if the last toggle is already selected then the progress bar reaches the 100%.

This method is also responsible for updating the toggles' state and firing the following events: MFXStepper.MFXStepperEvent.BEFORE_NEXT_EVENT, MFXStepper.MFXStepperEvent.NEXT_EVENT, MFXStepper.MFXStepperEvent.LAST_NEXT_EVENT, MFXStepper.MFXStepperEvent.VALIDATION_FAILED_EVENT.

previous

public void previous()

Goes to the previous toggle and updates the currentIndexProperty() accordingly.

This method is also responsible for updating the toggles' state and firing the following events: MFXStepper.MFXStepperEvent.BEFORE_PREVIOUS_EVENT, MFXStepper.MFXStepperEvent.PREVIOUS_EVENT.

reset

public void reset()

Resets the stepper and all its toggles to the initial state.

getCurrentStepperNode

public MFXStepperToggle getCurrentStepperNode()

Returns:

the current selected toggle by using the currentIndexProperty(), or null if an exception is captured.

updateProgress

public void updateProgress()

Updates the progressProperty() by counting the number of COMPLETED toggles and dividing it by the total number of controls, so the progress values go from 0.0 to 1.0.

getStepperToggles

public ObservableList<MFXStepperToggle> getStepperToggles()

Returns:

the stepper's toggles list

setStepperToggles

public void setStepperToggles(List<MFXStepperToggle> stepperToggles)

Replaces the stepper's toggles with the specified ones.

getAnimationDuration

public double getAnimationDuration()

Gets the value of the property animationDuration.

Property description:

Specifies, in milliseconds, the duration of the progress bar animation.

animationDurationProperty

public DoubleProperty animationDurationProperty()

Specifies, in milliseconds, the duration of the progress bar animation.

See Also:

• getAnimationDuration()
• setAnimationDuration(double)

setAnimationDuration

public void setAnimationDuration(double animationDuration)

Sets the value of the property animationDuration.

Property description:

Specifies, in milliseconds, the duration of the progress bar animation.

getProgress

public double getProgress()

Gets the value of the property progress.

Property description:

Specifies the stepper's progress, the number of COMPLETED toggles divided by the total number of toggles. The values go from 0.0 to 1.0.

progressProperty

public ReadOnlyDoubleProperty progressProperty()

Specifies the stepper's progress, the number of COMPLETED toggles divided by the total number of toggles. The values go from 0.0 to 1.0.

See Also:

• getProgress()
• setProgress(double)

setProgress

protected void setProgress(double progress)

Sets the value of the property progress.

Property description:

Specifies the stepper's progress, the number of COMPLETED toggles divided by the total number of toggles. The values go from 0.0 to 1.0.

getCurrentIndex

public int getCurrentIndex()

Gets the value of the property currentIndex.

Property description:

Specifies the selected toggle position in the toggles list. The index is updated by next() and previous() methods.

currentIndexProperty

public ReadOnlyIntegerProperty currentIndexProperty()

Specifies the selected toggle position in the toggles list. The index is updated by next() and previous() methods.

See Also:

• getCurrentIndex()
• setCurrentIndex(int)

setCurrentIndex

protected void setCurrentIndex(int currentIndex)

Sets the value of the property currentIndex.

Property description:

Specifies the selected toggle position in the toggles list. The index is updated by next() and previous() methods.

getCurrentContent

public Node getCurrentContent()

Gets the value of the property currentContent.

Property description:

Convenience property that holds the selected toggle content node.

In case one of the toggles has a null content the content pane's children list is cleared.

currentContentProperty

public ReadOnlyObjectProperty<Node> currentContentProperty()

Convenience property that holds the selected toggle content node.

In case one of the toggles has a null content the content pane's children list is cleared.

See Also:

• getCurrentContent()
• setCurrentContent(Node)

setCurrentContent

protected void setCurrentContent(Node content)

Sets the value of the property currentContent.

Property description:

Convenience property that holds the selected toggle content node.

In case one of the toggles has a null content the content pane's children list is cleared.

isLastToggle

public boolean isLastToggle()

Gets the value of the property lastToggle.

Property description:

Convenience property that specifies if the last toggle is selected.

lastToggleProperty

public ReadOnlyBooleanProperty lastToggleProperty()

Convenience property that specifies if the last toggle is selected.

See Also:

• isLastToggle()
• setLastToggle(boolean)

setLastToggle

protected void setLastToggle(boolean lastToggle)

Sets the value of the property lastToggle.

Property description:

Convenience property that specifies if the last toggle is selected.

isEnableContentValidationOnError

public boolean isEnableContentValidationOnError()

setEnableContentValidationOnError

public void setEnableContentValidationOnError(boolean enableContentValidationOnError)

Specifies if all the controls that implement Validated should be validated when the next button is pressed and the toggle state is ERROR.

getSpacing

public double getSpacing()

Gets the value of the property spacing.

Property description:

Specifies the spacing between toggles.

spacingProperty

public StyleableDoubleProperty spacingProperty()

Specifies the spacing between toggles.

See Also:

• getSpacing()
• setSpacing(double)

setSpacing

public void setSpacing(double spacing)

Sets the value of the property spacing.

Property description:

Specifies the spacing between toggles.

getExtraSpacing

public double getExtraSpacing()

Gets the value of the property extraSpacing.

Property description:

Specifies the extra length (at the start and at the end) of the progress bar.

extraSpacingProperty

public StyleableDoubleProperty extraSpacingProperty()

Specifies the extra length (at the start and at the end) of the progress bar.

See Also:

• getExtraSpacing()
• setExtraSpacing(double)

setExtraSpacing

public void setExtraSpacing(double extraSpacing)

Sets the value of the property extraSpacing.

Property description:

Specifies the extra length (at the start and at the end) of the progress bar.

getAlignment

public Pos getAlignment()

Gets the value of the property alignment.

Property description:

Specifies the alignment of the toggles. Steppers are usually centered though.

alignmentProperty

public StyleableObjectProperty<Pos> alignmentProperty()

Specifies the alignment of the toggles. Steppers are usually centered though.

See Also:

• getAlignment()
• setAlignment(Pos)

setAlignment

public void setAlignment(Pos alignment)

Sets the value of the property alignment.

Property description:

Specifies the alignment of the toggles. Steppers are usually centered though.

getBaseColor

public Paint getBaseColor()

Gets the value of the property baseColor.

Property description:

Specifies the base color of the stepper.

In the default CSS file this property affects: the progress color, the buttons background and borders when focused, also used for the buttons' ripple generators.

In the MFXStepperToggle CSS file this property affects:

- State NONE: the icon color

- State SELECTED: the background and borders, the label's text fill

- State COMPLETED: the borders

Default is: #7F0FFF (purple)

baseColorProperty

public StyleableObjectProperty<Paint> baseColorProperty()

Specifies the base color of the stepper.

In the default CSS file this property affects: the progress color, the buttons background and borders when focused, also used for the buttons' ripple generators.

In the MFXStepperToggle CSS file this property affects:

- State NONE: the icon color

- State SELECTED: the background and borders, the label's text fill

- State COMPLETED: the borders

Default is: #7F0FFF (purple)

See Also:

• getBaseColor()
• setBaseColor(Paint)

setBaseColor

public void setBaseColor(Paint baseColor)

Sets the value of the property baseColor.

Property description:

Specifies the base color of the stepper.

In the default CSS file this property affects: the progress color, the buttons background and borders when focused, also used for the buttons' ripple generators.

In the MFXStepperToggle CSS file this property affects:

- State NONE: the icon color

- State SELECTED: the background and borders, the label's text fill

- State COMPLETED: the borders

Default is: #7F0FFF (purple)

getAltColor

public Paint getAltColor()

Gets the value of the property altColor.

Property description:

Specifies the secondary color of the stepper.

In the MFXStepperToggle CSS file this property affects:

- State NONE: the label's text fill

- State COMPLETED: the icon's color, the label's text fill

Default is: #BEBEBE (a light gray)

altColorProperty

public StyleableObjectProperty<Paint> altColorProperty()

Specifies the secondary color of the stepper.

In the MFXStepperToggle CSS file this property affects:

- State NONE: the label's text fill

- State COMPLETED: the icon's color, the label's text fill

Default is: #BEBEBE (a light gray)

See Also:

• getAltColor()
• setAltColor(Paint)

setAltColor

public void setAltColor(Paint altColor)

Sets the value of the property altColor.

Property description:

Specifies the secondary color of the stepper.

In the MFXStepperToggle CSS file this property affects:

- State NONE: the label's text fill

- State COMPLETED: the icon's color, the label's text fill

Default is: #BEBEBE (a light gray)

getProgressBarBorderRadius

public double getProgressBarBorderRadius()

Gets the value of the property progressBarBorderRadius.

Property description:

Specifies the borders radius of the progress bar.

progressBarBorderRadiusProperty

public StyleableDoubleProperty progressBarBorderRadiusProperty()

Specifies the borders radius of the progress bar.

See Also:

• getProgressBarBorderRadius()
• setProgressBarBorderRadius(double)

setProgressBarBorderRadius

public void setProgressBarBorderRadius(double progressBarBorderRadius)

Sets the value of the property progressBarBorderRadius.

Property description:

Specifies the borders radius of the progress bar.

getProgressBarBackground

public Paint getProgressBarBackground()

Gets the value of the property progressBarBackground.

Property description:

Specifies the progress bar background color (NOT THE PROGRESS COLOR).

In the MFXStepperToggle CSS file this property affects:

- State NONE: the toggle's background and borders. This is because if the toggle's background is transparent you will see the progress bar underneath them

Default is: #F8F8FF (almost white)

progressBarBackgroundProperty

public StyleableObjectProperty<Paint> progressBarBackgroundProperty()

Specifies the progress bar background color (NOT THE PROGRESS COLOR).

In the MFXStepperToggle CSS file this property affects:

- State NONE: the toggle's background and borders. This is because if the toggle's background is transparent you will see the progress bar underneath them

Default is: #F8F8FF (almost white)

See Also:

• getProgressBarBackground()
• setProgressBarBackground(Paint)

setProgressBarBackground

public void setProgressBarBackground(Paint progressBarBackground)

Sets the value of the property progressBarBackground.

Property description:

Specifies the progress bar background color (NOT THE PROGRESS COLOR).

In the MFXStepperToggle CSS file this property affects:

- State NONE: the toggle's background and borders. This is because if the toggle's background is transparent you will see the progress bar underneath them

Default is: #F8F8FF (almost white)

getProgressColor

public Paint getProgressColor()

Gets the value of the property progressColor.

Property description:

Specifies the progress color.

Default is: #7F0FFF (it's set to be the same as the base color)

progressColorProperty

public StyleableObjectProperty<Paint> progressColorProperty()

Specifies the progress color.

Default is: #7F0FFF (it's set to be the same as the base color)

See Also:

• getProgressColor()
• setProgressColor(Paint)

setProgressColor

public void setProgressColor(Paint progressColor)

Sets the value of the property progressColor.

Property description:

Specifies the progress color.

Default is: #7F0FFF (it's set to be the same as the base color)

isAnimated

public boolean isAnimated()

Gets the value of the property animated.

Property description:

Specifies if the progress bar should be animated or not.

animatedProperty

public StyleableBooleanProperty animatedProperty()

Specifies if the progress bar should be animated or not.

See Also:

• isAnimated()
• setAnimated(boolean)

setAnimated

public void setAnimated(boolean animated)

Sets the value of the property animated.

Property description:

Specifies if the progress bar should be animated or not.

getControlCssMetaDataList

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

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

getControlCssMetaData

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

Overrides:

getControlCssMetaData in class Control

getUserAgentStylesheet

public String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class Region

getOnBeforeNext

public EventHandler<MFXStepper.MFXStepperEvent> getOnBeforeNext()

Gets the value of the property onBeforeNext.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_NEXT_EVENT is fired.

onBeforeNextProperty

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onBeforeNextProperty()

Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_NEXT_EVENT is fired.

See Also:

• getOnBeforeNext()
• setOnBeforeNext(EventHandler)

setOnBeforeNext

public void setOnBeforeNext(EventHandler<MFXStepper.MFXStepperEvent> onBeforeNext)

Sets the value of the property onBeforeNext.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_NEXT_EVENT is fired.

getOnNext

public EventHandler<MFXStepper.MFXStepperEvent> getOnNext()

Gets the value of the property onNext.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.NEXT_EVENT is fired.

onNextProperty

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onNextProperty()

Specifies the action to perform when a MFXStepper.MFXStepperEvent.NEXT_EVENT is fired.

See Also:

• getOnNext()
• setOnNext(EventHandler)

setOnNext

public void setOnNext(EventHandler<MFXStepper.MFXStepperEvent> onNext)

Sets the value of the property onNext.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.NEXT_EVENT is fired.

getOnBeforePrevious

public EventHandler<MFXStepper.MFXStepperEvent> getOnBeforePrevious()

Gets the value of the property onBeforePrevious.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_PREVIOUS_EVENT is fired.

onBeforePreviousProperty

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onBeforePreviousProperty()

Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_PREVIOUS_EVENT is fired.

See Also:

• getOnBeforePrevious()
• setOnBeforePrevious(EventHandler)

setOnBeforePrevious

public void setOnBeforePrevious(EventHandler<MFXStepper.MFXStepperEvent> onBeforePrevious)

Sets the value of the property onBeforePrevious.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.BEFORE_PREVIOUS_EVENT is fired.

getOnPrevious

public EventHandler<MFXStepper.MFXStepperEvent> getOnPrevious()

Gets the value of the property onPrevious.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.PREVIOUS_EVENT is fired.

onPreviousProperty

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onPreviousProperty()

Specifies the action to perform when a MFXStepper.MFXStepperEvent.PREVIOUS_EVENT is fired.

See Also:

• getOnPrevious()
• setOnPrevious(EventHandler)

setOnPrevious

public void setOnPrevious(EventHandler<MFXStepper.MFXStepperEvent> onPrevious)

Sets the value of the property onPrevious.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.PREVIOUS_EVENT is fired.

getOnLastNext

public EventHandler<MFXStepper.MFXStepperEvent> getOnLastNext()

Gets the value of the property onLastNext.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.LAST_NEXT_EVENT is fired.

onLastNextProperty

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onLastNextProperty()

Specifies the action to perform when a MFXStepper.MFXStepperEvent.LAST_NEXT_EVENT is fired.

See Also:

• getOnLastNext()
• setOnLastNext(EventHandler)

setOnLastNext

public void setOnLastNext(EventHandler<MFXStepper.MFXStepperEvent> onLastNext)

Sets the value of the property onLastNext.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.LAST_NEXT_EVENT is fired.

getOnValidationFailed

public EventHandler<MFXStepper.MFXStepperEvent> getOnValidationFailed()

Gets the value of the property onValidationFailed.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.VALIDATION_FAILED_EVENT is fired.

onValidationFailedProperty

public EventHandlerProperty<MFXStepper.MFXStepperEvent> onValidationFailedProperty()

Specifies the action to perform when a MFXStepper.MFXStepperEvent.VALIDATION_FAILED_EVENT is fired.

See Also:

• getOnValidationFailed()
• setOnValidationFailed(EventHandler)

setOnValidationFailed

public void setOnValidationFailed(EventHandler<MFXStepper.MFXStepperEvent> onValidationFailed)

Sets the value of the property onValidationFailed.

Property description:

Specifies the action to perform when a MFXStepper.MFXStepperEvent.VALIDATION_FAILED_EVENT is fired.

fireEvent

public void fireEvent(EventType<MFXStepper.MFXStepperEvent> eventType)

Convenience method to fire MFXStepper.MFXStepperEvent events.

forceLayoutUpdate

public void forceLayoutUpdate()

Forces the layout of the stepper to update.