org.eclipse.fx.ui.controls.dialog

Class Dialog

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.StackPane

org.eclipse.fx.ui.controls.stage.ResizeableFramePane

org.eclipse.fx.ui.controls.stage.DefaultFramePane

org.eclipse.fx.ui.controls.dialog.Dialog

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, Frame

Direct Known Subclasses:

MessageDialog, TitleAreaDialog

public class Dialog
extends DefaultFramePane

Base class for dialogs

This is an experimental component provided as a preview we'll improve and fix problems in up coming releases

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dialog.ButtonType Enum representing standard button type
static class	Dialog.DefaultDialogContentPane A default implementation for the dialog content
static class	Dialog.DialogButton A dialog button
static interface	Dialog.DialogContentPane Pane representing the dialog content

Nested classes/interfaces inherited from class org.eclipse.fx.ui.controls.stage.DefaultFramePane

DefaultFramePane.TitleAreaNode

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 and Description
Dialog(D pane, javafx.scene.Node clientArea, DialogMessagesProvider messagesProvider) Create a new dialog
Dialog(D pane, javafx.scene.Node clientArea, java.lang.String frameTitle) Create a new dialog
Dialog(javafx.scene.Node clientArea, java.lang.String frameTitle) Create a new dialog

Method Summary

Modifier and Type	Method and Description
protected void	addDefaultButtons() Add default buttons - the default implementation adds OK Cancel
Dialog.DialogButton	createCancelButton()
Dialog.DialogButton	createOKButton()
static Dialog	createSimpleDialog(javafx.scene.Node clientArea, java.lang.String frameTitle) Create a simple dialog
javafx.collections.ObservableList<Dialog.DialogButton>	getButtonList()
protected Dialog.DialogContentPane	getDialogPane()
protected void	handleButtonPress(Dialog.DialogButton button) Handle the press of a button
protected void	handleCancel() Handle the canceling of the dialog by hitting the OK-Button or dismissing the dialog in other ways
protected void	handleOk() Handle the pressing of the ok button
protected void	requestCancelClose() Request the closing through the cancel icon in trim
protected void	updateClientArea(javafx.beans.value.ObservableValue<? extends javafx.scene.Node> o, javafx.scene.Node oldClientArea, javafx.scene.Node newClientArea) Update the client area node

Methods inherited from class org.eclipse.fx.ui.controls.stage.DefaultFramePane

createTitleBar, createWindowArea, getUserAgentStylesheet, impl_clientAreaProperty, impl_contentProperty, impl_titleProperty

Methods inherited from class org.eclipse.fx.ui.controls.stage.ResizeableFramePane

clientAreaProperty, close, close, contentProperty, getClientArea, getContent, getResizeHandleSize, getStage, getTitle, isLightweight, isMaximizable, isMinimizable, layoutChildren, lightweightProperty, maximizableProperty, maximize, maximizedProperty, minimizableProperty, minimize, registerTitleBar, resizeHandleSize, restore, setClientArea, setContent, setMaximizable, setMinimizable, setResizeable, setResizeHandleSize, setTitle, titleProperty

Methods inherited from class javafx.scene.layout.StackPane

alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, requestLayout, setAlignment, setAlignment, setMargin

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setImpl_traversalEngine, 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, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.event.EventTarget

buildEventDispatchChain

Constructor Detail

Dialog

public Dialog(javafx.scene.Node clientArea,
              java.lang.String frameTitle)

Create a new dialog

Parameters:

clientArea - the node displayed in the client area

frameTitle - the title displayed on the frame

Dialog

public Dialog(D pane,
              javafx.scene.Node clientArea,
              java.lang.String frameTitle)

Create a new dialog

Type Parameters:

D - the content pane type

Parameters:

pane - the pane wrapping the content displaying buttons

clientArea - the client are who presents the business controls

frameTitle - the title displayed on the frame

Dialog

public Dialog(D pane,
              javafx.scene.Node clientArea,
              DialogMessagesProvider messagesProvider)

Create a new dialog

Type Parameters:

D - the content pane type

Parameters:

pane - the pane wrapping the content displaying buttons

clientArea - the client are who presents the business controls

messagesProvider - the provide for messages

Method Detail

requestCancelClose

protected final void requestCancelClose()

Description copied from class: DefaultFramePane

Request the closing through the cancel icon in trim

Overrides:

requestCancelClose in class DefaultFramePane

handleButtonPress

protected void handleButtonPress(Dialog.DialogButton button)

Handle the press of a button

Parameters:

button - the button

handleOk

protected void handleOk()

Handle the pressing of the ok button

handleCancel

protected void handleCancel()

Handle the canceling of the dialog by hitting the OK-Button or dismissing the dialog in other ways

getDialogPane

protected Dialog.DialogContentPane getDialogPane()

Returns:

the dialog pane

getButtonList

public javafx.collections.ObservableList<Dialog.DialogButton> getButtonList()

Returns:

the list of buttons

updateClientArea

protected void updateClientArea(javafx.beans.value.ObservableValue<? extends javafx.scene.Node> o,
                                javafx.scene.Node oldClientArea,
                                javafx.scene.Node newClientArea)

Description copied from class: DefaultFramePane

Update the client area node

Overrides:

updateClientArea in class DefaultFramePane

Parameters:

o - the property

oldClientArea - the old value for the client area

newClientArea - the new value for the client area

createOKButton

public Dialog.DialogButton createOKButton()

Returns:

create a new ok button

createCancelButton

public Dialog.DialogButton createCancelButton()

Returns:

create a new cancel button

addDefaultButtons

protected void addDefaultButtons()

Add default buttons - the default implementation adds

• OK
• Cancel

createSimpleDialog

public static Dialog createSimpleDialog(javafx.scene.Node clientArea,
                                        java.lang.String frameTitle)

Create a simple dialog

Parameters:

clientArea - the client area

frameTitle - the title displayed in the frame

Returns:

the dialog instance