Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.gui.controllers

Class FirstLaunchController

java.lang.Object

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

page.codeberg.friedolyn.gui.controllers.FirstLaunchController

All Implemented Interfaces:

javafx.fxml.Initializable, Preparable<Void>

public class FirstLaunchController
extends Controller<Void>

Provides the logic for the window initially shown to the user when they start Friedolyn for the first time. This window is used to log in to the University of Jena's Friedolin system.

Field Summary

Fields

Modifier and Type	Field	Description
private javafx.scene.layout.BorderPane	borderPaneMain	Holds the main content of the window, i.e.
private javafx.scene.control.Button	buttonCancelLogin	The “Cancel” button on the loading screen to abruptly abort the background operation and return to the main window.
private javafx.scene.control.Button	buttonProceed
private javafx.scene.control.CheckBox	checkBoxObligationOfUse
private Configuration	configuration
private javafx.scene.control.TextField	passwordField
private io.github.palexdev.materialfx.controls.MFXProgressSpinner	progressSpinner	Indicates how much of the background operation has already been completed.
private ResourceBundle	resourceBundle
private javafx.scene.control.TextField	textFieldUser
private javafx.scene.layout.VBox	vBoxLoading	The loading screen showing a progress spinner.

Constructor Summary

Constructors

Constructor	Description
FirstLaunchController()

Method Summary

Modifier and Type	Method	Description
void	close()	Makes the current window or dialog disappear from the user's screen.
void	initialize(URL location, @NonNull ResourceBundle resources)
void	loginWithKeePassXC()	Tries to connect to a running instance of the KeePassXC password manager and retrieve the user's Friedolin login credentials from there.
void	proceed()	Handles the user's click on the “Proceed” button and tries to log in to the University of Jena's Friedolin system with the student's credentials entered in the username and password fields.
protected void	setResourceBundle(ResourceBundle resourceBundle)	Updates the resourceBundle of this controller if it hasn't been set yet.
void	toggleAcceptObligationOfUseCheckBox()	Toggles the state of the “I accept the obligation of use” checkbox.
private void	toggleLoadingSpinner(boolean active)	Shows or hides the loading screen showing a progress spinner.

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

getSuccess, prepare

Methods inherited from class java.lang.Object

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

Field Details

resourceBundle

private ResourceBundle resourceBundle

configuration

@Nullable
private Configuration configuration

textFieldUser

private javafx.scene.control.TextField textFieldUser

passwordField

private javafx.scene.control.TextField passwordField

checkBoxObligationOfUse

private javafx.scene.control.CheckBox checkBoxObligationOfUse

buttonProceed

private javafx.scene.control.Button buttonProceed

borderPaneMain

private javafx.scene.layout.BorderPane borderPaneMain

Holds the main content of the window, i.e. the login fields and the “Proceed” button. This is disabled while the loading screen is shown.

vBoxLoading

private javafx.scene.layout.VBox vBoxLoading

The loading screen showing a progress spinner.

progressSpinner

private io.github.palexdev.materialfx.controls.MFXProgressSpinner progressSpinner

Indicates how much of the background operation has already been completed. Child of the loading screen.

buttonCancelLogin

private javafx.scene.control.Button buttonCancelLogin

The “Cancel” button on the loading screen to abruptly abort the background operation and return to the main window. Child of the loading screen.

Constructor Details

FirstLaunchController

public FirstLaunchController()

Method Details

setResourceBundle

protected void setResourceBundle(ResourceBundle resourceBundle)
                          throws IllegalStateException

Updates the resourceBundle of this controller if it hasn't been set yet.

Parameters:

resourceBundle - The resource bundle to set.

Throws:

IllegalStateException - If the resource bundle has already been set.

initialize

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

loginWithKeePassXC

public void loginWithKeePassXC()

Tries to connect to a running instance of the KeePassXC password manager and retrieve the user's Friedolin login credentials from there. If the connection is successful, the username and password fields are filled with the retrieved credentials. If the connection fails, an error popup is shown.

proceed

public void proceed()

Handles the user's click on the “Proceed” button and tries to log in to the University of Jena's Friedolin system with the student's credentials entered in the username and password fields.

Will show an error popup if the “I accept the obligation of use” checkbox is not checked. All non-GUI operations are executed in a separate thread in order to not block the GUI and not incentivise the operating system (looking at you, Windows) to tell the user that we're "not responding". Instead, a loading screen with a progress spinner is displayed.

toggleAcceptObligationOfUseCheckBox

public void toggleAcceptObligationOfUseCheckBox()

Toggles the state of the “I accept the obligation of use” checkbox. If it was checked, it will be unchecked and vice versa.

toggleLoadingSpinner

private void toggleLoadingSpinner(boolean active)

Shows or hides the loading screen showing a progress spinner. This is supposed to be used while performing heavy non-GUI operations whose response time could be significant, like making a network request or reading from a file.

Did you know?

The loading screen features the progressSpinner whose progress property can be bound to a Task's progress property to show a percentage indicating how much of the operation has already been completed.

Parameters:

active - true to show the loading screen, false to hide it.

Implementation Note:

You might want to consider ordering the disabling/enabling statements such that disabling an element is done before enabling another one, to prevent them from being clickable both at the same time. However, this would require introducing several conditionals, which wouldn't be worth it in this case, because the enabling/disabling is almost instantaneous.

close

public void close()

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

Specified by:

close in class Controller<Void>