Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.gui.controllers

Class SetupNtfyDialogController

java.lang.Object

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

page.codeberg.friedolyn.gui.controllers.DialogController<Configuration,NtfyNotifier>

page.codeberg.friedolyn.gui.controllers.SetupNtfyDialogController

All Implemented Interfaces:

javafx.fxml.Initializable, Preparable<Configuration>

public class SetupNtfyDialogController
extends DialogController<Configuration,NtfyNotifier>

Defines the behaviour of the GUI.Window.SETUP_NTFY_DIALOG dialog, which asks the user to configure a NtfyNotifier for sending notifications via the Ntfy service.

• Call the prepare(page.codeberg.friedolyn.configuration.Configuration) method before initialize(java.net.URL, java.util.ResourceBundle).
• Use getSuccess() to determine whether the user has entered valid data.
• Get the user's input via getResult().

Field Summary

Fields

Modifier and Type	Field	Description
private javafx.scene.layout.BorderPane	borderPane
private static final @NonNull URL	NTFY_WEBSITE	Ntfy's project website: ntfy.sh
private NtfyNotifier	ntfyNotifier	The user's input as a NtfyNotifier.
private @NonNull ResourceBundle	resourceBundle
private boolean	result	True if the user has entered valid data and closed the dialog, false otherwise.
private javafx.scene.control.TextField	textFieldHost
private javafx.scene.control.TextField	textFieldTopic

Constructor Summary

Constructors

Constructor	Description
SetupNtfyDialogController()

Method Summary

Modifier and Type	Method	Description
void	close()	Makes the dialog disappear from the user's screen.
void	confirm()	Called when the user clicks the “OK” button to save the entered data.
@NonNull Optional<NtfyNotifier>	getResult()
@NonNull FuzzyBoolean	getSuccess()
void	initialize(URL location, ResourceBundle resources)	It is required to call prepare(page.codeberg.friedolyn.configuration.Configuration) immediately after this method.
void	openNtfyWebsite()	Opens the Ntfy website in the user's default browser.
void	prepare(@NonNull Configuration configuration)	Uses the given Configuration to insert the user's current Ntfy setup into the dialog.
void	testSetup()	Sends a test notification to the user's Ntfy setup to verify that it works.
private boolean	validate()	Checks that the user has entered a valid invalid reference host and invalid reference topic

Methods inherited from class java.lang.Object

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

Field Details

NTFY_WEBSITE

@NonNull
private static final @NonNull URL NTFY_WEBSITE

Ntfy's project website: ntfy.sh

resourceBundle

@NonNull
private @NonNull ResourceBundle resourceBundle

ntfyNotifier

@Nullable
private NtfyNotifier ntfyNotifier

The user's input as a NtfyNotifier. null by default.

result

private boolean result

True if the user has entered valid data and closed the dialog, false otherwise.

borderPane

private javafx.scene.layout.BorderPane borderPane

textFieldHost

private javafx.scene.control.TextField textFieldHost

textFieldTopic

private javafx.scene.control.TextField textFieldTopic

Constructor Details

SetupNtfyDialogController

public SetupNtfyDialogController()

Method Details

initialize

public void initialize(@Nullable
 URL location,
 @Nullable
 ResourceBundle resources)

It is required to call prepare(page.codeberg.friedolyn.configuration.Configuration) immediately after this method.

Parameters:

location - See Initializable.initialize(java.net.URL, java.util.ResourceBundle).

resources - See Initializable.initialize(java.net.URL, java.util.ResourceBundle).

prepare

public void prepare(@NonNull
 @NonNull Configuration configuration)

Uses the given Configuration to insert the user's current Ntfy setup into the dialog. It is required to call this method before initialize(java.net.URL, java.util.ResourceBundle).

Specified by:

prepare in interface Preparable<Configuration>

Overrides:

prepare in class Controller<Configuration>

Parameters:

configuration - The Configuration to use for the setup.

See Also:

• SetupController.prepare(page.codeberg.friedolyn.Friedolyn)
• prepare(page.codeberg.friedolyn.configuration.Configuration)
• SetupUnifiedPushDialogController.prepare(page.codeberg.friedolyn.configuration.Configuration)
• MainController.prepare(page.codeberg.friedolyn.Friedolyn)
• ContactController.prepare(page.codeberg.friedolyn.gui.controllers.ContactController.InitialisationParameters)
• ContactReplyMethodDialogController.prepare(page.codeberg.friedolyn.configuration.Configuration)

openNtfyWebsite

public void openNtfyWebsite()

Opens the Ntfy website in the user's default browser.

testSetup

public void testSetup()

Sends a test notification to the user's Ntfy setup to verify that it works.

validate

private boolean validate()

Checks that the user has entered a valid

invalid reference

host

and

invalid reference

topic

Returns:

true if the user has entered valid data, false otherwise.

confirm

public void confirm()

Called when the user clicks the “OK” button to save the entered data. Validates the user's input and, if it is valid, sets the result to true and closes the dialog.

Specified by:

confirm in class DialogController<Configuration,NtfyNotifier>

getSuccess

@NonNull
public @NonNull FuzzyBoolean getSuccess()

Overrides:

getSuccess in class Controller<Configuration>

Returns:

FuzzyBoolean.TRUE if the user has entered valid data and closed the dialog, FuzzyBoolean.FALSE otherwise. It is guaranteed that FuzzyBoolean.MAYBE is never returned.

getResult

@NonNull
public @NonNull Optional<NtfyNotifier> getResult()

Specified by:

getResult in class DialogController<Configuration,NtfyNotifier>

Returns:

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

close

public void close()

Makes the dialog disappear from the user's screen.

Specified by:

close in class Controller<Configuration>