de.carne.jfx.scene.control

Class DialogController<R>

java.lang.Object

de.carne.jfx.fxml.FXMLController<javafx.scene.control.Dialog<R>>

de.carne.jfx.scene.control.DialogController<R>

Type Parameters:

R - The dialog's result type.

Direct Known Subclasses:

AboutInfoController

public abstract class DialogController<R>
extends FXMLController<javafx.scene.control.Dialog<R>>

Controller class for Dialog based windows.

See Also:

FXMLController

Constructor Summary

Constructors

Constructor and Description
DialogController()

Method Summary

Modifier and Type	Method and Description
protected void	addButtonEventFilter(javafx.scene.control.ButtonType buttonType, javafx.event.EventHandler<? super javafx.event.ActionEvent> filter) Register a button event filter.
protected javafx.stage.Modality	getModality() This function is called during dialog initialization to initialize the dialog's modality.
protected javafx.stage.StageStyle	getStyle() This function is called during dialog initialization to initialize the dialog's style.
javafx.stage.Window	getWindow() Get the UI window.
static <R,C extends DialogController<R>> C	loadDialog(javafx.stage.Window owner, java.util.function.Function<C,javafx.scene.control.Dialog<R>> dialogFactory, java.lang.Class<C> controllerClass) Load and create new dialog.
protected javafx.scene.Node	lookupButton(javafx.scene.control.ButtonType buttonType) Lookup a dialog button.
protected void	setupDialog(javafx.scene.control.Dialog<R> dialog) This function is called during dialog initialization to perform the actual dialog setup.
protected void	setupUI(@Nullable javafx.stage.Window owner, javafx.scene.control.Dialog<R> dialog, javafx.scene.Parent fxmlRoot) This function is called during UI initialization to perform the actual UI setup.
void	show() Show the controller's dialog and return.
java.util.Optional<R>	showAndWait() Show the controller's dialog and wait until it is closed.

Methods inherited from class de.carne.jfx.fxml.FXMLController

getResources, getUI, loadUI

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogController

public DialogController()

Method Detail

loadDialog

public static <R,C extends DialogController<R>> C loadDialog(javafx.stage.Window owner,
                                                             java.util.function.Function<C,javafx.scene.control.Dialog<R>> dialogFactory,
                                                             java.lang.Class<C> controllerClass)
                                                      throws java.io.IOException

Load and create new dialog.

Type Parameters:

R - The dialog's result type.

C - The actual DialogController type.

Parameters:

owner - The dialog's owner (may be null).

dialogFactory - The factory function used to create the actual dialog object by invoking it with the constructed controller.

controllerClass - The controller class to use.

Returns:

The constructed controller which is bound to the newly created dialog.

Throws:

java.io.IOException - if an I/O error occurs during dialog loading.

getWindow

public final javafx.stage.Window getWindow()

Description copied from class: FXMLController

Get the UI window.

Specified by:

getWindow in class FXMLController<javafx.scene.control.Dialog<R>>

Returns:

The UI window.

setupUI

protected void setupUI(@Nullable javafx.stage.Window owner,
                       javafx.scene.control.Dialog<R> dialog,
                       javafx.scene.Parent fxmlRoot)

Description copied from class: FXMLController

This function is called during UI initialization to perform the actual UI setup.

Specified by:

setupUI in class FXMLController<javafx.scene.control.Dialog<R>>

Parameters:

owner - The UI object's owner (may by null).

dialog - The constructed UI object.

fxmlRoot - The scene's root node as defined by the FXML resource.

getStyle

protected javafx.stage.StageStyle getStyle()

This function is called during dialog initialization to initialize the dialog's style.

The default style is StageStyle.DECORATED.

Returns:

The dialog style to use.

See Also:

StageStyle

getModality

protected javafx.stage.Modality getModality()

This function is called during dialog initialization to initialize the dialog's modality.

The default modality is Modality.WINDOW_MODAL.

Returns:

The modality to use.

See Also:

Modality

setupDialog

protected void setupDialog(javafx.scene.control.Dialog<R> dialog)

This function is called during dialog initialization to perform the actual dialog setup.

Parameters:

dialog - The dialog to setup.

lookupButton

protected final javafx.scene.Node lookupButton(javafx.scene.control.ButtonType buttonType)

Lookup a dialog button.

Parameters:

buttonType - The button type to look up.

Returns:

The button node or null if the button type has not been created.

See Also:

DialogPane.lookupButton(ButtonType)

addButtonEventFilter

protected final void addButtonEventFilter(javafx.scene.control.ButtonType buttonType,
                                          javafx.event.EventHandler<? super javafx.event.ActionEvent> filter)

Register a button event filter.

Parameters:

buttonType - The button type to register the filter for.

filter - The filter to register.

show

public void show()

Show the controller's dialog and return.

See Also:

Dialog.show()

showAndWait

public java.util.Optional<R> showAndWait()

Show the controller's dialog and wait until it is closed.

Returns:

The dialog result.

See Also:

Dialog.showAndWait()