Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.gui.controllers

Class SetupEmailDialogController

java.lang.Object

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

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

page.codeberg.friedolyn.gui.controllers.SetupEmailDialogController

All Implemented Interfaces:

javafx.fxml.Initializable, Preparable<Configuration>

public class SetupEmailDialogController
extends DialogController<Configuration,EMailNotifier>

Specifies the behaviour of the GUI.Window.SETUP_EMAIL_DIALOG dialog.

Field Summary

Fields

Modifier and Type	Field	Description
private javafx.scene.layout.BorderPane	borderPane
private javafx.scene.control.CheckBox	checkBoxPGP
private EMailNotifier	emailNotifier	The EMailNotifier that is being set up by the user.
private static final @NonNull URL	EVOLUTION_WEBSITE	The Evolution website.
private javafx.scene.control.Label	hyperlinkEvolution
private javafx.scene.control.Label	hyperlinkK9Mail
private javafx.scene.control.Hyperlink	hyperlinkTest
private javafx.scene.control.Label	hyperlinkThunderbird
private static final @NonNull URL	K9_WEBSITE	The K-9 Mail website.
private @NonNull ResourceBundle	resourceBundle	Contains the translations for the dialog's text elements and popups.
private Boolean	result	The result of the dialog.
private javafx.scene.control.TextArea	textAreaPgpPaste
private static final @NonNull URL	THUNDERBIRD_WEBSITE	The Thunderbird website.

Constructor Summary

Constructors

Constructor	Description
SetupEmailDialogController()

Method Summary

Modifier and Type	Method	Description
void	close()	Makes the dialog disappear from the user's screen.
void	confirm()	The user confirms their input in order to close the dialog.
@NonNull Optional<EMailNotifier>	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	openEvolutionWebsite()
void	openK9Website()	Opens the K-9 Mail website in the user's default web browser.
void	openThunderbirdWebsite()	Opens the Thunderbird website in the user's default web browser.
void	prepare(@NonNull Configuration configuration)	Uses the given Configuration to insert the user's current e-mail setup into the dialog.
void	testSetup()	Sends a test notification to the user's e-mail address to verify that the setup is correct.
private void	toggleHidePgpTextArea(boolean hide)	Switches the visibility of the PGP public key text area.
private boolean	validate()	Validates the user's input and updates the emailNotifier accordingly.

Methods inherited from class java.lang.Object

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

Field Details

K9_WEBSITE

@NonNull
private static final @NonNull URL K9_WEBSITE

The K-9 Mail website.

THUNDERBIRD_WEBSITE

@NonNull
private static final @NonNull URL THUNDERBIRD_WEBSITE

The Thunderbird website.

EVOLUTION_WEBSITE

@NonNull
private static final @NonNull URL EVOLUTION_WEBSITE

The Evolution website.

resourceBundle

@NonNull
private @NonNull ResourceBundle resourceBundle

Contains the translations for the dialog's text elements and popups.

emailNotifier

@Nullable
private EMailNotifier emailNotifier

The EMailNotifier that is being set up by the user.

result

@Nullable
private Boolean result

The result of the dialog. true if the user confirmed the dialog, false if the user cancelled it, null if the dialog is still open.

borderPane

private javafx.scene.layout.BorderPane borderPane

hyperlinkK9Mail

private javafx.scene.control.Label hyperlinkK9Mail

hyperlinkThunderbird

private javafx.scene.control.Label hyperlinkThunderbird

hyperlinkEvolution

private javafx.scene.control.Label hyperlinkEvolution

checkBoxPGP

private javafx.scene.control.CheckBox checkBoxPGP

textAreaPgpPaste

private javafx.scene.control.TextArea textAreaPgpPaste

hyperlinkTest

private javafx.scene.control.Hyperlink hyperlinkTest

Constructor Details

SetupEmailDialogController

public SetupEmailDialogController()

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).

toggleHidePgpTextArea

private void toggleHidePgpTextArea(boolean hide)

Switches the visibility of the PGP public key text area.

Parameters:

hide - true to visually remove the text area from the dialog, false to make it re-appear.

prepare

public void prepare(@NonNull
 @NonNull Configuration configuration)
             throws IllegalArgumentException

Uses the given Configuration to insert the user's current e-mail 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. Configuration.getEmail() and Configuration.getUser() must not be empty.

Throws:

IllegalArgumentException - If the configuration does not contain an e-mail address or no user.

See Also:

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

openK9Website

public void openK9Website()

Opens the K-9 Mail website in the user's default web browser.

openThunderbirdWebsite

public void openThunderbirdWebsite()

Opens the Thunderbird website in the user's default web browser.

openEvolutionWebsite

public void openEvolutionWebsite()

validate

private boolean validate()

Validates the user's input and updates the emailNotifier accordingly.

Returns:

true if the user's PGP is unset or valid, false if it's invalid.

testSetup

public void testSetup()

Sends a test notification to the user's e-mail address to verify that the setup is correct.

confirm

public void confirm()

The user confirms their input in order to close the dialog. Validates the user's input before proceeding.

Specified by:

confirm in class DialogController<Configuration,EMailNotifier>

getSuccess

@NonNull
public @NonNull FuzzyBoolean getSuccess()

Overrides:

getSuccess in class Controller<Configuration>

Returns:

• FuzzyBoolean.TRUE iff the user has entered valid data and closed the window or dialog.
• If FuzzyBoolean.FALSE is returned, it means the user has entered invalid data and closed the window or dialog.
• If FuzzyBoolean.MAYBE is returned if the window/dialog is still open or if it is unclear whether the user has entered valid data.

getResult

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

Specified by:

getResult in class DialogController<Configuration,EMailNotifier>

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>