view

Class Utilities

java.lang.Object

view.Utilities

public class Utilities
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Utilities()

Method Summary

Modifier and Type	Method and Description
java.lang.String	choiceBox(java.util.List<java.lang.String> choices, java.lang.String title, java.lang.String header, java.lang.String content) Shows a choice box where the user can pick among preset options.
static javafx.scene.control.ButtonType	confirmationBox(java.lang.String title, java.lang.String header, java.lang.String message)
static IEntity	copyEntity(IEntity entity) Creates an IEntity copy of the given IEntity with the same specs, components, and component values.
static javafx.scene.control.ContextMenu	createContextMenu(java.util.Map<java.lang.String,javafx.event.EventHandler<javafx.event.ActionEvent>> menuMap)
static java.util.List<java.lang.String>	getAllFromDirectory(java.lang.String directoryLocation) Gets all file names from a given directory.
static java.util.List<javafx.stage.FileChooser.ExtensionFilter>	getImageFilters()
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.ComboBox<java.lang.String>	makeComboBox(java.lang.String prompt, java.util.List<java.lang.String> choices, javafx.event.EventHandler<javafx.event.ActionEvent> event) Creates and returns a string combo box with the following features:
static javafx.scene.control.TableView<java.lang.String>	makeSingleColumnTable(java.lang.String title, double width)
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.TextField	makeTextArea(java.lang.String prompt) Creates and returns a text area with the following features:
static javafx.scene.control.TitledPane	makeTitledPane(java.lang.String title, javafx.scene.Node content, boolean collapsable) Creates a Titled Pane, with all content already inside.
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.
static java.lang.String	userInputBox(java.lang.String title, java.lang.String prompt) Shows a text input dialog where user can enter in text of their choosing.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utilities

public Utilities()

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

makeSingleColumnTable

public static javafx.scene.control.TableView<java.lang.String> makeSingleColumnTable(java.lang.String title,
                                                                                     double width)

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

makeComboBox

public static javafx.scene.control.ComboBox<java.lang.String> makeComboBox(java.lang.String prompt,
                                                                           java.util.List<java.lang.String> choices,
                                                                           javafx.event.EventHandler<javafx.event.ActionEvent> event)

Creates and returns a string combo box with the following features:

Parameters:

String - prompt the name of the combo box

List - choices choices in the combo box

EventHandler - event event/method to occur when the combo box is selected

Returns:

ComboBox comboBox the combo box with the above features.

makeTextArea

public static javafx.scene.control.TextField makeTextArea(java.lang.String prompt)

Creates and returns a text area with the following features:

Parameters:

String - prompt writing in text area

Returns:

TextArea field the new text area with above features

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

userInputBox

public static java.lang.String userInputBox(java.lang.String title,
                                            java.lang.String prompt)

Shows a text input dialog where user can enter in text of their choosing. User response is returned, i.e. the entered text

Parameters:

String - title: title for input dialog

Sting - prompt: detailed message to the user about the input box

Returns:

String result: user response if there is one, null if there isn't

choiceBox

public java.lang.String choiceBox(java.util.List<java.lang.String> choices,
                                  java.lang.String title,
                                  java.lang.String header,
                                  java.lang.String content)

Shows a choice box where the user can pick among preset options. User response/choice is returned as a string.

Parameters:

List - choices: choices given to the user in the dialogue

String - title: title of dialogue, could be null

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

String - content: longer message further describing the dialogue, could be null (all three shouldn't be null at once or dialogue is useless)

Returns:

String result: user choice as a string from the given choice options

makeTitledPane

public static javafx.scene.control.TitledPane makeTitledPane(java.lang.String title,
                                                             javafx.scene.Node content,
                                                             boolean collapsable)

Creates a Titled Pane, with all content already inside.

Parameters:

String - title: Title that will appear on the top of the Pane

Node - content: Content to be added. It can be a Group or a VBox or HBox.

boolean - collapsable: If it's collapsable, the pane will not be expanded. If it isn't, it will.

Returns:

TitledPane pane, already initialized.

confirmationBox

public static javafx.scene.control.ButtonType confirmationBox(java.lang.String title,
                                                              java.lang.String header,
                                                              java.lang.String message)

getAllFromDirectory

public static java.util.List<java.lang.String> getAllFromDirectory(java.lang.String directoryLocation)

Gets all file names from a given directory. Is static so that it can be accessed as the actual class is never instantiated, also so that function can be accessed without this object being passed.

Parameters:

directoryLocation - String path to a file directory

Returns:

List of Strings of all file names within given directory

copyEntity

public static IEntity copyEntity(IEntity entity)

Creates an IEntity copy of the given IEntity with the same specs, components, and component values.

Parameters:

IEntity - entity: given IEntity to copy

Returns:

IEntity newEntity: returned copy of the given IEntity

getImageFilters

public static java.util.List<javafx.stage.FileChooser.ExtensionFilter> getImageFilters()

createContextMenu

public static javafx.scene.control.ContextMenu createContextMenu(java.util.Map<java.lang.String,javafx.event.EventHandler<javafx.event.ActionEvent>> menuMap)

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