Package net.emustudio.emulib.runtime.interaction

Interface Dialogs

public interface Dialogs

This class provides dialogs used by emuStudio and plugins.

If GUI is enabled, the dialogs are shown on the screen. Otherwise, they are logged.

Example of usage: dialogs.showMessage("Hello, world!");

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Dialogs.DialogAnswer

Method Summary

Modifier and Type	Method	Description
Dialogs.DialogAnswer	ask(java.lang.String message)	Ask user for a confirmation.
Dialogs.DialogAnswer	ask(java.lang.String message, java.lang.String title)	Ask user for a confirmation.
java.util.Optional<java.nio.file.Path>	chooseFile(java.lang.String title, java.lang.String approveButtonText, boolean appendMissingExtension, java.util.List<FileExtensionsFilter> filters)	Ask user to choose a file.
java.util.Optional<java.nio.file.Path>	chooseFile(java.lang.String title, java.lang.String approveButtonText, boolean appendMissingExtension, FileExtensionsFilter... filters)	Ask user to choose a file.
java.util.Optional<java.nio.file.Path>	chooseFile(java.lang.String title, java.lang.String approveButtonText, java.nio.file.Path baseDirectory, boolean appendMissingExtension, java.util.List<FileExtensionsFilter> filters)	Ask user to choose a file.
java.util.Optional<java.nio.file.Path>	chooseFile(java.lang.String title, java.lang.String approveButtonText, java.nio.file.Path baseDirectory, boolean appendMissingExtension, FileExtensionsFilter... filters)	Ask user to choose a file.
java.util.Optional<java.lang.Double>	readDouble(java.lang.String message)	Ask user for Double input.
java.util.Optional<java.lang.Double>	readDouble(java.lang.String message, java.lang.String title)	Ask user for Double input.
java.util.Optional<java.lang.Double>	readDouble(java.lang.String message, java.lang.String title, double initial)	Ask user for Double input.
java.util.Optional<java.lang.Integer>	readInteger(java.lang.String message)	Ask user for integer input.
java.util.Optional<java.lang.Integer>	readInteger(java.lang.String message, java.lang.String title)	Ask user for integer input.
java.util.Optional<java.lang.Integer>	readInteger(java.lang.String message, java.lang.String title, int initial)	Ask user for integer input.
java.util.Optional<java.lang.String>	readString(java.lang.String message)	Ask user for String input.
java.util.Optional<java.lang.String>	readString(java.lang.String message, java.lang.String title)	Ask user for String input.
java.util.Optional<java.lang.String>	readString(java.lang.String message, java.lang.String title, java.lang.String initial)	Ask user for String input.
void	showError(java.lang.String message)	Show error message.
void	showError(java.lang.String message, java.lang.String title)	Show error message.
void	showInfo(java.lang.String message)	Show information message.
void	showInfo(java.lang.String message, java.lang.String title)	Show information message.

Method Detail

showError

void showError(java.lang.String message)

Show error message.

Parameters:

message - error message to show

showError

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

Show error message.

Parameters:

message - error message to show

title - title of the message

showInfo

void showInfo(java.lang.String message)

Show information message.

Parameters:

message - information message to show

showInfo

void showInfo(java.lang.String message,
              java.lang.String title)

Show information message.

Parameters:

message - information message to show

title - title of the message

readInteger

java.util.Optional<java.lang.Integer> readInteger(java.lang.String message)

Ask user for integer input.

The supported format is the same as when calling Integer.decode(String).

Parameters:

message - message to show

Returns:

integer number entered by user, or Optional.empty() if user cancelled the input dialog

Throws:

java.lang.NumberFormatException - if the number format is wrong

readInteger

java.util.Optional<java.lang.Integer> readInteger(java.lang.String message,
                                                  java.lang.String title)

Ask user for integer input.

The supported format is the same as when calling Integer.decode(String).

Parameters:

message - message to show

title - title of the input message

Returns:

integer number entered by user, or Optional.empty() if user cancelled the input dialog

Throws:

java.lang.NumberFormatException - if the number format is wrong

readInteger

java.util.Optional<java.lang.Integer> readInteger(java.lang.String message,
                                                  java.lang.String title,
                                                  int initial)

Ask user for integer input.

The supported format is the same as when calling Integer.decode(String).

Parameters:

message - message to show

title - title of the input message

initial - initial value

Returns:

integer number entered by user, or the initial value by default

Throws:

java.lang.NumberFormatException - if the number format is wrong

readString

java.util.Optional<java.lang.String> readString(java.lang.String message)

Ask user for String input.

Parameters:

message - message to show

Returns:

a String entered by user, or Optional.empty() if user cancelled the input dialog

readString

java.util.Optional<java.lang.String> readString(java.lang.String message,
                                                java.lang.String title)

Ask user for String input.

Parameters:

message - message to show

title - title of the input message

Returns:

a String entered by user, or Optional.empty() if user cancelled the input dialog

readString

java.util.Optional<java.lang.String> readString(java.lang.String message,
                                                java.lang.String title,
                                                java.lang.String initial)

Ask user for String input.

Parameters:

message - message to show

title - title of the input message

initial - initial value

Returns:

a String entered by user, or the initial value by default

readDouble

java.util.Optional<java.lang.Double> readDouble(java.lang.String message)

Ask user for Double input.

The supported format is the same as when calling Double.parseDouble(String).

Parameters:

message - message to show

Returns:

double number entered by user, or Optional.empty() if user cancelled the input dialog

Throws:

java.lang.NumberFormatException - if the number format is wrong

readDouble

java.util.Optional<java.lang.Double> readDouble(java.lang.String message,
                                                java.lang.String title)

Ask user for Double input.

The supported format is the same as when calling Double.parseDouble(String).

Parameters:

message - message to show

title - title of the input message

Returns:

double number entered by user, or Optional.empty() if user cancelled the input dialog

Throws:

java.lang.NumberFormatException - if the number format is wrong

readDouble

java.util.Optional<java.lang.Double> readDouble(java.lang.String message,
                                                java.lang.String title,
                                                double initial)

Ask user for Double input.

The supported format is the same as when calling Double.parseDouble(String).

Parameters:

message - message to show

title - title of the input message

initial - initial value

Returns:

double number entered by user, or the initial value by default

Throws:

java.lang.NumberFormatException - if the number format is wrong

ask

Dialogs.DialogAnswer ask(java.lang.String message)

Ask user for a confirmation.

User can choose between of YES/NO/CANCEL option.

Parameters:

message - message to show

Returns:

Dialogs.DialogAnswer.ANSWER_YES or Dialogs.DialogAnswer.ANSWER_NO or Dialogs.DialogAnswer.ANSWER_CANCEL

ask

Dialogs.DialogAnswer ask(java.lang.String message,
                         java.lang.String title)

Ask user for a confirmation.

User can choose between of YES/NO/CANCEL option.

Parameters:

message - message to show

title - title of the message

Returns:

Dialogs.DialogAnswer.ANSWER_YES or Dialogs.DialogAnswer.ANSWER_NO or Dialogs.DialogAnswer.ANSWER_CANCEL

chooseFile

java.util.Optional<java.nio.file.Path> chooseFile(java.lang.String title,
                                                  java.lang.String approveButtonText,
                                                  boolean appendMissingExtension,
                                                  FileExtensionsFilter... filters)

Ask user to choose a file.

Base directory of the dialog will be set to System.getProperty("user.dir").

Parameters:

title - dialog title

approveButtonText - approve button text (e.g. "Open", "Save", ...)

appendMissingExtension - Whether extension from selected filter should be appended to selected file if it has no extension

filters - supported file filters

Returns:

Selected file if provided, or Optional.empty() if user cancelled the dialog

chooseFile

java.util.Optional<java.nio.file.Path> chooseFile(java.lang.String title,
                                                  java.lang.String approveButtonText,
                                                  boolean appendMissingExtension,
                                                  java.util.List<FileExtensionsFilter> filters)

Ask user to choose a file.

Base directory of the dialog will be set to System.getProperty("user.dir").

Parameters:

title - dialog title

approveButtonText - approve button text (e.g. "Open", "Save", ...)

appendMissingExtension - Whether extension from selected filter should be appended to selected file if it has no extension

filters - supported file filters

Returns:

Selected file if provided, or Optional.empty() if user cancelled the dialog

chooseFile

java.util.Optional<java.nio.file.Path> chooseFile(java.lang.String title,
                                                  java.lang.String approveButtonText,
                                                  java.nio.file.Path baseDirectory,
                                                  boolean appendMissingExtension,
                                                  FileExtensionsFilter... filters)

Ask user to choose a file.

Parameters:

title - dialog title

approveButtonText - approve button text (e.g. "Open", "Save", ...)

baseDirectory - Base directory of the dialog (where will the dialog point to)

appendMissingExtension - Whether extension from selected filter should be appended to selected file if it has no extension

filters - supported file filters

Returns:

Selected file if provided, or Optional.empty() if user cancelled the dialog

chooseFile

java.util.Optional<java.nio.file.Path> chooseFile(java.lang.String title,
                                                  java.lang.String approveButtonText,
                                                  java.nio.file.Path baseDirectory,
                                                  boolean appendMissingExtension,
                                                  java.util.List<FileExtensionsFilter> filters)

Ask user to choose a file.

Parameters:

title - dialog title

approveButtonText - approve button text (e.g. "Open", "Save", ...)

baseDirectory - Base directory of the dialog (where will the dialog point to)

appendMissingExtension - Whether extension from selected filter should be appended to selected file if it has no extension

filters - supported file filters

Returns:

Selected file if provided, or Optional.empty() if user cancelled the dialog