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

Class DialogPane

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
com.dlsc.gemsfx.DialogPane
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget
public class DialogPane extends javafx.scene.layout.Pane
A pane that allows applications to display a lightweight dialog right inside the application window instead of a separate window. The dialogs are animated and fly-in from top to center and fly-out from center to top.

The dialog pane should be added to the application in such a way that it covers the entire area of the window. If the application is using a StackPane as its root container then the dialog pane can simply be added as the last child of the StackPane.

Example

To show an information dialog one can simply call: 

    dialogPane.showInformation("My Title", "My message");

If an application wants to act upon the button that was pressed after showing a confirmation dialog then the following can be written: 

     dialogPane.showConfirmation("Confirm", "Really delete?").thenAccept(buttonType -> { ... });

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.BooleanProperty
    animateDialogs
     
    javafx.beans.property.ObjectProperty<javafx.util.Duration>
    animationDuration
     
    final javafx.beans.property.ObjectProperty<javafx.util.StringConverter<javafx.scene.control.ButtonType>>
    converter
    A string converter can be applied to easily manipulate the default text representation of the various button types.
    final javafx.beans.property.BooleanProperty
    fadeInOut
     
    javafx.beans.property.BooleanProperty
    showCloseButton
     
    javafx.beans.property.ReadOnlyBooleanProperty
    showingDialog
     

    Properties inherited from class javafx.scene.layout.Region

    background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

    Properties inherited from class javafx.scene.Parent

    needsLayout

    Properties inherited from class javafx.scene.Node

    accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    DialogPane.Dialog<T>
     
    static enum 
    DialogPane.Type
    The various dialog types supported by DialogPane.

  • Field Summary

    Fields inherited from class javafx.scene.layout.Region

    USE_COMPUTED_SIZE, USE_PREF_SIZE

    Fields inherited from class javafx.scene.Node

    BASELINE_OFFSET_SAME_AS_HEIGHT

  • Constructor Summary

    Constructors
    Constructor
    Description
    DialogPane()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.BooleanProperty
    animateDialogsProperty()
     
    javafx.beans.property.ObjectProperty<javafx.util.Duration>
    animationDurationProperty()
     
    final javafx.beans.property.ObjectProperty<javafx.util.StringConverter<javafx.scene.control.ButtonType>>
    converterProperty()
    A string converter can be applied to easily manipulate the default text representation of the various button types.
    final javafx.beans.property.BooleanProperty
    fadeInOutProperty()
     
    javafx.util.Duration
    getAnimationDuration()
    Gets the value of the animationDuration property.
    final javafx.util.StringConverter<javafx.scene.control.ButtonType>
    getConverter()
    Gets the value of the converter property.
    String
    getUserAgentStylesheet()
     
    final void
    hideDialog(DialogPane.Dialog<?> dialog)
     
    final boolean
    isAnimateDialogs()
    Gets the value of the animateDialogs property.
    final boolean
    isFadeInOut()
    Gets the value of the fadeInOut property.
    boolean
    isShowCloseButton()
    Gets the value of the showCloseButton property.
    boolean
    isShowingDialog()
    Gets the value of the showingDialog property.
    protected void
    layoutChildren()
     
    final void
    setAnimateDialogs(boolean animate)
    Sets the value of the animateDialogs property.
    void
    setAnimationDuration(javafx.util.Duration animationDuration)
    Sets the value of the animationDuration property.
    final void
    setConverter(javafx.util.StringConverter<javafx.scene.control.ButtonType> converter)
    Sets the value of the converter property.
    final void
    setFadeInOut(boolean animate)
    Sets the value of the fadeInOut property.
    void
    setShowCloseButton(boolean showCloseButton)
    Sets the value of the showCloseButton property.
    final DialogPane.Dialog<Void>
    showBusyIndicator()
     
    javafx.beans.property.BooleanProperty
    showCloseButtonProperty()
     
    final DialogPane.Dialog<javafx.scene.control.ButtonType>
    showConfirmation(String title, String message)
     
    final <T> void
    showDialog(DialogPane.Dialog<T> dialog)
     
    final DialogPane.Dialog<Void>
    showError(String title, Exception exception)
     
    final DialogPane.Dialog<Void>
    showError(String title, String message)
     
    final DialogPane.Dialog<Void>
    showError(String title, String message, Exception exception)
     
    final DialogPane.Dialog<Void>
    showError(String title, String message, String details)
     
    final DialogPane.Dialog<Void>
    showError(String title, String message, Throwable exception)
     
    final DialogPane.Dialog<javafx.scene.control.ButtonType>
    showInformation(String title, String message)
     
    final DialogPane.Dialog<javafx.scene.control.ButtonType>
    showInformation(String title, String message, List<javafx.scene.control.ButtonType> buttons)
     
    javafx.beans.property.ReadOnlyBooleanProperty
    showingDialogProperty()
     
    final <T> DialogPane.Dialog<T>
    showNode(DialogPane.Type type, String title, javafx.scene.Node node)
     
    final <T> DialogPane.Dialog<T>
    showNode(DialogPane.Type type, String title, javafx.scene.Node node, boolean maximize)
     
    final <T> DialogPane.Dialog<T>
    showNode(DialogPane.Type type, String title, javafx.scene.Node node, boolean maximize, List<javafx.scene.control.ButtonType> buttons)
     
    final <T> DialogPane.Dialog<T>
    showNode(DialogPane.Type type, String title, javafx.scene.Node node, boolean maximize, List<javafx.scene.control.ButtonType> buttons, boolean sameWidthButtons)
     
    final <T> DialogPane.Dialog<T>
    showNode(DialogPane.Type type, String title, javafx.scene.Node node, boolean maximize, List<javafx.scene.control.ButtonType> buttons, boolean sameWidthButtons, javafx.beans.property.BooleanProperty validProperty)
     
    final <T> DialogPane.Dialog<T>
    showNode(DialogPane.Type type, String title, javafx.scene.Node node, List<javafx.scene.control.ButtonType> buttons)
     
    final DialogPane.Dialog<String>
    showTextInput(String title, String text)
     
    final DialogPane.Dialog<String>
    showTextInput(String title, String text, boolean multiline)
     
    final DialogPane.Dialog<String>
    showTextInput(String title, String message, String text, boolean multiline)
     
    final DialogPane.Dialog<String>
    showTextInput(String title, String message, String prompt, String text, boolean multiline)
     
    final DialogPane.Dialog<javafx.scene.control.ButtonType>
    showWarning(String title, String message)
     

    Methods inherited from class javafx.scene.layout.Pane

    getChildren

    Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBackground, getBorder, getClassCssMetaData, getCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

    Methods inherited from class javafx.scene.Node

    accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode