WorkbenchFX 11.3.1 · com.dlsc.workbenchfx.view.controls.dialog.DialogControl

Modifier and Type	Field and Description
private InvalidationListener	blockingChangedListener
private final Map<ButtonType, Button>	buttonNodes
private final ObservableList<Button>	buttons
private final BooleanProperty	buttonTextUppercase
private Button	cancelButton
private ButtonType	cancelButtonType
private Button	defaultButton
private ButtonType	defaultButtonType
private final ObjectProperty<WorkbenchDialog>	dialog
private InvalidationListener	dialogChangedListener
private EventHandler<KeyEvent>	escapeConsumeHandler
private static final Logger	LOGGER
private final ObjectProperty<EventHandler<Event>>	onHidden
private final ObjectProperty<EventHandler<Event>>	onShown
private final BooleanProperty	showingProperty
private final ObjectProperty<Workbench>	workbench

Access	Constructor and Description
public	DialogControl() Creates a dialog control.

Method Summary

Modifier and Type	Method and Description
public final BooleanProperty	buttonTextUppercaseProperty()
private void	completeDialog(ButtonType cmd)
private Button	createButton(ButtonType buttonType)
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public final ObjectProperty<WorkbenchDialog>	dialogProperty()
private void	fireOnHidden()
private void	fireOnShown()
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<Button>	getButtons()
public ButtonType	getCancelButtonType()
public final WorkbenchDialog	getDialog()
public final EventHandler<Event>	getOnHidden()
public final EventHandler<Event>	getOnShown()
public final Workbench	getWorkbench()
public final void	hide()
public final boolean	isButtonTextUppercase()
public final boolean	Returns: true if dialog is showing. isShowing() Returns whether or not the dialog is showing.
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<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	setButtonTextUppercase(boolean buttonTextUppercase)
public final void	setDialog(WorkbenchDialog dialog)
public final void	setOnHidden(EventHandler<Event> value)
public final void	setOnShown(EventHandler<Event> value)
private void	setShowing(boolean showing)
private void	setupChangeListeners()
public final void	setWorkbench(Workbench workbench)
public final ReadOnlyBooleanProperty	Returns: the property representing whether the dialog is currently showing showingProperty() Represents whether the dialog is currently showing.
private void	updateButtons(WorkbenchDialog dialog)
private void	updateKeyboardBehavior()
public final ObjectProperty<Workbench>	workbenchProperty()

blockingChangedListener	back to summary
private InvalidationListener blockingChangedListener

buttonNodes	back to summary
private final Map<ButtonType, Button> buttonNodes

buttons	back to summary
private final ObservableList<Button> buttons

buttonTextUppercase	back to summary
private final BooleanProperty buttonTextUppercase

cancelButton	back to summary
private Button cancelButton

cancelButtonType	back to summary
private ButtonType cancelButtonType

defaultButton	back to summary
private Button defaultButton

defaultButtonType	back to summary
private ButtonType defaultButtonType

dialog	back to summary
private final ObjectProperty<WorkbenchDialog> dialog

dialogChangedListener	back to summary
private InvalidationListener dialogChangedListener

escapeConsumeHandler	back to summary
private EventHandler<KeyEvent> escapeConsumeHandler

LOGGER	back to summary
private static final Logger LOGGER

onHidden	back to summary
private final ObjectProperty<EventHandler<Event>> onHidden

onShown	back to summary
private final ObjectProperty<EventHandler<Event>> onShown

showingProperty	back to summary
private final BooleanProperty showingProperty

workbench	back to summary
private final ObjectProperty<Workbench> workbench

DialogControl	back to summary
public DialogControl() Creates a dialog control.

Method Detail

buttonTextUppercaseProperty	back to summary
public final BooleanProperty buttonTextUppercaseProperty()

completeDialog	back to summary
private void completeDialog(ButtonType cmd)

createButton	back to summary
private Button createButton(ButtonType buttonType)

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Doc from javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS `-fx-skin` or set explicitly in a sub-class with `setSkin(...)`. Returns:Skin<?> new instance of default skin for this control. If null then the control will have no skin unless one is provided by css. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Returns:Skin<?>

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

Annotations

@Override

dialogProperty	back to summary
public final ObjectProperty<WorkbenchDialog> dialogProperty()

fireOnHidden	back to summary
private void fireOnHidden()

fireOnShown	back to summary
private void fireOnShown()

getButton back to summary

getButton	back to summary
public final Optional<Button> getButton(ButtonType buttonType) Retrieves the `Button` instance of the `DialogControl` which is of the specified `ButtonType`. Parameters buttonType:ButtonType to retrieve from the `DialogControl` Returns:Optional<Button> the button or an empty `Optional`, if the `DialogControl` hasn't been initialized before

public final Optional<Button> getButton(ButtonType buttonType)

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

Parameters

buttonType:ButtonType: to retrieve from the DialogControl

Returns:Optional<Button>

the button or an empty Optional, if the DialogControl hasn't been initialized before

getButtons	back to summary
public final ObservableList<Button> getButtons()

getCancelButtonType	back to summary
public ButtonType getCancelButtonType()

getDialog	back to summary
public final WorkbenchDialog getDialog()

getOnHidden	back to summary
public final EventHandler<Event> getOnHidden()

getOnShown	back to summary
public final EventHandler<Event> getOnShown()

getWorkbench	back to summary
public final Workbench getWorkbench()

hide	back to summary
public final void hide()

isButtonTextUppercase	back to summary
public final boolean isButtonTextUppercase()

isShowing	back to summary
public final boolean isShowing() Returns whether or not the dialog is showing. Returns:boolean true if dialog is showing.

isShowing

back to summary

public final boolean isShowing()

Returns whether or not the dialog is showing.

Returns:boolean: true if dialog is showing.

onHiddenProperty back to summary

onHiddenProperty	back to summary
public final ObjectProperty<EventHandler<Event>> onHiddenProperty() The dialog's action, which is invoked whenever the dialog has been hidden in the scene graph. An event will be fired whenever `hide()` or `Workbench#hideDialog(WorkbenchDialog)` has been called or the dialog has been closed by clicking on its corresponding `GlassPane`. Returns:ObjectProperty<EventHandler<Event>> the property to represent the event, which is invoked whenever the dialog has been hidden in the scene graph.

public final ObjectProperty<EventHandler<Event>> onHiddenProperty()

The dialog's action, which is invoked whenever the dialog has been hidden in the scene graph. An event will be fired whenever hide() or Workbench#hideDialog(WorkbenchDialog) has been called or the dialog has been closed by clicking on its corresponding GlassPane.

Returns:ObjectProperty<EventHandler<Event>>: the property to represent the event, which is invoked whenever the dialog has been hidden in the scene graph.

onShownProperty back to summary

onShownProperty	back to summary
public final ObjectProperty<EventHandler<Event>> onShownProperty() The dialog's action, which is invoked whenever the dialog has been fully initialized and is being shown. Whenever the `dialogProperty()`, `WorkbenchDialog#buttonTypes`, `buttonTextUppercaseProperty()` or `workbenchProperty()` changes, the dialog will be rebuilt and upon completion, an event will be fired. Returns:ObjectProperty<EventHandler<Event>> the property to represent the event, which is invoked whenever the dialog has been fully initialized and is being shown.

public final ObjectProperty<EventHandler<Event>> onShownProperty()

The dialog's action, which is invoked whenever the dialog has been fully initialized and is being shown. Whenever the dialogProperty(), WorkbenchDialog#buttonTypes, buttonTextUppercaseProperty() or workbenchProperty() changes, the dialog will be rebuilt and upon completion, an event will be fired.

Returns:ObjectProperty<EventHandler<Event>>: the property to represent the event, which is invoked whenever the dialog has been fully initialized and is being shown.

setButtonTextUppercase	back to summary
public final void setButtonTextUppercase(boolean buttonTextUppercase)

setDialog	back to summary
public final void setDialog(WorkbenchDialog dialog)

setOnHidden	back to summary
public final void setOnHidden(EventHandler<Event> value)

setOnShown	back to summary
public final void setOnShown(EventHandler<Event> value)

setShowing	back to summary
private void setShowing(boolean showing)

setupChangeListeners	back to summary
private void setupChangeListeners()

setWorkbench	back to summary
public final void setWorkbench(Workbench workbench)

showingProperty	back to summary
public final ReadOnlyBooleanProperty showingProperty() Represents whether the dialog is currently showing. Returns:ReadOnlyBooleanProperty the property representing whether the dialog is currently showing

showingProperty

back to summary

public final ReadOnlyBooleanProperty showingProperty()

Represents whether the dialog is currently showing.

Returns:ReadOnlyBooleanProperty: the property representing whether the dialog is currently showing

updateButtons	back to summary
private void updateButtons(WorkbenchDialog dialog)

updateKeyboardBehavior	back to summary
private void updateKeyboardBehavior()

workbenchProperty	back to summary
public final ObjectProperty<Workbench> workbenchProperty()

public Class DialogControl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail