com.nelkinda.javax.swing

Enum JOptionPane2

java.lang.Object

java.lang.Enum<JOptionPane2>

com.nelkinda.javax.swing.JOptionPane2

All Implemented Interfaces:

Serializable, Comparable<JOptionPane2>

public enum JOptionPane2
extends Enum<JOptionPane2>

Additional dialogs.

Since:

0.0.2

Version:

0.0.2

Author:

Christian Hujer, Nelkinda Software Craft Pvt Ltd

See Also:

JOptionPane

Method Summary

Modifier and Type	Method and Description
static Optional<String>	showInputDialog(@Nullable Component parentComponent, Object message) Shows a question-message dialog requesting input from the user parented to parentComponent.
static Optional<String>	showInputDialog(@Nullable Component parentComponent, Object message, Object initialSelectionValue) Shows a question-message dialog requesting input from the user and parented to parentComponent.
static Optional<String>	showInputDialog(@Nullable Component parentComponent, Object message, String title, int messageType) Shows a dialog requesting input from the user parented to parentComponent with the dialog having the title title and message type messageType.
static <T> Optional<T>	showInputDialog(@Nullable Component parentComponent, Object message, String title, int messageType, Icon icon, T[] selectionValues, T initialSelectionValue) Prompts the user for input in a blocking dialog where the initial selection, possible selections, and all other options can be specified.
static Optional<String>	showInputDialog(Object message) Shows a question-message dialog requesting input from the user.
static Optional<String>	showInputDialog(Object message, Object initialSelectionValue) Shows a question-message dialog requesting input from the user, with the input value initialized to initialSelectionValue.
static Optional<char[]>	showPasswordDialog(@Nullable Component parentComponent, Object message) Shows a question-message dialog requesting a passphrase or password input from the user parented to parentComponent.
static Optional<char[]>	showPasswordDialog(@Nullable Component parentComponent, Object message, String title, int messageType) Shows a dialog requesting input from the user parented to parentComponent with the dialog having the title title and message type messageType.
static Optional<char[]>	showPasswordDialog(Object message) Shows a question-message dialog requesting a passphrase or password input from the user.
static JOptionPane2	valueOf(String name) Returns the enum constant of this type with the specified name.
static JOptionPane2[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static JOptionPane2[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JOptionPane2 c : JOptionPane2.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JOptionPane2 valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

showPasswordDialog

public static Optional<char[]> showPasswordDialog(Object message)

Shows a question-message dialog requesting a passphrase or password input from the user. The dialog uses the default frame, which usually means it is centered on the screen.

Parameters:

message - the Object to display

Returns:

An Optional holding the password if the dialog was confirmed, otherwise Optional.empty().

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showPasswordDialog

public static Optional<char[]> showPasswordDialog(@Nullable
                                                  @Nullable Component parentComponent,
                                                  Object message)

Shows a question-message dialog requesting a passphrase or password input from the user parented to parentComponent. The dialog is displayed on top of the Component's frame, and is usually positioned below the Component.

Parameters:

parentComponent - the parent Component for the dialog

message - the Object to display

Returns:

An Optional holding the password if the dialog was confirmed, otherwise Optional.empty().

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showPasswordDialog

public static Optional<char[]> showPasswordDialog(@Nullable
                                                  @Nullable Component parentComponent,
                                                  Object message,
                                                  String title,
                                                  int messageType)

Shows a dialog requesting input from the user parented to parentComponent with the dialog having the title title and message type messageType.

Parameters:

parentComponent - the parent Component for the dialog

message - the Object to display

title - the String to display in the dialog title bar

messageType - the type of message that is to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

Returns:

An Optional holding the password if the dialog was confirmed, otherwise Optional.empty().

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showInputDialog

public static Optional<String> showInputDialog(Object message)

Shows a question-message dialog requesting input from the user. The dialog uses the default frame, which usually means it is centered on the screen.

Parameters:

message - the Object to display

Returns:

An Optional holding the input if the dialog was confirmed, otherwise Optional.empty().

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showInputDialog

public static Optional<String> showInputDialog(Object message,
                                               Object initialSelectionValue)

Shows a question-message dialog requesting input from the user, with the input value initialized to initialSelectionValue. The dialog uses the default frame, which usually means it is centered on the screen.

Parameters:

message - the Object to display

initialSelectionValue - the value used to initialize the input field

Returns:

An Optional holding the input if the dialog was confirmed, otherwise Optional.empty().

See Also:

GraphicsEnvironment.isHeadless()

showInputDialog

public static Optional<String> showInputDialog(@Nullable
                                               @Nullable Component parentComponent,
                                               Object message)

Shows a question-message dialog requesting input from the user parented to parentComponent. The dialog is displayed on top of the Component's frame, and is usually positioned below the Component.

Parameters:

parentComponent - the parent Component for the dialog

message - the Object to display

Returns:

An Optional holding the input if the dialog was confirmed, otherwise Optional.empty().

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showInputDialog

public static Optional<String> showInputDialog(@Nullable
                                               @Nullable Component parentComponent,
                                               Object message,
                                               Object initialSelectionValue)

Shows a question-message dialog requesting input from the user and parented to parentComponent. The input value will be initialized to initialSelectionValue. The dialog is displayed on top of the Component's frame, and is usually positioned below the Component.

Parameters:

parentComponent - the parent Component for the dialog

message - the Object to display

initialSelectionValue - the value used to initialize the input field

Returns:

An Optional holding the input if the dialog was confirmed, otherwise Optional.empty().

See Also:

GraphicsEnvironment.isHeadless()

showInputDialog

public static Optional<String> showInputDialog(@Nullable
                                               @Nullable Component parentComponent,
                                               Object message,
                                               String title,
                                               int messageType)

Shows a dialog requesting input from the user parented to parentComponent with the dialog having the title title and message type messageType.

Parameters:

parentComponent - the parent Component for the dialog

message - the Object to display

title - the String to display in the dialog title bar

messageType - the type of message that is to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

Returns:

An Optional holding the input if the dialog was confirmed, otherwise Optional.empty().

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showInputDialog

public static <T> Optional<T> showInputDialog(@Nullable
                                              @Nullable Component parentComponent,
                                              Object message,
                                              String title,
                                              int messageType,
                                              Icon icon,
                                              T[] selectionValues,
                                              T initialSelectionValue)

Prompts the user for input in a blocking dialog where the initial selection, possible selections, and all other options can be specified. The user will able to choose from selectionValues, where null implies the user can input whatever they wish, usually by means of a JTextField. initialSelectionValue is the initial value to prompt the user with. It is up to the UI to decide how best to represent the selectionValues, but usually a JComboBox, JList, or JTextField will be used.

Type Parameters:

T - Type of input.

Parameters:

parentComponent - the parent Component for the dialog

message - the Object to display

title - the String to display in the dialog title bar

messageType - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

icon - the Icon image to display

selectionValues - an array of Objects that gives the possible selections

initialSelectionValue - the value used to initialize the input field

Returns:

An Optional holding the input if the dialog was confirmed, otherwise Optional.empty().

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()