Module com.dlsc.gemsfx
Package com.dlsc.gemsfx

Class DialogPane.Dialog<T>

java.lang.Object
com.dlsc.gemsfx.DialogPane.Dialog<T>
Type Parameters:
T - the type of value that the dialog can return
Enclosing class:
DialogPane
public static class DialogPane.Dialog<T> extends Object
Represents a dialog that can be displayed to the user.

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.geometry.Pos>
    contentAlignment
    Determines how the content node is positioned within the content pane of the dialog.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    content
    Stores the content shown in the center of the dialog.
    final javafx.beans.property.ObjectProperty<javafx.util.Duration>
    delay
    A property that can be used to delay the appearance of the dialog inside the dialog pane.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    extras
    An extra node that might be displayed in the header or the footer of the dialog.
    final javafx.beans.property.StringProperty
    id
    Stores an optional ID for the dialog, which can be handy for various situations.
    final javafx.beans.property.DoubleProperty
    maxHeight
     
    final javafx.beans.property.BooleanProperty
    maximize
    If maximized the dialog will try to use as much width and height inside the dialog pane as possible.
    final javafx.beans.property.DoubleProperty
    maxWidth
     
    final javafx.beans.property.DoubleProperty
    minHeight
     
    final javafx.beans.property.DoubleProperty
    minWidth
     
    final javafx.beans.property.ObjectProperty<Consumer<javafx.scene.control.ButtonType>>
    onClose
     
    final javafx.beans.property.ObjectProperty<BiConsumer<Double,Double>>
    onResize
    A callback used to inform interested parties when the user changed the width or height of the dialog.
    final javafx.beans.property.ObjectProperty<Preferences>
    preferences
    Stores a reference to a preferences object which can be used to persist the width and height of the dialog across user sessions.
    final javafx.beans.property.DoubleProperty
    prefHeight
     
    final javafx.beans.property.DoubleProperty
    prefWidth
     
    final javafx.beans.property.BooleanProperty
    required
    A flag used to signal to the framework that input is required in this dialog.
    final javafx.beans.property.BooleanProperty
    resizable
    Determines if the user will be able to interactively resize the dialog.
    final javafx.beans.property.BooleanProperty
    sameWidthButtons
    Determines if the buttons in the button bar will all have the same width or each one will have its preferred width.
    final javafx.beans.property.BooleanProperty
    showCloseButton
    Determines if the dialog will make a "close" button available to the user.
    final javafx.beans.property.BooleanProperty
    showFooter
    Determines if the dialog will show the button bar / footer at the bottom or not.
    final javafx.beans.property.BooleanProperty
    showHeader
    Determines if the dialog will show the title / header at the bottom or not.
    final javafx.beans.property.StringProperty
    title
     
    final javafx.beans.property.BooleanProperty
    usingPadding
    Controls whether additional padding will be applied "around" the content node.
    final javafx.beans.property.ObjectProperty<net.synedra.validatorfx.Validator>
    validator
    A validator that can be used in the context of this dialog.
    final javafx.beans.property.BooleanProperty
    valid
    Determines whether the values entered in the dialog are currently valid and will be accepted by the application.
    final javafx.beans.property.ObjectProperty<T>
    value
    Stores the value entered or selected by the user in the dialog.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Dialog(DialogPane pane, DialogPane.Type type)
    Creates a new dialog with the specified dialog pane and type.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancel()
    Hides the dialog by cancelling it.
    final javafx.beans.property.ObjectProperty<javafx.geometry.Pos>
    contentAlignmentProperty()
    Determines how the content node is positioned within the content pane of the dialog.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    contentProperty()
    Stores the content shown in the center of the dialog.
    final javafx.beans.property.ObjectProperty<javafx.util.Duration>
    delayProperty()
    A property that can be used to delay the appearance of the dialog inside the dialog pane.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    extrasProperty()
    An extra node that might be displayed in the header or the footer of the dialog.
    final javafx.scene.control.Button
    getButton(javafx.scene.control.ButtonType type)
    Returns the button created for the given button type, but only if such a button type was requested for the dialog.
    final javafx.collections.ObservableList<javafx.scene.control.ButtonType>
    getButtonTypes()
     
    final javafx.scene.Node
    getContent()
    Gets the value of the property content.
    final javafx.geometry.Pos
    getContentAlignment()
    Gets the value of the property contentAlignment.
    final javafx.util.Duration
    getDelay()
    Gets the value of the property delay.
    final DialogPane
    getDialogPane()
    Returns the dialog pane where the dialog is showing.
    final javafx.scene.Node
    getExtras()
    Gets the value of the property extras.
    final String
    getId()
    Gets the value of the property id.
    final double
    getMaxHeight()
    Gets the value of the property maxHeight.
    final double
    getMaxWidth()
    Gets the value of the property maxWidth.
    final double
    getMinHeight()
    Gets the value of the property minHeight.
    final double
    getMinWidth()
    Gets the value of the property minWidth.
    Consumer<javafx.scene.control.ButtonType>
    getOnButtonPressed()
     
    final Consumer<javafx.scene.control.ButtonType>
    getOnClose()
    Gets the value of the property onClose.
    final BiConsumer<Double,Double>
    getOnResize()
    Gets the value of the property onResize.
    final Preferences
    getPreferences()
    Gets the value of the property preferences.
    final double
    getPrefHeight()
    Gets the value of the property prefHeight.
    final double
    getPrefWidth()
    Gets the value of the property prefWidth.
    final javafx.collections.ObservableList<String>
    getStyleClass()
    A list with additional styles that will be added to the content pane of the dialog.
    final String
    getTitle()
    The title for the dialog.
    final DialogPane.Type
    getType()
    Returns the type of the dialog, e.g.
    final net.synedra.validatorfx.Validator
    getValidator()
    Gets the value of the property validator.
    final T
    getValue()
    Gets the value of the property value.
    final javafx.beans.property.StringProperty
    idProperty()
    Stores an optional ID for the dialog, which can be handy for various situations.
    final boolean
    isMaximize()
    Gets the value of the property maximize.
    final boolean
    isRequired()
    Gets the value of the property required.
    final boolean
    isResizable()
    Gets the value of the property resizable.
    final boolean
    isSameWidthButtons()
    Gets the value of the property sameWidthButtons.
    final boolean
    isShowCloseButton()
    Gets the value of the property showCloseButton.
    final boolean
    isShowFooter()
    Gets the value of the property showFooter.
    final boolean
    isShowHeader()
    Gets the value of the property showHeader.
    final boolean
    isUsingPadding()
    Gets the value of the property usingPadding.
    final boolean
    isValid()
    Gets the value of the property valid.
    final javafx.beans.property.DoubleProperty
    maxHeightProperty()
     
    final javafx.beans.property.BooleanProperty
    maximizeProperty()
    If maximized the dialog will try to use as much width and height inside the dialog pane as possible.
    final javafx.beans.property.DoubleProperty
    maxWidthProperty()
     
    final javafx.beans.property.DoubleProperty
    minHeightProperty()
     
    final javafx.beans.property.DoubleProperty
    minWidthProperty()
     
    final DialogPane.Dialog<T>
    onClose(Consumer<javafx.scene.control.ButtonType> onCommit)
    A method in fluent-api style that sets the given consumer and returns the dialog again.
    final javafx.beans.property.ObjectProperty<Consumer<javafx.scene.control.ButtonType>>
    onCloseProperty()
     
    final javafx.beans.property.ObjectProperty<BiConsumer<Double,Double>>
    onResizeProperty()
    A callback used to inform interested parties when the user changed the width or height of the dialog.
    final javafx.beans.property.ObjectProperty<Preferences>
    preferencesProperty()
    Stores a reference to a preferences object which can be used to persist the width and height of the dialog across user sessions.
    final javafx.beans.property.DoubleProperty
    prefHeightProperty()
     
    final javafx.beans.property.DoubleProperty
    prefWidthProperty()
     
    final javafx.beans.property.BooleanProperty
    requiredProperty()
    A flag used to signal to the framework that input is required in this dialog.
    final javafx.beans.property.BooleanProperty
    resizableProperty()
    Determines if the user will be able to interactively resize the dialog.
    final javafx.beans.property.BooleanProperty
    sameWidthButtonsProperty()
    Determines if the buttons in the button bar will all have the same width or each one will have its preferred width.
    final void
    setContent(javafx.scene.Node content)
    Sets the value of the property content.
    final void
    setContentAlignment(javafx.geometry.Pos contentAlignment)
    Sets the value of the property contentAlignment.
    final void
    setDelay(javafx.util.Duration delay)
    Sets the value of the property delay.
    final void
    setExtras(javafx.scene.Node extras)
    Sets the value of the property extras.
    final void
    setId(String id)
    Sets the value of the property id.
    final void
    setMaxHeight(double maxHeight)
    Sets the value of the property maxHeight.
    final void
    setMaximize(boolean max)
    Sets the value of the property maximize.
    final void
    setMaxWidth(double maxWidth)
    Sets the value of the property maxWidth.
    final void
    setMinHeight(double minHeight)
    Sets the value of the property minHeight.
    final void
    setMinWidth(double minWidth)
    Sets the value of the property minWidth.
    final void
    setOnButtonPressed(Consumer<javafx.scene.control.ButtonType> onButtonPressed)
    Specifies a consumer that gets invoked when the user presses on of the standard dialog buttons.
    final void
    setOnClose(Consumer<javafx.scene.control.ButtonType> onClose)
    Sets the value of the property onClose.
    final void
    setOnResize(BiConsumer<Double,Double> onResize)
    Sets the value of the property onResize.
    final void
    setPreferences(Preferences preferences)
    Sets the value of the property preferences.
    final void
    setPrefHeight(double prefHeight)
    Sets the value of the property prefHeight.
    final void
    setPrefWidth(double prefWidth)
    Sets the value of the property prefWidth.
    final void
    setRequired(boolean required)
    Sets the value of the property required.
    final void
    setResizable(boolean resizable)
    Sets the value of the property resizable.
    final void
    setSameWidthButtons(boolean sameWidthButtons)
    Sets the value of the property sameWidthButtons.
    final void
    setShowCloseButton(boolean showCloseButton)
    Sets the value of the property showCloseButton.
    final void
    setShowFooter(boolean showFooter)
    Sets the value of the property showFooter.
    final void
    setShowHeader(boolean showHeader)
    Sets the value of the property showHeader.
    final void
    setTitle(String title)
    Sets the value of the property title.
    final void
    setUsingPadding(boolean usingPadding)
    Sets the value of the property usingPadding.
    final void
    setValid(boolean valid)
    Sets the value of the property valid.
    final void
    setValidator(net.synedra.validatorfx.Validator validator)
    Sets the value of the property validator.
    final void
    setValue(T value)
    Sets the value of the property value.
    void
    show()
     
    final javafx.beans.property.BooleanProperty
    showCloseButtonProperty()
    Determines if the dialog will make a "close" button available to the user.
    final javafx.beans.property.BooleanProperty
    showFooterProperty()
    Determines if the dialog will show the button bar / footer at the bottom or not.
    final javafx.beans.property.BooleanProperty
    showHeaderProperty()
    Determines if the dialog will show the title / header at the bottom or not.
    final javafx.beans.property.StringProperty
    titleProperty()
     
    final javafx.beans.property.BooleanProperty
    usingPaddingProperty()
    Controls whether additional padding will be applied "around" the content node.
    final javafx.beans.property.ObjectProperty<net.synedra.validatorfx.Validator>
    validatorProperty()
    A validator that can be used in the context of this dialog.
    final javafx.beans.property.BooleanProperty
    validProperty()
    Determines whether the values entered in the dialog are currently valid and will be accepted by the application.
    final javafx.beans.property.ObjectProperty<T>
    valueProperty()
    Stores the value entered or selected by the user in the dialog.

    Methods inherited from class java.lang.Object

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

  • Property Details

    • id

      public final javafx.beans.property.StringProperty idProperty
      Stores an optional ID for the dialog, which can be handy for various situations.
      See Also:

    • preferences

      public final javafx.beans.property.ObjectProperty<Preferences> preferencesProperty
      Stores a reference to a preferences object which can be used to persist the width and height of the dialog across user sessions.
      See Also:

    • prefWidth

      public final javafx.beans.property.DoubleProperty prefWidthProperty
      See Also:

    • prefHeight

      public final javafx.beans.property.DoubleProperty prefHeightProperty
      See Also:

    • minWidth

      public final javafx.beans.property.DoubleProperty minWidthProperty
      See Also:

    • minHeight

      public final javafx.beans.property.DoubleProperty minHeightProperty
      See Also:

    • maxWidth

      public final javafx.beans.property.DoubleProperty maxWidthProperty
      See Also:

    • maxHeight

      public final javafx.beans.property.DoubleProperty maxHeightProperty
      See Also:

    • onResize

      public final javafx.beans.property.ObjectProperty<BiConsumer<Double,Double>> onResizeProperty
      A callback used to inform interested parties when the user changed the width or height of the dialog.
      See Also:

    • required

      public final javafx.beans.property.BooleanProperty requiredProperty
      A flag used to signal to the framework that input is required in this dialog. This is useful when showing things like text inputs where we automatically want to add a validator.
      See Also:

    • showCloseButton

      public final javafx.beans.property.BooleanProperty showCloseButtonProperty
      Determines if the dialog will make a "close" button available to the user. Whether this property will be observed or not depends on the actual header implementation. The default implementation of the header does contain a close button.
      See Also:

    • delay

      public final javafx.beans.property.ObjectProperty<javafx.util.Duration> delayProperty
      A property that can be used to delay the appearance of the dialog inside the dialog pane. This is very useful for dialogs that display a busy animation or a progress indicator as usually you only want those to appear if a background operation takes a while.
      See Also:

    • usingPadding

      public final javafx.beans.property.BooleanProperty usingPaddingProperty
      Controls whether additional padding will be applied "around" the content node. The actual amount of padding depends on the CSS rules.
      See Also:

    • contentAlignment

      public final javafx.beans.property.ObjectProperty<javafx.geometry.Pos> contentAlignmentProperty
      Determines how the content node is positioned within the content pane of the dialog. Default is CENTER_LEFT.
      See Also:

    • value

      public final javafx.beans.property.ObjectProperty<T> valueProperty
      Stores the value entered or selected by the user in the dialog. If the dialog is, for example, a text input dialog then the value will be the text entered into the text field of the dialog.
      See Also:

    • onClose

      public final javafx.beans.property.ObjectProperty<Consumer<javafx.scene.control.ButtonType>> onCloseProperty
      See Also:

    • valid

      public final javafx.beans.property.BooleanProperty validProperty
      Determines whether the values entered in the dialog are currently valid and will be accepted by the application. The validity is normally determines by the validator object.
      See Also:

    • sameWidthButtons

      public final javafx.beans.property.BooleanProperty sameWidthButtonsProperty
      Determines if the buttons in the button bar will all have the same width or each one will have its preferred width.
      See Also:

    • maximize

      public final javafx.beans.property.BooleanProperty maximizeProperty
      If maximized the dialog will try to use as much width and height inside the dialog pane as possible.
      See Also:

    • content

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> contentProperty
      Stores the content shown in the center of the dialog.
      See Also:

    • extras

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> extrasProperty
      An extra node that might be displayed in the header or the footer of the dialog. This node will only be shown if custom header or footer factories make use of it. By default this node will not be visible anywhere.
      See Also:

    • title

      public final javafx.beans.property.StringProperty titleProperty
      See Also:

    • showHeader

      public final javafx.beans.property.BooleanProperty showHeaderProperty
      Determines if the dialog will show the title / header at the bottom or not.
      See Also:

    • showFooter

      public final javafx.beans.property.BooleanProperty showFooterProperty
      Determines if the dialog will show the button bar / footer at the bottom or not.
      See Also:

    • validator

      public final javafx.beans.property.ObjectProperty<net.synedra.validatorfx.Validator> validatorProperty
      A validator that can be used in the context of this dialog. Applications can call Validator.createCheck() to add one or more checks which will be validated once the user tries to commit the dialog.
      See Also:

    • resizable

      public final javafx.beans.property.BooleanProperty resizableProperty
      Determines if the user will be able to interactively resize the dialog. The default is false.
      See Also:

  • Constructor Details

    • Dialog

      public Dialog(DialogPane pane, DialogPane.Type type)
      Creates a new dialog with the specified dialog pane and type.
      Parameters:
      pane - the dialog pane where the dialog will be shown
      type - the type of the dialog (info, warning, error, ...)

  • Method Details

    • getType

      public final DialogPane.Type getType()
      Returns the type of the dialog, e.g. "info", "error", "warning".
      Returns:
      the dialog's type

    • getDialogPane

      public final DialogPane getDialogPane()
      Returns the dialog pane where the dialog is showing.
      Returns:
      the dialog pane to which the dialog belongs

    • getId

      public final String getId()
      Gets the value of the property id.
      Property description:
      Stores an optional ID for the dialog, which can be handy for various situations.

    • idProperty

      public final javafx.beans.property.StringProperty idProperty()
      Stores an optional ID for the dialog, which can be handy for various situations.
      See Also:

    • setId

      public final void setId(String id)
      Sets the value of the property id.
      Property description:
      Stores an optional ID for the dialog, which can be handy for various situations.

    • getPreferences

      public final Preferences getPreferences()
      Gets the value of the property preferences.
      Property description:
      Stores a reference to a preferences object which can be used to persist the width and height of the dialog across user sessions.

    • preferencesProperty

      public final javafx.beans.property.ObjectProperty<Preferences> preferencesProperty()
      Stores a reference to a preferences object which can be used to persist the width and height of the dialog across user sessions.
      See Also:

    • setPreferences

      public final void setPreferences(Preferences preferences)
      Sets the value of the property preferences.
      Property description:
      Stores a reference to a preferences object which can be used to persist the width and height of the dialog across user sessions.

    • getPrefWidth

      public final double getPrefWidth()
      Gets the value of the property prefWidth.
      Property description:

    • prefWidthProperty

      public final javafx.beans.property.DoubleProperty prefWidthProperty()
      See Also:

    • setPrefWidth

      public final void setPrefWidth(double prefWidth)
      Sets the value of the property prefWidth.
      Property description:

    • getPrefHeight

      public final double getPrefHeight()
      Gets the value of the property prefHeight.
      Property description:

    • prefHeightProperty

      public final javafx.beans.property.DoubleProperty prefHeightProperty()
      See Also:

    • setPrefHeight

      public final void setPrefHeight(double prefHeight)
      Sets the value of the property prefHeight.
      Property description:

    • getMinWidth

      public final double getMinWidth()
      Gets the value of the property minWidth.
      Property description:

    • minWidthProperty

      public final javafx.beans.property.DoubleProperty minWidthProperty()
      See Also:

    • setMinWidth

      public final void setMinWidth(double minWidth)
      Sets the value of the property minWidth.
      Property description:

    • getMinHeight

      public final double getMinHeight()
      Gets the value of the property minHeight.
      Property description:

    • minHeightProperty

      public final javafx.beans.property.DoubleProperty minHeightProperty()
      See Also:

    • setMinHeight

      public final void setMinHeight(double minHeight)
      Sets the value of the property minHeight.
      Property description:

    • getMaxWidth

      public final double getMaxWidth()
      Gets the value of the property maxWidth.
      Property description:

    • maxWidthProperty

      public final javafx.beans.property.DoubleProperty maxWidthProperty()
      See Also:

    • setMaxWidth

      public final void setMaxWidth(double maxWidth)
      Sets the value of the property maxWidth.
      Property description:

    • getMaxHeight

      public final double getMaxHeight()
      Gets the value of the property maxHeight.
      Property description:

    • maxHeightProperty

      public final javafx.beans.property.DoubleProperty maxHeightProperty()
      See Also:

    • setMaxHeight

      public final void setMaxHeight(double maxHeight)
      Sets the value of the property maxHeight.
      Property description:

    • getOnResize

      public final BiConsumer<Double,Double> getOnResize()
      Gets the value of the property onResize.
      Property description:
      A callback used to inform interested parties when the user changed the width or height of the dialog.

    • onResizeProperty

      public final javafx.beans.property.ObjectProperty<BiConsumer<Double,Double>> onResizeProperty()
      A callback used to inform interested parties when the user changed the width or height of the dialog.
      See Also:

    • setOnResize

      public final void setOnResize(BiConsumer<Double,Double> onResize)
      Sets the value of the property onResize.
      Property description:
      A callback used to inform interested parties when the user changed the width or height of the dialog.

    • isRequired

      public final boolean isRequired()
      Gets the value of the property required.
      Property description:
      A flag used to signal to the framework that input is required in this dialog. This is useful when showing things like text inputs where we automatically want to add a validator.

    • requiredProperty

      public final javafx.beans.property.BooleanProperty requiredProperty()
      A flag used to signal to the framework that input is required in this dialog. This is useful when showing things like text inputs where we automatically want to add a validator.
      See Also:

    • setRequired

      public final void setRequired(boolean required)
      Sets the value of the property required.
      Property description:
      A flag used to signal to the framework that input is required in this dialog. This is useful when showing things like text inputs where we automatically want to add a validator.

    • isShowCloseButton

      public final boolean isShowCloseButton()
      Gets the value of the property showCloseButton.
      Property description:
      Determines if the dialog will make a "close" button available to the user. Whether this property will be observed or not depends on the actual header implementation. The default implementation of the header does contain a close button.

    • showCloseButtonProperty

      public final javafx.beans.property.BooleanProperty showCloseButtonProperty()
      Determines if the dialog will make a "close" button available to the user. Whether this property will be observed or not depends on the actual header implementation. The default implementation of the header does contain a close button.
      See Also:

    • setShowCloseButton

      public final void setShowCloseButton(boolean showCloseButton)
      Sets the value of the property showCloseButton.
      Property description:
      Determines if the dialog will make a "close" button available to the user. Whether this property will be observed or not depends on the actual header implementation. The default implementation of the header does contain a close button.

    • getDelay

      public final javafx.util.Duration getDelay()
      Gets the value of the property delay.
      Property description:
      A property that can be used to delay the appearance of the dialog inside the dialog pane. This is very useful for dialogs that display a busy animation or a progress indicator as usually you only want those to appear if a background operation takes a while.

    • delayProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.Duration> delayProperty()
      A property that can be used to delay the appearance of the dialog inside the dialog pane. This is very useful for dialogs that display a busy animation or a progress indicator as usually you only want those to appear if a background operation takes a while.
      See Also:

    • setDelay

      public final void setDelay(javafx.util.Duration delay)
      Sets the value of the property delay.
      Property description:
      A property that can be used to delay the appearance of the dialog inside the dialog pane. This is very useful for dialogs that display a busy animation or a progress indicator as usually you only want those to appear if a background operation takes a while.

    • isUsingPadding

      public final boolean isUsingPadding()
      Gets the value of the property usingPadding.
      Property description:
      Controls whether additional padding will be applied "around" the content node. The actual amount of padding depends on the CSS rules.

    • usingPaddingProperty

      public final javafx.beans.property.BooleanProperty usingPaddingProperty()
      Controls whether additional padding will be applied "around" the content node. The actual amount of padding depends on the CSS rules.
      See Also:

    • setUsingPadding

      public final void setUsingPadding(boolean usingPadding)
      Sets the value of the property usingPadding.
      Property description:
      Controls whether additional padding will be applied "around" the content node. The actual amount of padding depends on the CSS rules.

    • getContentAlignment

      public final javafx.geometry.Pos getContentAlignment()
      Gets the value of the property contentAlignment.
      Property description:
      Determines how the content node is positioned within the content pane of the dialog. Default is CENTER_LEFT.

    • contentAlignmentProperty

      public final javafx.beans.property.ObjectProperty<javafx.geometry.Pos> contentAlignmentProperty()
      Determines how the content node is positioned within the content pane of the dialog. Default is CENTER_LEFT.
      See Also:

    • setContentAlignment

      public final void setContentAlignment(javafx.geometry.Pos contentAlignment)
      Sets the value of the property contentAlignment.
      Property description:
      Determines how the content node is positioned within the content pane of the dialog. Default is CENTER_LEFT.

    • getValue

      public final T getValue()
      Gets the value of the property value.
      Property description:
      Stores the value entered or selected by the user in the dialog. If the dialog is, for example, a text input dialog then the value will be the text entered into the text field of the dialog.

    • valueProperty

      public final javafx.beans.property.ObjectProperty<T> valueProperty()
      Stores the value entered or selected by the user in the dialog. If the dialog is, for example, a text input dialog then the value will be the text entered into the text field of the dialog.
      See Also:

    • setValue

      public final void setValue(T value)
      Sets the value of the property value.
      Property description:
      Stores the value entered or selected by the user in the dialog. If the dialog is, for example, a text input dialog then the value will be the text entered into the text field of the dialog.

    • show

      public void show()

    • cancel

      public void cancel()
      Hides the dialog by cancelling it.

    • getOnButtonPressed

      public Consumer<javafx.scene.control.ButtonType> getOnButtonPressed()

    • setOnButtonPressed

      public final void setOnButtonPressed(Consumer<javafx.scene.control.ButtonType> onButtonPressed)
      Specifies a consumer that gets invoked when the user presses on of the standard dialog buttons. The invocation happens as part of the complete() method.
      Parameters:
      onButtonPressed - an optional consumer that gets invoked when the user finishes the dialog

    • getOnClose

      public final Consumer<javafx.scene.control.ButtonType> getOnClose()
      Gets the value of the property onClose.
      Property description:

    • onCloseProperty

      public final javafx.beans.property.ObjectProperty<Consumer<javafx.scene.control.ButtonType>> onCloseProperty()
      See Also:

    • setOnClose

      public final void setOnClose(Consumer<javafx.scene.control.ButtonType> onClose)
      Sets the value of the property onClose.
      Property description:

    • onClose

      public final DialogPane.Dialog<T> onClose(Consumer<javafx.scene.control.ButtonType> onCommit)
      A method in fluent-api style that sets the given consumer and returns the dialog again.
      Parameters:
      onCommit - the handler

    • isValid

      public final boolean isValid()
      Gets the value of the property valid.
      Property description:
      Determines whether the values entered in the dialog are currently valid and will be accepted by the application. The validity is normally determines by the validator object.

    • validProperty

      public final javafx.beans.property.BooleanProperty validProperty()
      Determines whether the values entered in the dialog are currently valid and will be accepted by the application. The validity is normally determines by the validator object.
      See Also:

    • setValid

      public final void setValid(boolean valid)
      Sets the value of the property valid.
      Property description:
      Determines whether the values entered in the dialog are currently valid and will be accepted by the application. The validity is normally determines by the validator object.

    • getButtonTypes

      public final javafx.collections.ObservableList<javafx.scene.control.ButtonType> getButtonTypes()

    • isSameWidthButtons

      public final boolean isSameWidthButtons()
      Gets the value of the property sameWidthButtons.
      Property description:
      Determines if the buttons in the button bar will all have the same width or each one will have its preferred width.

    • sameWidthButtonsProperty

      public final javafx.beans.property.BooleanProperty sameWidthButtonsProperty()
      Determines if the buttons in the button bar will all have the same width or each one will have its preferred width.
      See Also:

    • setSameWidthButtons

      public final void setSameWidthButtons(boolean sameWidthButtons)
      Sets the value of the property sameWidthButtons.
      Property description:
      Determines if the buttons in the button bar will all have the same width or each one will have its preferred width.

    • maximizeProperty

      public final javafx.beans.property.BooleanProperty maximizeProperty()
      If maximized the dialog will try to use as much width and height inside the dialog pane as possible.
      See Also:

    • setMaximize

      public final void setMaximize(boolean max)
      Sets the value of the property maximize.
      Property description:
      If maximized the dialog will try to use as much width and height inside the dialog pane as possible.

    • isMaximize

      public final boolean isMaximize()
      Gets the value of the property maximize.
      Property description:
      If maximized the dialog will try to use as much width and height inside the dialog pane as possible.

    • contentProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> contentProperty()
      Stores the content shown in the center of the dialog.
      See Also:

    • setContent

      public final void setContent(javafx.scene.Node content)
      Sets the value of the property content.
      Property description:
      Stores the content shown in the center of the dialog.

    • getContent

      public final javafx.scene.Node getContent()
      Gets the value of the property content.
      Property description:
      Stores the content shown in the center of the dialog.

    • getExtras

      public final javafx.scene.Node getExtras()
      Gets the value of the property extras.
      Property description:
      An extra node that might be displayed in the header or the footer of the dialog. This node will only be shown if custom header or footer factories make use of it. By default this node will not be visible anywhere.

    • extrasProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> extrasProperty()
      An extra node that might be displayed in the header or the footer of the dialog. This node will only be shown if custom header or footer factories make use of it. By default this node will not be visible anywhere.
      See Also:

    • setExtras

      public final void setExtras(javafx.scene.Node extras)
      Sets the value of the property extras.
      Property description:
      An extra node that might be displayed in the header or the footer of the dialog. This node will only be shown if custom header or footer factories make use of it. By default this node will not be visible anywhere.

    • titleProperty

      public final javafx.beans.property.StringProperty titleProperty()
      See Also:

    • getTitle

      public final String getTitle()
      The title for the dialog. The default header factory will use this property to populate a label with it.
      Returns:
      the dialog's title

    • setTitle

      public final void setTitle(String title)
      Sets the value of the property title.
      Property description:

    • getStyleClass

      public final javafx.collections.ObservableList<String> getStyleClass()
      A list with additional styles that will be added to the content pane of the dialog.
      Returns:
      additional css styles

    • showHeaderProperty

      public final javafx.beans.property.BooleanProperty showHeaderProperty()
      Determines if the dialog will show the title / header at the bottom or not.
      See Also:

    • isShowHeader

      public final boolean isShowHeader()
      Gets the value of the property showHeader.
      Property description:
      Determines if the dialog will show the title / header at the bottom or not.

    • setShowHeader

      public final void setShowHeader(boolean showHeader)
      Sets the value of the property showHeader.
      Property description:
      Determines if the dialog will show the title / header at the bottom or not.

    • showFooterProperty

      public final javafx.beans.property.BooleanProperty showFooterProperty()
      Determines if the dialog will show the button bar / footer at the bottom or not.
      See Also:

    • isShowFooter

      public final boolean isShowFooter()
      Gets the value of the property showFooter.
      Property description:
      Determines if the dialog will show the button bar / footer at the bottom or not.

    • setShowFooter

      public final void setShowFooter(boolean showFooter)
      Sets the value of the property showFooter.
      Property description:
      Determines if the dialog will show the button bar / footer at the bottom or not.

    • getButton

      public final javafx.scene.control.Button getButton(javafx.scene.control.ButtonType type)
      Returns the button created for the given button type, but only if such a button type was requested for the dialog.
      Parameters:
      type - the button type
      Returns:
      the button
      See Also:

    • getValidator

      public final net.synedra.validatorfx.Validator getValidator()
      Gets the value of the property validator.
      Property description:
      A validator that can be used in the context of this dialog. Applications can call Validator.createCheck() to add one or more checks which will be validated once the user tries to commit the dialog.

    • validatorProperty

      public final javafx.beans.property.ObjectProperty<net.synedra.validatorfx.Validator> validatorProperty()
      A validator that can be used in the context of this dialog. Applications can call Validator.createCheck() to add one or more checks which will be validated once the user tries to commit the dialog.
      See Also:

    • setValidator

      public final void setValidator(net.synedra.validatorfx.Validator validator)
      Sets the value of the property validator.
      Property description:
      A validator that can be used in the context of this dialog. Applications can call Validator.createCheck() to add one or more checks which will be validated once the user tries to commit the dialog.

    • isResizable

      public final boolean isResizable()
      Gets the value of the property resizable.
      Property description:
      Determines if the user will be able to interactively resize the dialog. The default is false.

    • resizableProperty

      public final javafx.beans.property.BooleanProperty resizableProperty()
      Determines if the user will be able to interactively resize the dialog. The default is false.
      See Also:

    • setResizable

      public final void setResizable(boolean resizable)
      Sets the value of the property resizable.
      Property description:
      Determines if the user will be able to interactively resize the dialog. The default is false.