org.fuin.utils4swing.threadsafe
Class ThreadSafeJOptionPane

java.lang.Object
  org.fuin.utils4swing.threadsafe.ThreadSafeJOptionPane

public final class ThreadSafeJOptionPane
extends java.lang.Object

1:1 version of JOptionPane for usage outside the EDT. You can use this class if you want to display an option pane in any other thread without violating the "Single Thread Rule".

Method Summary

static int	showConfirmDialog(java.awt.Component parentComponent, java.lang.Object message) Brings up a dialog with the options Yes, No and Cancel; with the title, Select an Option.
static int	showConfirmDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType) Brings up a dialog where the number of choices is determined by the optionType parameter.
static int	showConfirmDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType, int messageType) Brings up a dialog where the number of choices is determined by the optionType parameter, where the messageType parameter determines the icon to display.
static int	showConfirmDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType, int messageType, javax.swing.Icon icon) Brings up a dialog with a specified icon, where the number of choices is determined by the optionType parameter.
static java.lang.String	showInputDialog(java.awt.Component parentComponent, java.lang.Object message) Shows a question-message dialog requesting input from the user parented to parentComponent.
static java.lang.String	showInputDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.Object initialSelectionValue) Shows a question-message dialog requesting input from the user and parented to parentComponent.
static java.lang.String	showInputDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.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 java.lang.Object	showInputDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int messageType, javax.swing.Icon icon, java.lang.Object[] selectionValues, java.lang.Object initialSelectionValue) Prompts the user for input in a blocking dialog where the initial selection, possible selections, and all other options can be specified.
static java.lang.String	showInputDialog(java.lang.Object message) Shows a question-message dialog requesting input from the user.
static java.lang.String	showInputDialog(java.lang.Object message, java.lang.Object initialSelectionValue) Shows a question-message dialog requesting input from the user, with the input value initialized to initialSelectionValue.
static int	showInternalConfirmDialog(java.awt.Component parentComponent, java.lang.Object message) Brings up an internal dialog panel with the options Yes, No and Cancel; with the title, Select an Option.
static int	showInternalConfirmDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType) Brings up a internal dialog panel where the number of choices is determined by the optionType parameter.
static int	showInternalConfirmDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType, int messageType) Brings up an internal dialog panel where the number of choices is determined by the optionType parameter, where the messageType parameter determines the icon to display.
static int	showInternalConfirmDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType, int messageType, javax.swing.Icon icon) Brings up an internal dialog panel with a specified icon, where the number of choices is determined by the optionType parameter.
static java.lang.String	showInternalInputDialog(java.awt.Component parentComponent, java.lang.Object message) Shows an internal question-message dialog requesting input from the user parented to parentComponent.
static java.lang.String	showInternalInputDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int messageType) Shows an internal dialog requesting input from the user parented to parentComponent with the dialog having the title title and message type messageType.
static java.lang.Object	showInternalInputDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int messageType, javax.swing.Icon icon, java.lang.Object[] selectionValues, java.lang.Object initialSelectionValue) Prompts the user for input in a blocking internal dialog where the initial selection, possible selections, and all other options can be specified.
static void	showInternalMessageDialog(java.awt.Component parentComponent, java.lang.Object message) Brings up an internal confirmation dialog panel.
static void	showInternalMessageDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int messageType) Brings up an internal dialog panel that displays a message using a default icon determined by the messageType parameter.
static void	showInternalMessageDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int messageType, javax.swing.Icon icon) Brings up an internal dialog panel displaying a message, specifying all parameters.
static int	showInternalOptionDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType, int messageType, javax.swing.Icon icon, java.lang.Object[] options, java.lang.Object initialValue) Brings up an internal dialog panel with a specified icon, where the initial choice is determined by the initialValue parameter and the number of choices is determined by the optionType parameter.
static void	showMessageDialog(java.awt.Component parentComponent, java.lang.Object message) Brings up an information-message dialog titled "Message".
static void	showMessageDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int messageType) Brings up a dialog that displays a message using a default icon determined by the messageType parameter.
static void	showMessageDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int messageType, javax.swing.Icon icon) Brings up a dialog displaying a message, specifying all parameters.
static int	showOptionDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType, int messageType, javax.swing.Icon icon, java.lang.Object[] options, java.lang.Object initialValue) Brings up a dialog with a specified icon, where the initial choice is determined by the initialValue parameter and the number of choices is determined by the optionType parameter.

Methods inherited from class java.lang.Object

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

Method Detail

showConfirmDialog

public static int showConfirmDialog(java.awt.Component parentComponent,
                                    java.lang.Object message)

Brings up a dialog with the options Yes, No and Cancel; with the title, Select an Option.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the Object to display

Returns:

an integer indicating the option selected by the user

showConfirmDialog

public static int showConfirmDialog(java.awt.Component parentComponent,
                                    java.lang.Object message,
                                    java.lang.String title,
                                    int optionType)

Brings up a dialog where the number of choices is determined by the optionType parameter.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the Object to display

title - the title string for the dialog

optionType - an int designating the options available on the dialog: YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION

Returns:

an int indicating the option selected by the user

showConfirmDialog

public static int showConfirmDialog(java.awt.Component parentComponent,
                                    java.lang.Object message,
                                    java.lang.String title,
                                    int optionType,
                                    int messageType)

Brings up a dialog where the number of choices is determined by the optionType parameter, where the messageType parameter determines the icon to display. The messageType parameter is primarily used to supply a default icon from the Look and Feel.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used.

message - the Object to display

title - the title string for the dialog

optionType - an integer designating the options available on the dialog: YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION

messageType - an integer designating the kind of message this is; primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

Returns:

an integer indicating the option selected by the user

showConfirmDialog

public static int showConfirmDialog(java.awt.Component parentComponent,
                                    java.lang.Object message,
                                    java.lang.String title,
                                    int optionType,
                                    int messageType,
                                    javax.swing.Icon icon)

Brings up a dialog with a specified icon, where the number of choices is determined by the optionType parameter. The messageType parameter is primarily used to supply a default icon from the look and feel.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the Object to display

title - the title string for the dialog

optionType - an int designating the options available on the dialog: YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION

messageType - an int designating the kind of message this is, primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

icon - the icon to display in the dialog

Returns:

an int indicating the option selected by the user

showInputDialog

public static java.lang.String showInputDialog(java.awt.Component parentComponent,
                                               java.lang.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:

user's input, or null meaning the user canceled the input

showInputDialog

public static java.lang.String showInputDialog(java.awt.Component parentComponent,
                                               java.lang.Object message,
                                               java.lang.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:

user's input, or null meaning the user canceled the input

showInputDialog

public static java.lang.String showInputDialog(java.awt.Component parentComponent,
                                               java.lang.Object message,
                                               java.lang.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:

user's input, or null meaning the user canceled the input

showInputDialog

public static java.lang.Object showInputDialog(java.awt.Component parentComponent,
                                               java.lang.Object message,
                                               java.lang.String title,
                                               int messageType,
                                               javax.swing.Icon icon,
                                               java.lang.Object[] selectionValues,
                                               java.lang.Object 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.

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:

user's input, or null meaning the user canceled the input

showInputDialog

public static java.lang.String showInputDialog(java.lang.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:

user's input, or null meaning the user canceled the input

showInputDialog

public static java.lang.String showInputDialog(java.lang.Object message,
                                               java.lang.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:

user's input, or null meaning the user canceled the input

showInternalConfirmDialog

public static int showInternalConfirmDialog(java.awt.Component parentComponent,
                                            java.lang.Object message)

Brings up an internal dialog panel with the options Yes, No and Cancel; with the title, Select an Option.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the Object to display

Returns:

an integer indicating the option selected by the user

showInternalConfirmDialog

public static int showInternalConfirmDialog(java.awt.Component parentComponent,
                                            java.lang.Object message,
                                            java.lang.String title,
                                            int optionType)

Brings up a internal dialog panel where the number of choices is determined by the optionType parameter.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the object to display in the dialog; a Component object is rendered as a Component; a String object is rendered as a string; other objects are converted to a String using the toString method

title - the title string for the dialog

optionType - an integer designating the options available on the dialog: YES_NO_OPTION, or YES_NO_CANCEL_OPTION

Returns:

an integer indicating the option selected by the user

showInternalConfirmDialog

public static int showInternalConfirmDialog(java.awt.Component parentComponent,
                                            java.lang.Object message,
                                            java.lang.String title,
                                            int optionType,
                                            int messageType)

Brings up an internal dialog panel where the number of choices is determined by the optionType parameter, where the messageType parameter determines the icon to display. The messageType parameter is primarily used to supply a default icon from the Look and Feel.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the object to display in the dialog; a Component object is rendered as a Component; a String object is rendered as a string; other objects are converted to a String using the toString method

title - the title string for the dialog

optionType - an integer designating the options available on the dialog: YES_NO_OPTION, or YES_NO_CANCEL_OPTION

messageType - an integer designating the kind of message this is, primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

Returns:

an integer indicating the option selected by the user

showInternalConfirmDialog

public static int showInternalConfirmDialog(java.awt.Component parentComponent,
                                            java.lang.Object message,
                                            java.lang.String title,
                                            int optionType,
                                            int messageType,
                                            javax.swing.Icon icon)

Brings up an internal dialog panel with a specified icon, where the number of choices is determined by the optionType parameter. The messageType parameter is primarily used to supply a default icon from the look and feel.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the object to display in the dialog; a Component object is rendered as a Component; a String object is rendered as a string; other objects are converted to a String using the toString method

title - the title string for the dialog

optionType - an integer designating the options available on the dialog: YES_NO_OPTION, or YES_NO_CANCEL_OPTION.

messageType - an integer designating the kind of message this is, primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

icon - the icon to display in the dialog

Returns:

an integer indicating the option selected by the user

showInternalInputDialog

public static java.lang.String showInternalInputDialog(java.awt.Component parentComponent,
                                                       java.lang.Object message)

Shows an internal question-message dialog requesting input from the user parented to parentComponent. The dialog is displayed in 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:

user's input, or null meaning the user canceled the input

showInternalInputDialog

public static java.lang.String showInternalInputDialog(java.awt.Component parentComponent,
                                                       java.lang.Object message,
                                                       java.lang.String title,
                                                       int messageType)

Shows an internal 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:

user's input, or null meaning the user canceled the input

showInternalInputDialog

public static java.lang.Object showInternalInputDialog(java.awt.Component parentComponent,
                                                       java.lang.Object message,
                                                       java.lang.String title,
                                                       int messageType,
                                                       javax.swing.Icon icon,
                                                       java.lang.Object[] selectionValues,
                                                       java.lang.Object initialSelectionValue)

Prompts the user for input in a blocking internal 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.

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:

user's input, or null meaning the user canceled the input

showInternalMessageDialog

public static void showInternalMessageDialog(java.awt.Component parentComponent,
                                             java.lang.Object message)

Brings up an internal confirmation dialog panel. The dialog is a information-message dialog titled "Message".

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the object to display

showInternalMessageDialog

public static void showInternalMessageDialog(java.awt.Component parentComponent,
                                             java.lang.Object message,
                                             java.lang.String title,
                                             int messageType)

Brings up an internal dialog panel that displays a message using a default icon determined by the messageType parameter.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the Object to display

title - the title string for the dialog

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

showInternalMessageDialog

public static void showInternalMessageDialog(java.awt.Component parentComponent,
                                             java.lang.Object message,
                                             java.lang.String title,
                                             int messageType,
                                             javax.swing.Icon icon)

Brings up an internal dialog panel displaying a message, specifying all parameters.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the Object to display

title - the title string for the dialog

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

icon - an icon to display in the dialog that helps the user identify the kind of message that is being displayed

showInternalOptionDialog

public static int showInternalOptionDialog(java.awt.Component parentComponent,
                                           java.lang.Object message,
                                           java.lang.String title,
                                           int optionType,
                                           int messageType,
                                           javax.swing.Icon icon,
                                           java.lang.Object[] options,
                                           java.lang.Object initialValue)

Brings up an internal dialog panel with a specified icon, where the initial choice is determined by the initialValue parameter and the number of choices is determined by the optionType parameter.

If optionType is YES_NO_OPTION, or YES_NO_CANCEL_OPTION and the options parameter is null, then the options are supplied by the Look and Feel.

The messageType parameter is primarily used to supply a default icon from the look and feel.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the object to display in the dialog; a Component object is rendered as a Component; a String object is rendered as a string. Other objects are converted to a String using the toString method

title - the title string for the dialog

optionType - an integer designating the options available on the dialog: YES_NO_OPTION, or YES_NO_CANCEL_OPTION

messageType - an integer designating the kind of message this is; primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

icon - the icon to display in the dialog

options - an array of objects indicating the possible choices the user can make; if the objects are components, they are rendered properly; non-String objects are rendered using their toString methods; if this parameter is null, the options are determined by the Look and Feel

initialValue - the object that represents the default selection for the dialog; only meaningful if options is used; can be null

Returns:

an integer indicating the option chosen by the user, or CLOSED_OPTION if the user closed the Dialog

showMessageDialog

public static void showMessageDialog(java.awt.Component parentComponent,
                                     java.lang.Object message)

Brings up an information-message dialog titled "Message".

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the Object to display

showMessageDialog

public static void showMessageDialog(java.awt.Component parentComponent,
                                     java.lang.Object message,
                                     java.lang.String title,
                                     int messageType)

Brings up a dialog that displays a message using a default icon determined by the messageType parameter.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the Object to display

title - the title string for the dialog

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

showMessageDialog

public static void showMessageDialog(java.awt.Component parentComponent,
                                     java.lang.Object message,
                                     java.lang.String title,
                                     int messageType,
                                     javax.swing.Icon icon)

Brings up a dialog displaying a message, specifying all parameters.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the Object to display

title - the title string for the dialog

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

icon - an icon to display in the dialog that helps the user identify the kind of message that is being displayed

showOptionDialog

public static int showOptionDialog(java.awt.Component parentComponent,
                                   java.lang.Object message,
                                   java.lang.String title,
                                   int optionType,
                                   int messageType,
                                   javax.swing.Icon icon,
                                   java.lang.Object[] options,
                                   java.lang.Object initialValue)

Brings up a dialog with a specified icon, where the initial choice is determined by the initialValue parameter and the number of choices is determined by the optionType parameter.

If optionType is YES_NO_OPTION, or YES_NO_CANCEL_OPTION and the options parameter is null, then the options are supplied by the look and feel.

The messageType parameter is primarily used to supply a default icon from the look and feel.

Parameters:

parentComponent - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used

message - the Object to display

title - the title string for the dialog

optionType - an integer designating the options available on the dialog: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION

messageType - an integer designating the kind of message this is, primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

icon - the icon to display in the dialog

options - an array of objects indicating the possible choices the user can make; if the objects are components, they are rendered properly; non-String objects are rendered using their toString methods; if this parameter is null, the options are determined by the Look and Feel

initialValue - the object that represents the default selection for the dialog; only meaningful if options is used; can be null

Returns:

an integer indicating the option chosen by the user, or CLOSED_OPTION if the user closed the dialog