Module com.dua3.utility.fx.controls

Package com.dua3.utility.fx.controls

Class WizardDialog

java.lang.Object

javafx.scene.control.Dialog<Map<String,Object>>

com.dua3.utility.fx.controls.WizardDialog

All Implemented Interfaces:

EventTarget

public class WizardDialog
extends Dialog<Map<String,Object>>

Represents a wizard dialog that guides the user through a sequence of pages. Each page can represent a step in a process, and the wizard dialog allows navigation between these steps.

Property Summary

Properties inherited from class javafx.scene.control.Dialog

contentText, dialogPane, graphic, headerText, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, resizable, resultConverter, result, showing, title, width, x, y

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WizardDialog.Page<D extends InputDialogPane<R>,R>	Wizard page information class.

Constructor Summary

Constructors

Constructor	Description
WizardDialog()	WizardDialog initializes a new dialog that handles the navigation and data collection of a sequence of wizard pages.

Method Summary

Modifier and Type	Method	Description
WizardDialog.Page<?,?>	getCurrentPage()	Retrieves the current wizard page.
boolean	isCancelable()	Check if dialog can be canceled.
boolean	isShowPreviousButton()	Check if a 'previous' ( or 'navigate-back') button should be displayed.
void	setPages(Map<String,WizardDialog.Page<?,?>> pages, String startPage)	Sets the wizard pages and the initial page to start from.

Methods inherited from class javafx.scene.control.Dialog

buildEventDispatchChain, close, contentTextProperty, dialogPaneProperty, getContentText, getDialogPane, getGraphic, getHeaderText, getHeight, getModality, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOwner, getResult, getResultConverter, getTitle, getWidth, getX, getY, graphicProperty, headerTextProperty, heightProperty, hide, initModality, initOwner, initStyle, isResizable, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, resizableProperty, resultConverterProperty, resultProperty, setContentText, setDialogPane, setGraphic, setHeaderText, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setResizable, setResult, setResultConverter, setTitle, setWidth, setX, setY, show, showAndWait, showingProperty, titleProperty, widthProperty, xProperty, yProperty

Methods inherited from class java.lang.Object

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

Constructor Details

WizardDialog

public WizardDialog()

WizardDialog initializes a new dialog that handles the navigation and data collection of a sequence of wizard pages.

Method Details

setPages

public void setPages(Map<String,WizardDialog.Page<?,?>> pages,
 String startPage)

Sets the wizard pages and the initial page to start from.

Parameters:

pages - a map where keys are page identifiers and values are the corresponding Page objects

startPage - the identifier of the page where the wizard dialog should start

isCancelable

public boolean isCancelable()

Check if dialog can be canceled.

Returns:

true if dialog is cancelable

isShowPreviousButton

public boolean isShowPreviousButton()

Check if a 'previous' ( or 'navigate-back') button should be displayed.

Returns:

true if dialog is cancelable

getCurrentPage

public WizardDialog.Page<?,?> getCurrentPage()

Retrieves the current wizard page.

Returns:

the current wizard page as a WizardDialog.Page object