animation.utility

Class GUIUtilities

java.lang.Object

animation.utility.GUIUtilities

public class GUIUtilities
extends java.lang.Object

A class for GUI Utilities.

Taken from our main project (methods have been removed).

Author:

Bruna Liborio

Constructor Summary

Constructors

Constructor and Description
GUIUtilities()

Method Summary

Modifier and Type	Method and Description
static javafx.scene.control.Button	makeButton(java.lang.String name, javafx.event.EventHandler<javafx.event.ActionEvent> handler) Makes a button with a given name and event.
static javafx.scene.control.Slider	makeSlider(javafx.beans.value.ChangeListener<java.lang.Number> listener, double start, double end, double currVal) Creates a new slider, setting all necessary intervals and locations.
static javafx.scene.control.Dialog	popUp(java.lang.String title, java.lang.String header)
static java.io.File	promptAndGetFile(javafx.stage.FileChooser.ExtensionFilter extension, java.lang.String prompt) Prompts a file chooser box for the user to choose a file with ONE extension filter
static java.io.File	promptAndGetFile(java.util.List<javafx.stage.FileChooser.ExtensionFilter> filters, java.lang.String prompt) Prompts a file chooser box for the user to choose a file with MULTIPLE extension filters
static boolean	showAlert(java.lang.String title, java.lang.String header, java.lang.String message, javafx.scene.control.Alert.AlertType type) Show an alert with a certain message and a given type.
static void	showError(java.lang.String title, java.lang.String message) Show an error with a certain message.

Methods inherited from class java.lang.Object

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

Constructor Detail

GUIUtilities

public GUIUtilities()

Method Detail

showAlert

public static boolean showAlert(java.lang.String title,
                                java.lang.String header,
                                java.lang.String message,
                                javafx.scene.control.Alert.AlertType type)

Show an alert with a certain message and a given type.

Parameters:

String - title: title of alert, could be null

String - header: header for the alert, could be null

String - message: longer message further describing the alert, could be null (though all three above shouldn't be null at the same time or the alert is useless)

AlertType - type: type of alert to display, i.e. ERROR, INFORMATION, CONFIRMATION

Returns:

boolean result.get() == ButtonType.OK: returns true is the user clicked the OK button, returns false otherwise

showError

public static void showError(java.lang.String title,
                             java.lang.String message)

Show an error with a certain message.

Parameters:

error - message

makeButton

public static javafx.scene.control.Button makeButton(java.lang.String name,
                                                     javafx.event.EventHandler<javafx.event.ActionEvent> handler)

Makes a button with a given name and event.

Parameters:

String - name: name of button

EventHandler - handler: action/method to occur when button is pressed

Returns:

Button button: the button node tied to its name and event

promptAndGetFile

public static java.io.File promptAndGetFile(javafx.stage.FileChooser.ExtensionFilter extension,
                                            java.lang.String prompt)

Prompts a file chooser box for the user to choose a file with ONE extension filter

Parameters:

ExtensionFilter - extension: file extension that the user can choose from, all others are not allowed

String - prompt: prompt for the file chooser box

Returns:

File: return file selected by the user Note: this method works with promptAndGetFile(List filters, String prompt), which allows the addition of multiple extension filters, whereas this method is called with only one extension filter is needed; pairing the methods reduces replicated code

promptAndGetFile

public static java.io.File promptAndGetFile(java.util.List<javafx.stage.FileChooser.ExtensionFilter> filters,
                                            java.lang.String prompt)

Prompts a file chooser box for the user to choose a file with MULTIPLE extension filters

Parameters:

List - filters: file extensions that the user can choose from, all others are not allowed

String - prompt: prompt for the file chooser box

Returns:

File file: return file selected by the user

makeSlider

public static javafx.scene.control.Slider makeSlider(javafx.beans.value.ChangeListener<java.lang.Number> listener,
                                                     double start,
                                                     double end,
                                                     double currVal)

Creates a new slider, setting all necessary intervals and locations.

Parameters:

ChangeListener - the changeImage the slider is listening to and event/method it calls when the changeImage occurs

start - the start of the slider range

end - the end of the slider range

incr - the increment of the slider range

Returns:

slider the new slider

popUp

public static javafx.scene.control.Dialog popUp(java.lang.String title,
                                                java.lang.String header)