Top Description Inners Fields Constructors Methods
com.dlsc.workbenchfx.model

public final Class WorkbenchDialog

extends Object
Class Inheritance
Imports
com.dlsc.workbenchfx.Workbench, com.dlsc.workbenchfx.view.controls.GlassPane, .MultilineLabel, com.dlsc.workbenchfx.view.controls.dialog.DialogControl, com.google.common.base.Strings, java.io.PrintWriter, .StringWriter, java.util.Objects, .Optional, java.util.function.Consumer, javafx.beans.property.BooleanProperty, .ObjectProperty, .ReadOnlyBooleanProperty, .SimpleBooleanProperty, .SimpleObjectProperty, .SimpleStringProperty, .StringProperty, javafx.collections.FXCollections, .ObservableList, javafx.event.Event, .EventHandler, javafx.scene.Node, javafx.scene.control.Button, .ButtonType, javafx.scene.input.KeyCode, org.slf4j.Logger, .LoggerFactory

Represents the model class of a Dialog in Workbench.
Authors
Dirk Lemmermann, François Martin, Marco Sanfratello

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
public static class

Field Summary

Modifier and TypeField and Description
private final BooleanProperty
private final BooleanProperty
private final ObservableList<ButtonType>
private final ObjectProperty<Node>
private final StringProperty
private final ObjectProperty<DialogControl>
private final ObjectProperty<Exception>
private static final Logger
private final BooleanProperty
private final ObjectProperty<Consumer<ButtonType>>
private final ObservableList<String>
private final StringProperty
private WorkbenchDialog.Type

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public final BooleanProperty
public static WorkbenchDialog.WorkbenchDialogBuilder

Returns:

builder object
builder
(String
of the dialog
title
,
Node
of the dialog
content
,
WorkbenchDialog.Type
of the dialog
type
)

Creates a builder for WorkbenchDialog.

public static WorkbenchDialog.WorkbenchDialogBuilder

Returns:

builder object
builder
(String
of the dialog
title
,
String
of the dialog
message
,
WorkbenchDialog.Type
of the dialog
type
)

Creates a builder for WorkbenchDialog.

public static WorkbenchDialog.WorkbenchDialogBuilder

Returns:

builder object
builder
(String
of the dialog
title
,
Node
of the dialog
content
,
ButtonType...
to be used in this dialog
buttonTypes
)

Creates a builder for WorkbenchDialog.

public static WorkbenchDialog.WorkbenchDialogBuilder

Returns:

builder object
builder
(String
of the dialog
title
,
String
of the dialog
message
,
ButtonType...
to be used in this dialog
buttonTypes
)

Creates a builder for WorkbenchDialog.

public final BooleanProperty
public final ObjectProperty<Node>
public final StringProperty
public final ObjectProperty<DialogControl>

Returns:

the dialogControl of this WorkbenchDialog
dialogControlProperty
()

The root node of the dialog, the DialogControl contains all visual elements shown in the dialog.

public final ObjectProperty<Exception>
public final Optional<Button>

Returns:

the button or an empty Optional, if the DialogControl hasn't been initialized before
getButton
(ButtonType
to retrieve from the DialogControl
buttonType
)

Retrieves the Button instance of the DialogControl which is of the specified ButtonType.

public final ObservableList<ButtonType>
public final Node
public final String
public final DialogControl
public final Exception
public final EventHandler<Event>
public final Consumer<ButtonType>
public final EventHandler<Event>
public final ObservableList<String>
public final String
public final WorkbenchDialog.Type
private void
public final boolean
public final boolean
public final boolean
public final boolean

Returns:

true if dialog is showing.
isShowing
()

Returns whether or not the dialog is showing.

public final BooleanProperty
public final ObjectProperty<EventHandler<Event>>

Returns:

the property to represent the event, which is invoked whenever the dialog has been hidden in the scene graph.
onHiddenProperty
()

The dialog's action, which is invoked whenever the dialog has been hidden in the scene graph.

public final ObjectProperty<Consumer<ButtonType>>
public final ObjectProperty<EventHandler<Event>>

Returns:

the property to represent the event, which is invoked whenever the dialog has been fully initialized and is being shown.
onShownProperty
()

The dialog's action, which is invoked whenever the dialog has been fully initialized and is being shown.

public final void
setBlocking(boolean blocking)

public final void
setButtonsBarShown(boolean buttonsBarShown)

public final void
setContent(Node content)

public final void
setDetails(String details)

public final void
public final void
public final void
setMaximized(boolean max)

public final void
public final void
setOnResult(Consumer<ButtonType>
action to be performed
onResult
)

Defines the action to perform when a button of the dialog was pressed.

public final void
setOnShown(EventHandler<Event>
the EventHandler which will be invoked after the dialog has been fully initialized and is being shown
value
)

The dialog's action, which is invoked whenever the dialog has been fully initialized and is being shown.

public final void
public final ReadOnlyBooleanProperty

Returns:

the property representing whether the dialog is currently showing
showingProperty
()

Represents whether the dialog is currently showing.

public final StringProperty
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait