Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.gui

Class Popup

java.lang.Object

page.codeberg.friedolyn.gui.Popup

public class Popup
extends Object

Constructor Summary

Constructors

Constructor	Description
Popup()

Method Summary

Modifier and Type	Method	Description
static void	alert(@NonNull String title, @NonNull String header, @NonNull String content)	Shows an alert popup and waits for the user to close it.
static void	alert(@NonNull String title, @NonNull String header, @NonNull String content, boolean wait)	Shows an alert popup.
static boolean	confirm(@NonNull String title, @NonNull String header, @NonNull String content)	Shows a confirmation popup.
static boolean	confirm(@NonNull String title, @NonNull String header, @NonNull String content, @NonNull String confirm, @NonNull String cancel)	Shows a confirmation popup with a custom confirm and cancel button text.
static void	info(@NonNull String title, @NonNull String header, @NonNull String content)	Shows an informational popup that does not require user interaction.
private static void	popup(javafx.scene.control.Alert.AlertType type, @NonNull String title, @NonNull String header, @NonNull String content, boolean wait)	Shows a popup of a given Alert.AlertType.

Methods inherited from class java.lang.Object

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

Constructor Details

Popup

public Popup()

Method Details

alert

public static void alert(@NonNull
 @NonNull String title,
 @NonNull
 @NonNull String header,
 @NonNull
 @NonNull String content)

Shows an alert popup and waits for the user to close it.

Parameters:

title - Title of the popup

header - Headline of the popup

content - description text of the popup

alert

public static void alert(@NonNull
 @NonNull String title,
 @NonNull
 @NonNull String header,
 @NonNull
 @NonNull String content,
 boolean wait)

Shows an alert popup.

Parameters:

title - Title of the popup

header - Headline of the popup

content - description text of the popup

wait - whether to wait for the user to close the popup

confirm

public static boolean confirm(@NonNull
 @NonNull String title,
 @NonNull
 @NonNull String header,
 @NonNull
 @NonNull String content)

Shows a confirmation popup.

Parameters:

title - Title of the popup

header - Headline of the popup

content - Description text of the popup

See Also:

• confirm(String, String, String, String, String)

confirm

public static boolean confirm(@NonNull
 @NonNull String title,
 @NonNull
 @NonNull String header,
 @NonNull
 @NonNull String content,
 @NonNull
 @NonNull String confirm,
 @NonNull
 @NonNull String cancel)

Shows a confirmation popup with a custom confirm and cancel button text.

Parameters:

title - Title of the popup

header - Headline of the popup

content - Description text of the popup

confirm - Text of the confirm button. If the user clicks this button, the method returns true.

cancel - Text of the cancel button. If the user clicks this button, the method returns false.

Returns:

true if the user clicked the confirm button, false if the user clicked the cancel button

See Also:

• confirm(String, String, String)

info

public static void info(@NonNull
 @NonNull String title,
 @NonNull
 @NonNull String header,
 @NonNull
 @NonNull String content)

Shows an informational popup that does not require user interaction. Does not wait for the user to close.

Parameters:

title - Title of the popup

header - Headline of the popup

content - Description text of the popup

popup

private static void popup(@NonNull
 javafx.scene.control.Alert.AlertType type,
 @NonNull
 @NonNull String title,
 @NonNull
 @NonNull String header,
 @NonNull
 @NonNull String content,
 boolean wait)

Shows a popup of a given Alert.AlertType.

Parameters:

type - the AlertType

title - the title of the popup

header - the headline of the popup

content - the description text of the popup