Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.gui.controllers

Class SetupController

java.lang.Object

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

page.codeberg.friedolyn.gui.controllers.DialogController<Friedolyn,Friedolyn>

page.codeberg.friedolyn.gui.controllers.SetupController

All Implemented Interfaces:

javafx.fxml.Initializable, Preparable<Friedolyn>

public class SetupController
extends DialogController<Friedolyn,Friedolyn>

Defines the behaviour of the GUI.Window.SETUP window, which allows the user to set up a new configuration via a graphical user interface.

• Call the prepare(page.codeberg.friedolyn.Friedolyn) method before initialize(java.net.URL, java.util.ResourceBundle).
• Call the getResult() method to get the Friedolyn object whose configuration has been set up according to the user's input.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SetupController.Interval	Represents a time span in days, hours, and minutes.

Field Summary

Fields

Modifier and Type	Field	Description
private javafx.scene.control.Button	buttonBack
private javafx.scene.control.Button	buttonNext
private javafx.scene.control.Button	buttonSelectDirectory
private javafx.scene.control.CheckBox	checkBoxEmail
private javafx.scene.control.CheckBox	checkBoxGridDNT
private javafx.scene.control.CheckBox	checkBoxGridGPC
private javafx.scene.control.CheckBox	checkBoxNtfy
private javafx.scene.control.CheckBox	checkBoxOverwritePDFs
private javafx.scene.control.CheckBox	checkBoxTracking
private javafx.scene.control.CheckBox	checkBoxUnifiedPush
private org.controlsfx.control.CheckComboBox<String>	checkComboBoxPDFs
private org.controlsfx.control.CheckListView<String>	checkListViewDegrees
private javafx.scene.control.ChoiceBox<String>	choiceBoxUserAgentClient
private javafx.scene.control.ChoiceBox<String>	choiceBoxUserAgentPlatform
private File	directory	The new invalid reference directory that the user has selected.
private Friedolyn	friedolyn	Holds the configuration that is being set up.
private javafx.scene.layout.ColumnConstraints	gridColumnTrackingCheckBox
private javafx.scene.layout.GridPane	gridPaneTracking
private javafx.scene.layout.RowConstraints	gridRowDNT
private javafx.scene.layout.HBox	hBoxDNT
private javafx.scene.text.Text	hyperlinkEmail
private javafx.scene.text.Text	hyperlinkNtfy
private javafx.scene.text.Text	hyperlinkUnifiedPush
private boolean	initialisedEmail	This will turn true once the user has set up an EMailNotifier.
private boolean	initialisedNtfy	This will turn true once the user has set up a NtfyNotifier.
private boolean	initialisedUnifiedPush	This will turn true once the user has set up a UnifiedPushNotifier.
private final @NonNull SetupController.Interval	interval	The time span between two fetches of the exam data from Friedolin.
private static final javafx.scene.text.Font	LABEL_FONT
private javafx.scene.control.Label	labelEmail
private javafx.scene.control.Label	labelNtfy
private javafx.scene.control.Label	labelUnifiedPush
private javafx.scene.control.RadioButton	radioIncludeGradesAlways
private javafx.scene.control.RadioButton	radioIncludeGradesGoodOnes
private javafx.scene.control.RadioButton	radioIncludeGradesNever
private @NonNull ResourceBundle	resourceBundle
private boolean	result	Whether the user has successfully entered valid data and closed the window or dialog.
private javafx.scene.control.Spinner<Integer>	spinnerDays
private javafx.scene.control.Spinner<Double>	spinnerGoodGradesMaximum
private javafx.scene.control.Spinner<Integer>	spinnerHours
private javafx.scene.control.Spinner<Integer>	spinnerMinutes
private static final javafx.scene.text.Font	SUBTITLE_FONT
private javafx.scene.control.Tab	tabBasic
private javafx.scene.control.Tab	tabNotifications
private javafx.scene.control.TabPane	tabPaneMain
private javafx.scene.control.Tab	tabPDFs
private javafx.scene.control.Tab	tabStealth
private javafx.scene.control.Tab	tabYourData
private javafx.scene.text.Text	textEmail
private javafx.scene.control.TextField	textFieldDirectory
private javafx.scene.text.TextFlow	textFlowOverwritePDFsDescription
private javafx.scene.text.TextFlow	textFlowTracking
private javafx.scene.text.Text	textGoodGradesLabel1
private javafx.scene.text.Text	textGoodGradesLabel2
private javafx.scene.text.Text	textGoodGradesTitle
private javafx.scene.text.Text	textIntervalDescription
private javafx.scene.text.Text	textName
private javafx.scene.text.Text	textOverwritePDFsDescription
private javafx.scene.text.Text	textTrackingTitle
private javafx.scene.text.Text	textUser
private javafx.scene.text.Text	textYourDataTitle
private boolean	trackingVerbose

Constructor Summary

Constructors

Constructor	Description
SetupController()

Method Summary

Modifier and Type	Method	Description
void	back()	Switches to the previous setup tab without modifying any of the user's input, neither in the current tab nor in the tab to which the user switches.
void	chooseDirectory()	Asks the user to select the directory.
void	close()	Makes the current dialog disappear from the user's screen.
void	confirm()	Called when the user has finished the setup.
@NonNull Optional<Friedolyn>	getResult()
@NonNull FuzzyBoolean	getSuccess()
private void	initialiseStealthTab()	Initialises the choiceBoxUserAgentClient and choiceBoxUserAgentPlatform with the user agents available, so that the user can select a client and a platform.
void	initialize(URL location, ResourceBundle resources)	It is required to call the prepare(page.codeberg.friedolyn.Friedolyn) method immediately after this method.
void	next()	Switches to the next setup tab without modifying any of the user's input, neither in the current tab nor in the tab to which the user switches.
private boolean	openEmailDialog()
private boolean	openNtfyDialog()	Opens the Ntfy setup dialog to ask the user to configure a new NtfyNotifier.
private boolean	openUnifiedPushDialog()	Opens the UnifiedPush setup dialog to ask the user to configure a new UnifiedPushNotifier.
void	prepare(@NonNull Friedolyn friedolyn)	It is required to call this method immediately after initialize(java.net.URL, java.util.ResourceBundle).
private void	resize()
void	toggleEmail()
void	toggleNtfy()	Sets the checkBoxNtfy to the opposite of its current value, i.e.
void	toggleOverwritePDFs()	Sets the checkBoxEmail to the opposite of its current value, i.e.
private void	toggleTracking(boolean verbose)
void	toggleUnifiedPush()	Sets the checkBoxUnifiedPush to the opposite of its current value, i.e.
private void	updateInterval()	Updates the spinnerHours and spinnerMinutes based on the current value of the interval.
private boolean	validate()	Validates the user input.

Methods inherited from class java.lang.Object

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

Field Details

resourceBundle

@NonNull
private @NonNull ResourceBundle resourceBundle

result

private boolean result

Whether the user has successfully entered valid data and closed the window or dialog.

friedolyn

private Friedolyn friedolyn

Holds the configuration that is being set up.

directory

private File directory

The new

invalid reference

directory

that the user has selected.

initialisedEmail

private boolean initialisedEmail

This will turn true once the user has set up an EMailNotifier. This information is needed for the decision whether to automatically open the setup dialog for e-mail notifications when the user toggles the corresponding checkbox. (This is only done the first time the user toggles the checkbox.)

DOES NOT indicate whether the user wants to use e-mail notifications or not. To find out that, check the configuration.

initialisedNtfy

private boolean initialisedNtfy

This will turn true once the user has set up a NtfyNotifier. This information is needed for the decision whether to automatically open the setup dialog for Ntfy when the user toggles the corresponding checkbox. (This is only done the first time the user toggles the checkbox.)

DOES NOT indicate whether the user wants to use Ntfy or not. To find out that, check the configuration.

initialisedUnifiedPush

private boolean initialisedUnifiedPush

This will turn true once the user has set up a UnifiedPushNotifier. This information is needed for the decision whether to automatically open the setup dialog for UnifiedPush when the user toggles the corresponding checkbox. (This is only done the first time the user toggles the checkbox.)

DOES NOT indicate whether the user wants to use UnifiedPush or not. To find out that, check the configuration.

trackingVerbose

private boolean trackingVerbose

SUBTITLE_FONT

private static final javafx.scene.text.Font SUBTITLE_FONT

LABEL_FONT

private static final javafx.scene.text.Font LABEL_FONT

interval

@NonNull
private final @NonNull SetupController.Interval interval

The time span between two fetches of the exam data from Friedolin.

buttonNext

private javafx.scene.control.Button buttonNext

buttonBack

private javafx.scene.control.Button buttonBack

tabPaneMain

private javafx.scene.control.TabPane tabPaneMain

tabYourData

private javafx.scene.control.Tab tabYourData

tabBasic

private javafx.scene.control.Tab tabBasic

tabPDFs

private javafx.scene.control.Tab tabPDFs

tabNotifications

private javafx.scene.control.Tab tabNotifications

tabStealth

private javafx.scene.control.Tab tabStealth

textYourDataTitle

private javafx.scene.text.Text textYourDataTitle

textName

private javafx.scene.text.Text textName

textUser

private javafx.scene.text.Text textUser

textEmail

private javafx.scene.text.Text textEmail

checkListViewDegrees

private org.controlsfx.control.CheckListView<String> checkListViewDegrees

spinnerDays

private javafx.scene.control.Spinner<Integer> spinnerDays

spinnerHours

private javafx.scene.control.Spinner<Integer> spinnerHours

spinnerMinutes

private javafx.scene.control.Spinner<Integer> spinnerMinutes

textIntervalDescription

private javafx.scene.text.Text textIntervalDescription

checkBoxEmail

private javafx.scene.control.CheckBox checkBoxEmail

labelEmail

private javafx.scene.control.Label labelEmail

hyperlinkEmail

private javafx.scene.text.Text hyperlinkEmail

checkBoxNtfy

private javafx.scene.control.CheckBox checkBoxNtfy

labelNtfy

private javafx.scene.control.Label labelNtfy

hyperlinkNtfy

private javafx.scene.text.Text hyperlinkNtfy

checkBoxUnifiedPush

private javafx.scene.control.CheckBox checkBoxUnifiedPush

labelUnifiedPush

private javafx.scene.control.Label labelUnifiedPush

hyperlinkUnifiedPush

private javafx.scene.text.Text hyperlinkUnifiedPush

radioIncludeGradesAlways

private javafx.scene.control.RadioButton radioIncludeGradesAlways

radioIncludeGradesGoodOnes

private javafx.scene.control.RadioButton radioIncludeGradesGoodOnes

radioIncludeGradesNever

private javafx.scene.control.RadioButton radioIncludeGradesNever

spinnerGoodGradesMaximum

private javafx.scene.control.Spinner<Double> spinnerGoodGradesMaximum

textGoodGradesTitle

private javafx.scene.text.Text textGoodGradesTitle

textGoodGradesLabel1

private javafx.scene.text.Text textGoodGradesLabel1

textGoodGradesLabel2

private javafx.scene.text.Text textGoodGradesLabel2

checkComboBoxPDFs

private org.controlsfx.control.CheckComboBox<String> checkComboBoxPDFs

checkBoxOverwritePDFs

private javafx.scene.control.CheckBox checkBoxOverwritePDFs

textFlowOverwritePDFsDescription

private javafx.scene.text.TextFlow textFlowOverwritePDFsDescription

textOverwritePDFsDescription

private javafx.scene.text.Text textOverwritePDFsDescription

buttonSelectDirectory

private javafx.scene.control.Button buttonSelectDirectory

textFieldDirectory

private javafx.scene.control.TextField textFieldDirectory

choiceBoxUserAgentClient

private javafx.scene.control.ChoiceBox<String> choiceBoxUserAgentClient

choiceBoxUserAgentPlatform

private javafx.scene.control.ChoiceBox<String> choiceBoxUserAgentPlatform

gridPaneTracking

private javafx.scene.layout.GridPane gridPaneTracking

checkBoxTracking

private javafx.scene.control.CheckBox checkBoxTracking

gridColumnTrackingCheckBox

private javafx.scene.layout.ColumnConstraints gridColumnTrackingCheckBox

textTrackingTitle

private javafx.scene.text.Text textTrackingTitle

textFlowTracking

private javafx.scene.text.TextFlow textFlowTracking

gridRowDNT

private javafx.scene.layout.RowConstraints gridRowDNT

hBoxDNT

private javafx.scene.layout.HBox hBoxDNT

checkBoxGridDNT

private javafx.scene.control.CheckBox checkBoxGridDNT

checkBoxGridGPC

private javafx.scene.control.CheckBox checkBoxGridGPC

Constructor Details

SetupController

public SetupController()

Method Details

getSuccess

@NonNull
public @NonNull FuzzyBoolean getSuccess()

Overrides:

getSuccess in class Controller<Friedolyn>

Returns:

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

getResult

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

Specified by:

getResult in class DialogController<Friedolyn,Friedolyn>

Returns:

A Friedolyn object whose configuration has been set up according to the user's input.

updateInterval

private void updateInterval()

Updates the spinnerHours and spinnerMinutes based on the current value of the interval.

• If the number of days is Friedolyn.MAXIMUM_INTERVAL_DAYS, the maximum number of hours and minutes is set to 0 and a message is displayed to the user stating what the maximum number of days is.
• If the number of days is 0 and the number of hours is 0, the minimum number of minutes is set to Friedolyn.MINIMUM_INTERVAL_MINUTES.
• If the total number of minutes is Friedolyn.MINIMUM_INTERVAL_MINUTES, a message is displayed to the user stating what the minimum number of minutes is.

initialize

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

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

Parameters:

location - See Initializable.initialize(URL, ResourceBundle).

resources - See Initializable.initialize(URL, ResourceBundle).

toggleTracking

private void toggleTracking(boolean verbose)

openEmailDialog

private boolean openEmailDialog()

openNtfyDialog

private boolean openNtfyDialog()

Opens the Ntfy setup dialog to ask the user to configure a new NtfyNotifier.

openUnifiedPushDialog

private boolean openUnifiedPushDialog()

Opens the UnifiedPush setup dialog to ask the user to configure a new UnifiedPushNotifier.

toggleEmail

public void toggleEmail()

toggleNtfy

public void toggleNtfy()

Sets the checkBoxNtfy to the opposite of its current value, i.e. the user toggles the setting whether to send notifications via Ntfy.

toggleUnifiedPush

public void toggleUnifiedPush()

Sets the checkBoxUnifiedPush to the opposite of its current value, i.e. the user toggles the setting whether to send notifications via UnifiedPush.

initialiseStealthTab

private void initialiseStealthTab()

Initialises the choiceBoxUserAgentClient and choiceBoxUserAgentPlatform with the user agents available, so that the user can select a client and a platform.

prepare

public void prepare(@NonNull
 @NonNull Friedolyn friedolyn)

It is required to call this method immediately after initialize(java.net.URL, java.util.ResourceBundle). Populates the setup dialog with the user's information, such as their name, user name, e-mail address, academic degrees available for tracking. Initialises the stealth tab with the user agents available.

Specified by:

prepare in interface Preparable<Friedolyn>

Overrides:

prepare in class Controller<Friedolyn>

Parameters:

friedolyn - The Friedolyn object whose configuration is being set up.

See Also:

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

toggleOverwritePDFs

public void toggleOverwritePDFs()

Sets the checkBoxEmail to the opposite of its current value, i.e. the user toggles the setting whether, when downloading the grade table as a PDF, older versions of the PDF should be overwritten.

See Also:

• invalid reference

  Configuration#setOverwriteExistingExamsPDFs(Boolean)

chooseDirectory

public void chooseDirectory()

Asks the user to select the directory.

See Also:

• Configuration.setDirectory(File)
• Friedolyn.DEFAULT_ROOT

validate

private boolean validate()

Validates the user input. If the input is invalid, the user is informed about the error and the corresponding tab is selected. Specifically, it is checked that:

• The user has selected a directory.
• The user has selected at least one degree.
• The user has selected at least one of the notification channels available.

Returns:

true if the user input is valid, false otherwise.

next

public void next()

Switches to the next setup tab without modifying any of the user's input, neither in the current tab nor in the tab to which the user switches.

back

public void back()

Switches to the previous setup tab without modifying any of the user's input, neither in the current tab nor in the tab to which the user switches.

confirm

public void confirm()

Called when the user has finished the setup. Validates the user input and closes the window if the input is valid.

Specified by:

confirm in class DialogController<Friedolyn,Friedolyn>

resize

private void resize()
             throws NullPointerException

Throws:

NullPointerException

close

public void close()

Makes the current dialog disappear from the user's screen.

Specified by:

close in class Controller<Friedolyn>