Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.gui.controllers

Class SetupUnifiedPushDialogController

java.lang.Object

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

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

page.codeberg.friedolyn.gui.controllers.SetupUnifiedPushDialogController

All Implemented Interfaces:

javafx.fxml.Initializable, Preparable<Configuration>

public class SetupUnifiedPushDialogController
extends DialogController<Configuration,UnifiedPushNotifier>

A class that defines the behaviour of the setup dialog for the UnifiedPushNotifier that shall be used to send push notifications to the user's device.

• 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 Configuration	configuration	Will be set as the notifier's configuration.
private UnifiedPushNotifier	notifier	The user's input as a UnifiedPushNotifier.
private ResourceBundle	resourceBundle
private boolean	result	True if the user has entered valid data and closed the dialog, false otherwise.
private javafx.scene.control.TextField	textFieldURL
private static final URL	UNIFIED_PUSH_WEBSITE

Constructor Summary

Constructors

Constructor	Description
SetupUnifiedPushDialogController()

Method Summary

Modifier and Type	Method	Description
void	close()	Makes the dialog disappear from the user's screen.
void	confirm()	This method is called when the user clicks the "Confirm" button.
@NonNull Optional<UnifiedPushNotifier>	getResult()
@NonNull FuzzyBoolean	getSuccess()
void	initialize(URL location, @NonNull ResourceBundle resources)	It is required to call the prepare(page.codeberg.friedolyn.configuration.Configuration) method immediately after this method.
void	openUnifiedPushWebsite()	Opens the UnifiedPush website in the user's default browser.
void	prepare(@NonNull Configuration configuration)	Uses the given Configuration to insert the user's current UnifiedPush setup into the dialog.
void	testSetup()	Sends a test notification to the user's device to verify that the UnifiedPush setup made by the user works fine.
private boolean	validate()	Checks that the user has entered a valid URL in the textFieldURL field.

Methods inherited from class java.lang.Object

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

Field Details

UNIFIED_PUSH_WEBSITE

private static final URL UNIFIED_PUSH_WEBSITE

result

private boolean result

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

configuration

private Configuration configuration

Will be set as the notifier's configuration.

resourceBundle

private ResourceBundle resourceBundle

notifier

@Nullable
private UnifiedPushNotifier notifier

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

borderPane

private javafx.scene.layout.BorderPane borderPane

textFieldURL

private javafx.scene.control.TextField textFieldURL

Constructor Details

SetupUnifiedPushDialogController

public SetupUnifiedPushDialogController()

Method Details

initialize

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

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

Parameters:

location - See initialize.

resources - See initialize.

prepare

public void prepare(@NonNull
 @NonNull Configuration configuration)

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

Specified by:

prepare in interface Preparable<Configuration>

Overrides:

prepare in class Controller<Configuration>

Parameters:

configuration - The UnifiedPushNotifier in configuration.getNotifications() will be used to populate the dialog. The Configuration itself will be associated with the resulting UnifiedPushNotifier as specified in its constructor, i.e. must be the correct reference.

See Also:

• SetupController.prepare(page.codeberg.friedolyn.Friedolyn)
• SetupNtfyDialogController.prepare(page.codeberg.friedolyn.configuration.Configuration)
• 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)

openUnifiedPushWebsite

public void openUnifiedPushWebsite()

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

testSetup

public void testSetup()

Sends a test notification to the user's device to verify that the UnifiedPush setup made by the user works fine.

validate

private boolean validate()

Checks that the user has entered a valid URL in the textFieldURL field. If not, an error message is displayed to the user in form of an alert popup.

Returns:

true if the user has entered a valid URL, false otherwise.

confirm

public void confirm()

This method is called when the user clicks the "Confirm" button. It validates the user's input and, if everything is valid, sets the result to true and closes the dialog.

Specified by:

confirm in class DialogController<Configuration,UnifiedPushNotifier>

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<UnifiedPushNotifier> getResult()

Specified by:

getResult in class DialogController<Configuration,UnifiedPushNotifier>

Returns:

The user's input as a UnifiedPushNotifier.

close

public void close()

Makes the dialog disappear from the user's screen.

Specified by:

close in class Controller<Configuration>