GemsFX 3.10.1 · com.dlsc.gemsfx.DialogPane · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	DialogPane.BusyIndicator
private static class	DialogPane.CircularProgressIndicator
private class	DialogPane.ContentPane
public static class	DialogPane.DefaultResizeHandler The default resize handler is used to persist the dialog's width and height after the user performed a resize operation on the dialog.
public static class	DialogPane.Dialog< the type of value that the dialog can return T> Represents a dialog that can be displayed to the user.
public static class	DialogPane.DialogButtonBar The default footer / button bar implementation for dialogs managed by the `DialogPane`.
public static class	DialogPane.DialogHeader The default header implementation for dialogs managed by the `DialogPane`.
public static enum	DialogPane.Type The various dialog types supported by `DialogPane`.

Modifier and Type	Field and Description
private final BooleanProperty	animateDialogs
private final ObjectProperty<Duration>	animationDuration
private final ObjectProperty<StringConverter<ButtonType>>	converter
private final ObservableList<DialogPane.ContentPane>	dialogContentPanes
private final ListProperty<DialogPane.Dialog<?>>	dialogs
private final Map<DialogPane.ContentPane, DoubleProperty>	dialogVisibilityMap
private final EventHandler<KeyEvent>	escapeHandler
private final BooleanProperty	fadeInOut
private final ObjectProperty<Callback<DialogPane.Dialog<?>, Node>>	footerFactory
private final GlassPane	glassPane
private final ObjectProperty<Callback<DialogPane.Dialog<?>, Node>>	headerFactory
private final ObjectProperty<Supplier<Label>>	labelSupplier
private final DoubleProperty	maximizedPadding
private static final String	MESSAGE_LABEL_STYLE_CLASS
private final StringProperty	sendButtonText
private final ReadOnlyBooleanWrapper	showingDialog
private final WeakEventHandler<KeyEvent>	weakEscapeHandler

Access	Constructor and Description
public	DialogPane() Constructs a new dialog pane.

Method Summary

Modifier and Type	Method and Description
public final BooleanProperty	Returns: true if the dialog will be animated when appearing / disappearing animateDialogsProperty() Determines if the dialogs will be animated when they appear.
public final ObjectProperty<Duration>	Returns: the animation duration animationDurationProperty() Stores the duration used to animate the fly-in / fly-out of the dialogs.
public final ObjectProperty<StringConverter<ButtonType>>	Returns: a string converter converterProperty() A string converter can be applied to easily manipulate the default text representation of the various button types.
public final ListProperty<DialogPane.Dialog<?>>	Returns: the list of dialogs dialogsProperty() Stores the list of currently active dialogs.
private DialogPane.Dialog<ButtonType>	doShowDialog(DialogPane.Type type, String title, String message)
private DialogPane.Dialog<ButtonType>	doShowDialog(DialogPane.Type type, String title, String message, List<ButtonType> buttons)
private void	ensureNodeInChildrenList(Node node)
public final BooleanProperty	Returns: true if fade-in / fade-out will be used for showing / hiding dialogs fadeInOutProperty() Controls whether the glass pane and the dialogs will animate their opacity during showing or hiding dialogs.
public final ObjectProperty<Callback<DialogPane.Dialog<?>, Node>>	Returns: the header factory footerFactoryProperty() A callback used as a factory for creating the footer for each dialog.
public final Duration	getAnimationDuration()
public final StringConverter<ButtonType>	getConverter()
public final ObservableList<DialogPane.Dialog<?>>	Returns: the list of dialogs currently showing getDialogs() The list of currently active / showing dialogs.
public final Callback<DialogPane.Dialog<?>, Node>	getFooterFactory()
public final GlassPane	Returns: the glass pane object getGlassPane() Retrieves the glass pane associated with this dialog pane.
public final Callback<DialogPane.Dialog<?>, Node>	getHeaderFactory()
public final Supplier<Label>	getLabelSupplier()
public final double	getMaximizedPadding()
public final String	getSendButtonText()
public String	getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.
public final ObjectProperty<Callback<DialogPane.Dialog<?>, Node>>	Returns: the header factory headerFactoryProperty() A callback used as a factory for creating the header for each dialog.
public void	hideAllDialogs() Hides all currently active dialogs.
public void	hideDialog(DialogPane.Dialog<?> the dialog to hide dialog) Hides the given dialog.
public final boolean	isAnimateDialogs()
public final boolean	isFadeInOut()
public final boolean	isShowingDialog()
public final ObjectProperty<Supplier<Label>>	Returns: the label supplier / callback / factory labelSupplierProperty() A supplier used for creating the label instances that will be used by the standard dialogs.
protected void	layoutChildren() Overrides javafx.scene.layout.StackPane.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
public final DoubleProperty	Returns: the padding around a maximized dialog maximizedPaddingProperty() Defines the padding around a maximized dialog in the dialog pane.
public final StringProperty	sendButtonTextProperty()
public final void	setAnimateDialogs(boolean animate)
public final void	setAnimationDuration(Duration animationDuration)
public final void	setConverter(StringConverter<ButtonType> converter)
public final void	setDialogs(ObservableList<DialogPane.Dialog<?>> dialogs)
public final void	setFadeInOut(boolean animate)
public final void	setFooterFactory(Callback<DialogPane.Dialog<?>, Node> footerFactory)
public final void	setHeaderFactory(Callback<DialogPane.Dialog<?>, Node> headerFactory)
public final void	setLabelSupplier(Supplier<Label> labelSupplier)
public final void	setMaximizedPadding(double maximizedPadding)
public final void	setSendButtonText(String sendButtonText)
public final DialogPane.Dialog<Void>	Returns: the created dialog showBusyIndicator() Creates and shows a dialog that shows a busy indicator / busy animation.
public final DialogPane.Dialog<ButtonType>	Returns: the dialog showConfirmation(String the text shown in the header of the dialog title, String the main message, usually a question message) Creates and shows a confirmation dialog.
public final DialogPane.Dialog<ButtonType>	Returns: the dialog showConfirmation(String the text shown in the header of the dialog title, String the main message, usually a question message, List<ButtonType> the buttons to show in the footer buttonTypes) Creates and shows a confirmation dialog.
public void	showDialog(DialogPane.Dialog<?> the dialog to show dialog) Makes the given dialog visible in the pane.
public final DialogPane.Dialog<Void>	Returns: the dialog showError(String the title for the dialog title, String the main error message message) Creates and shows an error message dialog.
public final DialogPane.Dialog<Void>	Returns: the dialog showError(String the title for the dialog title, String the main error message message, Throwable an exception that will be used to provide more details exception) Creates and shows an error message dialog.
public final DialogPane.Dialog<Void>	Returns: the dialog showError(String the title for the dialog title, Exception an exception that will be used to provide the main message additional details exception) Creates and shows an error message dialog.
public final DialogPane.Dialog<Void>	Returns: the dialog showError(String the title for the dialog title, String the main error message message, String additional details details) Creates and shows an error message dialog.
public final DialogPane.Dialog<Void>	Returns: the dialog showError(String the title for the dialog title, String the main error message message, String additional details details, Runnable an optional action to send out / forward the error message onSend) Creates and shows an error message dialog.
public final DialogPane.Dialog<ButtonType>	Returns: the dialog showInformation(String the text shown in the header of the dialog title, String the main message, usually a question message) Creates and shows an information dialog.
public final DialogPane.Dialog<ButtonType>	Returns: the dialog showInformation(String the text shown in the header of the dialog title, String the main message, usually a question message, List<ButtonType> the list of buttons to create in the footer / button bar buttons) Creates and shows an information dialog.
public final ReadOnlyBooleanProperty	Returns: true if at least one dialog is currently showing showingDialogProperty() A read-only property used to signal that the pane is currently showing a dialog or not.
public final < the type of the value provided by the dialog T> DialogPane.Dialog<T>	Returns: the dialog showNode(DialogPane.Type the type of dialog (info, warning, error, ....) type, String the text shown in the title section / header of the dialog title, Node the node to show node) Shows an arbitrary node in a dialog.
public final < the type of the value provided by the dialog T> DialogPane.Dialog<T>	Returns: the dialog showNode(DialogPane.Type the type of dialog (info, warning, error, ....) type, String the text shown in the title section / header of the dialog title, Node the node to show node, boolean if true the dialog will use the maximum size available maximize) Shows an arbitrary node in a dialog.
public final < the type of the value provided by the dialog T> DialogPane.Dialog<T>	Returns: the dialog showNode(DialogPane.Type the type of dialog (info, warning, error, ....) type, String the text shown in the title section / header of the dialog title, Node the node to show node, List<ButtonType> a list of buttons to create inside the footer / button bar buttons) Shows an arbitrary node in a dialog.
public final < the type of the value provided by the dialog T> DialogPane.Dialog<T>	Returns: the dialog showNode(DialogPane.Type the type of dialog (info, warning, error, ....) type, String the text shown in the title section / header of the dialog title, Node the node to show node, boolean if true the dialog will use the maximum size available maximize, List<ButtonType> a list of buttons to create inside the footer / button bar buttons) Shows an arbitrary node in a dialog.
public final < the type of the value provided by the dialog T> DialogPane.Dialog<T>	Returns: the dialog showNode(DialogPane.Type the type of dialog (info, warning, error, ....) type, String the text shown in the title section / header of the dialog title, Node the node to show node, boolean if true the dialog will use the maximum size available maximize, List<ButtonType> a list of buttons to create inside the footer / button bar buttons, boolean if true all buttons in the footer / button bar will have the same width sameWidthButtons) Shows an arbitrary node in a dialog.
public final < the type of the value provided by the dialog T> DialogPane.Dialog<T>	Returns: the dialog showNode(DialogPane.Type the type of dialog (info, warning, error, ....) type, String the text shown in the title section / header of the dialog title, Node the node to show node, boolean if true the dialog will use the maximum size available maximize, List<ButtonType> a list of buttons to create inside the footer / button bar buttons, boolean if true all buttons in the footer / button bar will have the same width sameWidthButtons, BooleanProperty a validity property that will be bound to the validity property of the dialog validProperty) Shows an arbitrary node in a dialog.
public final DialogPane.Dialog<String>	Returns: the dialog showTextInput(String the text shown in the header of the dialog title, String the initial text to show text) Creates and shows a text input dialog.
public final DialogPane.Dialog<String>	Returns: the dialog showTextInput(String the text shown in the header of the dialog title, String the initial text to show text, boolean if true the dialog will show a text area, otherwise a text field multiline) Creates and shows a text input dialog.
public final DialogPane.Dialog<String>	Returns: the dialog showTextInput(String the text shown in the header of the dialog title, String the main message, usually a question message, String the initial text to show text, boolean if true the dialog will show a text area, otherwise a text field multiline) Creates and shows a text input dialog.
public final DialogPane.Dialog<String>	Returns: the dialog showTextInput(String the text shown in the header of the dialog title, String the main message, usually a question message, String the prompt text for the text input control prompt, String the initial text to show text, boolean if true the dialog will show a text area, otherwise a text field multiline) Creates and shows a text input dialog.
public final DialogPane.Dialog<String>	Returns: the dialog showTextInput(String the text shown in the header of the dialog title, String the main message, usually a question message, String the prompt text for the text input control prompt, String the initial text to show text, boolean if true the dialog will show a text area, otherwise a text field multiline, List<ButtonType> buttonTypes) Creates and shows a text input dialog.
public final DialogPane.Dialog<ButtonType>	Returns: the dialog showWarning(String the text shown in the header of the dialog title, String the warning message message) Creates and shows a warning dialog.
public final DialogPane.Dialog<ButtonType>	Returns: the dialog showWarning(String the text shown in the header of the dialog title, String the warning message message, List<ButtonType> buttonTypes) Creates and shows a warning dialog.
private void	slideInOut(double visibility, DoubleProperty visibilityProperty, Supplier<Node> nodeSupplier)

Inherited from javafx.scene.layout.StackPane:: alignmentProperty clearConstraints computeMinHeight computeMinWidth computePrefHeight computePrefWidth getAlignment getAlignment getClassCssMetaData getContentBias getCssMetaData getMargin requestLayout setAlignment setAlignment setMargin

public Class DialogPane

Example

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary