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 content property.
    final javafx.geometry.Pos
    getContentAlignment()
    Gets the value of the contentAlignment property.
    final javafx.util.Duration
    getDelay()
    Gets the value of the delay property.
    final DialogPane
    getDialogPane()
    Returns the dialog pane where the dialog is showing.
    final javafx.scene.Node
    getExtras()
    Gets the value of the extras property.
    final String
    getId()
    Gets the value of the id property.
    final double
    getMaxHeight()
    Gets the value of the maxHeight property.
    final double
    getMaxWidth()
    Gets the value of the maxWidth property.
    final double
    getMinHeight()
    Gets the value of the minHeight property.
    final double
    getMinWidth()
    Gets the value of the minWidth property.
    Consumer<javafx.scene.control.ButtonType>
    getOnButtonPressed()
     
    final Consumer<javafx.scene.control.ButtonType>
    getOnClose()
    Gets the value of the onClose property.
    final BiConsumer<Double,Double>
    getOnResize()
    Gets the value of the onResize property.
    final Preferences
    getPreferences()
    Gets the value of the preferences property.
    final double
    getPrefHeight()
    Gets the value of the prefHeight property.
    final double
    getPrefWidth()
    Gets the value of the prefWidth property.
    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 validator property.
    final T
    getValue()
    Gets the value of the value property.
    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 maximize property.
    final boolean
    isRequired()
    Gets the value of the required property.
    final boolean
    isResizable()
    Gets the value of the resizable property.
    final boolean
    isSameWidthButtons()
    Gets the value of the sameWidthButtons property.
    final boolean
    isShowCloseButton()
    Gets the value of the showCloseButton property.
    final boolean
    isShowFooter()
    Gets the value of the showFooter property.
    final boolean
    isShowHeader()
    Gets the value of the showHeader property.
    final boolean
    isUsingPadding()
    Gets the value of the usingPadding property.
    final boolean
    isValid()
    Gets the value of the valid property.
    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> onClose)
    Sets a consumer that will be invoked when the dialog is being closed.
    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()
     
    void
    press(javafx.scene.control.ButtonType buttonType)
    Programmatic access to closing the dialog with the given button type.
    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 content property.
    final void
    setContentAlignment(javafx.geometry.Pos contentAlignment)
    Sets the value of the contentAlignment property.
    final void
    setDelay(javafx.util.Duration delay)
    Sets the value of the delay property.
    final void
    setExtras(javafx.scene.Node extras)
    Sets the value of the extras property.
    final void
    setId(String id)
    Sets the value of the id property.
    final void
    setMaxHeight(double maxHeight)
    Sets the value of the maxHeight property.
    final void
    setMaximize(boolean max)
    Sets the value of the maximize property.
    final void
    setMaxWidth(double maxWidth)
    Sets the value of the maxWidth property.
    final void
    setMinHeight(double minHeight)
    Sets the value of the minHeight property.
    final void
    setMinWidth(double minWidth)
    Sets the value of the minWidth property.
    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 onClose property.
    final void
    setOnResize(BiConsumer<Double,Double> onResize)
    Sets the value of the onResize property.
    final void
    setPreferences(Preferences preferences)
    Sets the value of the preferences property.
    final void
    setPrefHeight(double prefHeight)
    Sets the value of the prefHeight property.
    final void
    setPrefWidth(double prefWidth)
    Sets the value of the prefWidth property.
    final void
    setRequired(boolean required)
    Sets the value of the required property.
    final void
    setResizable(boolean resizable)
    Sets the value of the resizable property.
    final void
    setSameWidthButtons(boolean sameWidthButtons)
    Sets the value of the sameWidthButtons property.
    final void
    setShowCloseButton(boolean showCloseButton)
    Sets the value of the showCloseButton property.
    final void
    setShowFooter(boolean showFooter)
    Sets the value of the showFooter property.
    final void
    setShowHeader(boolean showHeader)
    Sets the value of the showHeader property.
    final void
    setTitle(String title)
    Sets the value of the title property.
    final void
    setUsingPadding(boolean usingPadding)
    Sets the value of the usingPadding property.
    final void
    setValid(boolean valid)
    Sets the value of the valid property.
    final void
    setValidator(net.synedra.validatorfx.Validator validator)
    Sets the value of the validator property.
    final void
    setValue(T value)
    Sets the value of the value property.
    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 Object

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

  • Property Details

  • 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 id property.
      Property description:
      Stores an optional ID for the dialog, which can be handy for various situations.
      Returns:
      the value of the id property
      See Also:

    • idProperty

      public final javafx.beans.property.StringProperty idProperty()
      Stores an optional ID for the dialog, which can be handy for various situations.
      Returns:
      the id of the dialog, e.g. "preferences.dialog"
      See Also:

    • setId

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

    • getPreferences

      public final Preferences getPreferences()
      Gets the value of the preferences property.
      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.
      Returns:
      the value of the preferences property
      See Also:

    • 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.
      Returns:
      the preferences where we want to store the bounds of the dialog after a resizing operation
      See Also:

    • setPreferences

      public final void setPreferences(Preferences preferences)
      Sets the value of the preferences property.
      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.
      Parameters:
      preferences - the value for the preferences property
      See Also:

    • getPrefWidth

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

    • prefWidthProperty

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

    • setPrefWidth

      public final void setPrefWidth(double prefWidth)
      Sets the value of the prefWidth property.
      Property description:
      Parameters:
      prefWidth - the value for the prefWidth property
      See Also:

    • getPrefHeight

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

    • prefHeightProperty

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

    • setPrefHeight

      public final void setPrefHeight(double prefHeight)
      Sets the value of the prefHeight property.
      Property description:
      Parameters:
      prefHeight - the value for the prefHeight property
      See Also:

    • getMinWidth

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

    • minWidthProperty

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

    • setMinWidth

      public final void setMinWidth(double minWidth)
      Sets the value of the minWidth property.
      Property description:
      Parameters:
      minWidth - the value for the minWidth property
      See Also:

    • getMinHeight

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

    • minHeightProperty

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

    • setMinHeight

      public final void setMinHeight(double minHeight)
      Sets the value of the minHeight property.
      Property description:
      Parameters:
      minHeight - the value for the minHeight property
      See Also:

    • getMaxWidth

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

    • maxWidthProperty

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

    • setMaxWidth

      public final void setMaxWidth(double maxWidth)
      Sets the value of the maxWidth property.
      Property description:
      Parameters:
      maxWidth - the value for the maxWidth property
      See Also:

    • getMaxHeight

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

    • maxHeightProperty

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

    • setMaxHeight

      public final void setMaxHeight(double maxHeight)
      Sets the value of the maxHeight property.
      Property description:
      Parameters:
      maxHeight - the value for the maxHeight property
      See Also:

    • getOnResize

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

    • 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.
      Returns:
      the callback / the consumer of the new width and height
      See Also:

    • setOnResize

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

    • isRequired

      public final boolean isRequired()
      Gets the value of the required property.
      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.
      Returns:
      the value of the required property
      See Also:

    • 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.
      Returns:
      true if the dialog requires input
      See Also:

    • setRequired

      public final void setRequired(boolean required)
      Sets the value of the required property.
      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.
      Parameters:
      required - the value for the required property
      See Also:

    • isShowCloseButton

      public final boolean isShowCloseButton()
      Gets the value of the showCloseButton property.
      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.
      Returns:
      the value of the showCloseButton property
      See Also:

    • 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.
      Returns:
      true if the close button will be shown
      See Also:

    • setShowCloseButton

      public final void setShowCloseButton(boolean showCloseButton)
      Sets the value of the showCloseButton property.
      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.
      Parameters:
      showCloseButton - the value for the showCloseButton property
      See Also:

    • getDelay

      public final javafx.util.Duration getDelay()
      Gets the value of the delay property.
      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.
      Returns:
      the value of the delay property
      See Also:

    • 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.
      Returns:
      the delay before the dialog becomes visible, default is null.
      See Also:

    • setDelay

      public final void setDelay(javafx.util.Duration delay)
      Sets the value of the delay property.
      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.
      Parameters:
      delay - the value for the delay property
      See Also:

    • isUsingPadding

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

    • 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.
      Returns:
      true if padding will be added
      See Also:

    • setUsingPadding

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

    • getContentAlignment

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

    • 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.
      Returns:
      the position of the content
      See Also:

    • setContentAlignment

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

    • getValue

      public final T getValue()
      Gets the value of the value property.
      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.
      Returns:
      the value of the value property
      See Also:

    • 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.
      Returns:
      the user entered or selected value
      See Also:

    • setValue

      public final void setValue(T value)
      Sets the value of the value property.
      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.
      Parameters:
      value - the value for the value property
      See Also:

    • 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 onClose property.
      Property description:
      Returns:
      the value of the onClose property
      See Also:

    • onCloseProperty

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

    • setOnClose

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

    • onClose

      public final DialogPane.Dialog<T> onClose(Consumer<javafx.scene.control.ButtonType> onClose)
      Sets a consumer that will be invoked when the dialog is being closed.
      Parameters:
      onClose - the "close dialog" handler

    • press

      public void press(javafx.scene.control.ButtonType buttonType)
      Programmatic access to closing the dialog with the given button type.
      Parameters:
      buttonType - the type of button pressed

    • isValid

      public final boolean isValid()
      Gets the value of the valid property.
      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.
      Returns:
      the value of the valid property
      See Also:

    • 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.
      Returns:
      true if the dialog fiels are currently valid
      See Also:

    • setValid

      public final void setValid(boolean valid)
      Sets the value of the valid property.
      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.
      Parameters:
      valid - the value for the valid property
      See Also:

    • getButtonTypes

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

    • isSameWidthButtons

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

    • 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.
      Returns:
      true if all buttons should have the same width
      See Also:

    • setSameWidthButtons

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

    • 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.
      Returns:
      true if the dialog will try to maximize itself
      See Also:

    • setMaximize

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

    • isMaximize

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

    • contentProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> contentProperty()
      Stores the content shown in the center of the dialog.
      Returns:
      the content node with the actual UI being displayed to the user
      See Also:

    • setContent

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

    • getContent

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

    • getExtras

      public final javafx.scene.Node getExtras()
      Gets the value of the extras property.
      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.
      Returns:
      the value of the extras property
      See Also:

    • 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.
      Returns:
      an extra node to be placed in the header or footer
      See Also:

    • setExtras

      public final void setExtras(javafx.scene.Node extras)
      Sets the value of the extras property.
      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.
      Parameters:
      extras - the value for the extras property
      See Also:

    • titleProperty

      public final javafx.beans.property.StringProperty titleProperty()
      Returns:
      the title property
      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 title property.
      Property description:
      Parameters:
      title - the value for the title property
      See Also:

    • 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.
      Returns:
      true if the dialog shows the button bar
      See Also:

    • isShowHeader

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

    • setShowHeader

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

    • showFooterProperty

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

    • isShowFooter

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

    • setShowFooter

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

    • 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 validator property.
      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.
      Returns:
      the value of the validator property
      See Also:

    • 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.
      Returns:
      the dialog's validator
      See Also:

    • setValidator

      public final void setValidator(net.synedra.validatorfx.Validator validator)
      Sets the value of the validator property.
      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.
      Parameters:
      validator - the value for the validator property
      See Also:

    • isResizable

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

    • resizableProperty

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

    • setResizable

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