Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.gui.controllers

Class DialogController<PreparationType,ResultType>

java.lang.Object

page.codeberg.friedolyn.gui.controllers.Controller<PreparationType>

page.codeberg.friedolyn.gui.controllers.DialogController<PreparationType,ResultType>

Type Parameters:

PreparationType - The type of the object that is passed to the Controller.prepare(PreparationType) method.

ResultType - The type of the result that is returned by the getResult() method.

All Implemented Interfaces:

javafx.fxml.Initializable, Preparable<PreparationType>

Direct Known Subclasses:

ContactController, ContactReplyMethodDialogController, SetupController, SetupEmailDialogController, SetupNtfyDialogController, SetupUnifiedPushDialogController

public abstract class DialogController<PreparationType,ResultType>
extends Controller<PreparationType>

A class that defines the behaviour of a dialog in the JavaFX graphical user interface. The dialog asks the user for certain input and, once it is closed, getResult() returns the result of the dialog.

See Also:

• Controller

Constructor Summary

Constructors

Constructor	Description
DialogController()

Method Summary

Modifier and Type	Method	Description
abstract void	confirm()	This method is called when the user confirms the dialog, i.e.
abstract @NonNull Optional<ResultType>	getResult()

Methods inherited from class page.codeberg.friedolyn.gui.controllers.Controller

close, getSuccess, prepare

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.fxml.Initializable

initialize

Constructor Details

DialogController

public DialogController()

Method Details

getResult

@NonNull
public abstract @NonNull Optional<ResultType> getResult()

Returns:

The result of the dialog. May contain nonsensical data if the dialog has not been closed yet.

confirm

public abstract void confirm()

This method is called when the user confirms the dialog, i.e. presses some kind of "OK" button after having entered the necessary data.