eu.fthevenet.binjr.dialogs

Class Dialogs

java.lang.Object

eu.fthevenet.binjr.dialogs.Dialogs

public class Dialogs
extends java.lang.Object

Defines helper methods to facilitate the display of common dialog boxes

Author:

Frederic Thevenet

Constructor Summary

Constructors

Constructor and Description
Dialogs()

Method Summary

Modifier and Type	Method and Description
static javafx.scene.control.ButtonType	confirmDialog(javafx.scene.Node node, java.lang.String header, java.lang.String content, javafx.scene.control.ButtonType... buttons) Displays a confirmation dialog box.
static javafx.scene.control.ButtonType	confirmDialog(javafx.scene.Node node, java.lang.String header, java.lang.String content, javafx.scene.Node icon, javafx.scene.control.ButtonType... buttons) Displays a confirmation dialog box.
static javafx.scene.control.ButtonType	confirmSaveDialog(javafx.scene.Node node, java.lang.String fileName) Displays a dialog box that provides the end user with an opportunity to save the current state
static void	displayException(java.lang.String header, java.lang.Throwable e, javafx.scene.Node owner) Displays a modal dialog box to shows details about an Exception.
static javafx.stage.Stage	getStage(javafx.scene.Node node) Returns the Stage instance to which the provided Node is attached
static void	launchUrlInExternalBrowser(java.lang.String url) Launch the system default browser to browse the provided URL
static void	notifyError(java.lang.String title, java.lang.Exception e, javafx.geometry.Pos position, javafx.scene.Node owner)
static void	notifyError(java.lang.String title, java.lang.String message, javafx.geometry.Pos position, javafx.scene.Node owner) Display an error notification
static void	notifyException(java.lang.String header, java.lang.Throwable e) Display an error notification
static void	notifyException(java.lang.String title, java.lang.Throwable e, javafx.scene.Node owner) Display an error notification
static void	notifyException(java.lang.Throwable e) Display an error notification
static void	notifyInfo(java.lang.String title, java.lang.String message, javafx.geometry.Pos position, javafx.scene.Node owner) Display an info notification
static void	notifyWarning(java.lang.String title, java.lang.String message, javafx.geometry.Pos position, javafx.scene.Node owner) Display an warning notification
static void	runOnFXThread(java.lang.Runnable r) Ensures that the provided Runnable is executed on the JavaFX application thread.
static void	setAlwaysOnTop(javafx.scene.control.Dialog dialog) Forces the provided Dialog to always appear on top of other windows.

Methods inherited from class java.lang.Object

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

Constructor Detail

Dialogs

public Dialogs()

Method Detail

notifyException

public static void notifyException(java.lang.Throwable e)

Display an error notification

Parameters:

e - the exception to display

notifyException

public static void notifyException(java.lang.String header,
                                   java.lang.Throwable e)

Display an error notification

Parameters:

header - the header text for the dialog

e - the exception to display

notifyException

public static void notifyException(java.lang.String title,
                                   java.lang.Throwable e,
                                   javafx.scene.Node owner)

Display an error notification

Parameters:

title - the title for the notification

e - the exception to notify

owner - the node to which the notification is attached

displayException

public static void displayException(java.lang.String header,
                                    java.lang.Throwable e,
                                    javafx.scene.Node owner)

Displays a modal dialog box to shows details about an Exception.

Parameters:

header - the header text for the dialog

e - the exception to display

owner - the Node used to recover the stage the dialog should be linked to

notifyError

public static void notifyError(java.lang.String title,
                               java.lang.String message,
                               javafx.geometry.Pos position,
                               javafx.scene.Node owner)

Display an error notification

Parameters:

title - the title for the notification

message - the title for the notification

position - the position for the notification

owner - the node to which the notification is attached

notifyError

public static void notifyError(java.lang.String title,
                               java.lang.Exception e,
                               javafx.geometry.Pos position,
                               javafx.scene.Node owner)

notifyWarning

public static void notifyWarning(java.lang.String title,
                                 java.lang.String message,
                                 javafx.geometry.Pos position,
                                 javafx.scene.Node owner)

Display an warning notification

Parameters:

title - the title for the notification

message - the title for the notification

owner - the node to which the notification is attached

notifyInfo

public static void notifyInfo(java.lang.String title,
                              java.lang.String message,
                              javafx.geometry.Pos position,
                              javafx.scene.Node owner)

Display an info notification

Parameters:

title - the title for the notification

message - the title for the notification

owner - the node to which the notification is attached

getStage

public static javafx.stage.Stage getStage(javafx.scene.Node node)

Returns the Stage instance to which the provided Node is attached

Parameters:

node - the node to get the stage for.

Returns:

the Stage instance to which the provided Node is attached

launchUrlInExternalBrowser

public static void launchUrlInExternalBrowser(java.lang.String url)
                                       throws java.io.IOException,
                                              java.net.URISyntaxException

Launch the system default browser to browse the provided URL

Parameters:

url - a string that represent the url to point the browser at

Throws:

java.io.IOException - if the default browser is not found or fails to be launched

java.net.URISyntaxException - if the string could not be transform into a proper URI

confirmSaveDialog

public static javafx.scene.control.ButtonType confirmSaveDialog(javafx.scene.Node node,
                                                                java.lang.String fileName)

Displays a dialog box that provides the end user with an opportunity to save the current state

Parameters:

node - the node to get the stage for

fileName - the name of the file to save

Returns:

the ButtonType for the button that was chosen by the user

confirmDialog

public static javafx.scene.control.ButtonType confirmDialog(javafx.scene.Node node,
                                                            java.lang.String header,
                                                            java.lang.String content,
                                                            javafx.scene.control.ButtonType... buttons)

Displays a confirmation dialog box.

Parameters:

node - a node attached to the stage to be used as the owner of the dialog.

header - the header message for the dialog.

content - the main message for the dialog.

buttons - the ButtonType that should be displayed on the confirmation dialog.

Returns:

the ButtonType corresponding to user's choice.

confirmDialog

public static javafx.scene.control.ButtonType confirmDialog(javafx.scene.Node node,
                                                            java.lang.String header,
                                                            java.lang.String content,
                                                            javafx.scene.Node icon,
                                                            javafx.scene.control.ButtonType... buttons)

Displays a confirmation dialog box.

Parameters:

node - a node attached to the stage to be used as the owner of the dialog.

header - the header message for the dialog.

content - the main message for the dialog.

icon - the icon for the dialog.

buttons - the ButtonType that should be displayed on the confirmation dialog.

Returns:

the ButtonType corresponding to user's choice.

runOnFXThread

public static void runOnFXThread(java.lang.Runnable r)

Ensures that the provided Runnable is executed on the JavaFX application thread.

Parameters:

r - the Runnable to execute on the JavaFX application thread

setAlwaysOnTop

public static void setAlwaysOnTop(javafx.scene.control.Dialog dialog)

Forces the provided Dialog to always appear on top of other windows.

Parameters:

dialog - the dialog to set always on top.