All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.JOptionPane

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.sun.java.swing.JOptionPane

public class JOptionPane

extends JComponent

JOptionPane provides numerous class methods for showing simple message, option type panels and even input panels. To show a message dialog refer to the class methods showMessageDialog or showInternalMessageDialog. To show a dialog with yes/no or yes/no/cancel choices refer to the class methods showConfirmDialog or showInternalConfirmDialog. To bring up a dialog with custom options refer to the class methods showOptionDialog or showInternalOptionDialog. To bring up an input panel refer to showInputDialog or showInternalInputDialog. (The showInternal... versions of the message are used when constructing applications with their own desktops, using InternalFrames.)

When the selection is changed setValue will be messaged, which will generate a PropertyChangeEvent.

If a JOptionPane has configured to all input setWantsInput the bound property JOptionPane.INPUT_VALUE_PROPERTY can also be listened to, to determine when the user has input or selected a value.

Use the class methods showConfirmDialog or showInternalConfirmDialog to bring up a modal dialog returning the selected value. (A modal dialog disables the rest of the application until the user makes a choice.)

Examples:

Show an error dialog with the message alert.

JOptionPane.showMessageDialog(null, "alert", "alert", ERROR_MESSAGE);

JOptionPane.showInternalMessageDialog(frame, INFORMATION_MESSAGE, "information", "information");

JOptionPane.showConfirmDialog(null, "choose one", "choose one", YES_NO);

JOptionPane.showInternalConfirmDialog(frame, "please choose one", "information", YES_NO_CANCEL, INFORMATION_MESSAGE);

 Object[]         options = { "OK", "CANCEL" };
 JOptionPane.showOptionDialog(null, "Click OK to continue", "Warning",
   DEFAULT_OPTION, WARNING_MESSAGE, null, options, options[0]);
 

Show a dialog asking the user for input

 String inputValue = JOptionPane.showInputDialog("Please input a value");
 

Show a dialog asking for a selection

 Object[] possibleValues = { "First", "Second", "Third" };
 Object selectedValue = JOptionDialog.showInputDialog(null, "Choose one", "Input", JOptionPane.INFORMATION_DIALOG, null, possibleValues, possibleValues[0]);
 

CANCEL_OPTION

Return value from class method if CANCEL is chosen.

CLOSED_OPTION

Return value from class method if user closes window without selecting anything, more than likely this should be treated as either a CANCEL_OPTION or NO_OPTION.

DEFAULT_OPTION

Type meaning look and feel should not supply any options, and only use the options from the JOptionPane.

ERROR_MESSAGE

Used for error messages.

icon

Icon used in pane.

ICON_PROPERTY

Bound property name for icon.

INFORMATION_MESSAGE

Used for information messages.

INITIAL_SELECTION_VALUE_PROPERTY

Bound property name for initialSelectionValue.

INITIAL_VALUE_PROPERTY

Bounds property name for initialValue.

initialSelectionValue

Initial value to select in selectionValues.

initialValue

Value that should be initialy selected in options.

INPUT_VALUE_PROPERTY

Bound property name for inputValue.

inputValue

Value the user has input.

message

Message to display.

MESSAGE_PROPERTY

Bound property name for message.

MESSAGE_TYPE_PROPERTY

Bounds property name for type.

messageType

Message type.

NO_OPTION

Return value from class method if NO is chosen.

OK_CANCEL_OPTION

Type used for showConfirmDialog.

OK_OPTION

Return value form class method if OK is chosen.

OPTION_TYPE_PROPERTY

Bound property name for optionType.

options

Options to display to the user.

OPTIONS_PROPERTY

Bounds property namer for option.

optionType

Option type, one of DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION.

PLAIN_MESSAGE

No icon is used.

QUESTION_MESSAGE

Used for questions.

SELECTION_VALUES_PROPERTY

Bound property name for selectionValues.

selectionValues

Array of values the user can choose from.

sharedFrame

Frame used for static methods in creating a frame.

UNITIALIZED_VALUE

Potential value for value, means that the user has not selected a value yet.

value

Currently selected value, will be a valid option, or UNITIALIZED_VALUE or null.

VALUE_PROPERTY

Bounds property name for value.

WANTS_INPUT_PROPERTY

Bound property name for wantsInput.

wantsInput

If true, a UI widget will be provided to the user to get input.

WARNING_MESSAGE

Used for warning messages.

YES_NO_CANCEL_OPTION

Type used for showConfirmDialog.

YES_NO_OPTION

Type used for showConfirmDialog.

YES_OPTION

Return value from class method if YES is chosen.

JOptionPane()

Creates a JOptionPane with a test message.

JOptionPane(Object)

Creates an instance of JOptionPane to display the message message.

JOptionPane(Object, int)

Creates an instance of JOptionPane to display the message message with the message type messageType.

JOptionPane(Object, int, int)

Creates an instance of JOptionPane to display the message message, with the message type messageType and options type optionType.

JOptionPane(Object, int, int, Icon)

Creates an instance of JOptionPane to display the message message, with the message type messageType option type optionType, and Icon icon.

JOptionPane(Object, int, int, Icon, Object[])

Creates an instance of JOptionPane to display the message message, with the message type messageType option type optionType, Icon icon and options options.

JOptionPane(Object, int, int, Icon, Object[], Object)

Creates an instance of JOptionPane to display the message message, with the message type messageType option type optionType, Icon icon and options options and the first value to select initialValue.

createDialog(Component, String, JOptionPane)

Creates and returns a new JDialog rooted in frame centered around c.

createInternalFrame(Component, String, JOptionPane)

Creates and returns an instance of JInternalFrame.

getDesktopPaneForComponent(Component)

Will return the parent of c that is an instance of JDesktopPane, or null if c does not have an ancestor that is a JInternalFrame.

getFrameForComponent(Component)

Returns the parent Frame of component.

getIcon()

Returns the icon the receiver is displaying.

getInitialSelectionValue()

Returns the value to initialy select in getSelectionValues.

getInitialValue()

Returns the initial value.

getInputValue()

Returns the value the user has input, if getWantsInput return true.

getMessage()

Returns the message the receiver is representing.

getMessageType()

Returns the message type.

getOptions()

Returns the options, or choices the user can click on.

getOptionType()

Returns an integer indicating the type of options that are to be displayed.

getRootFrame()

Returns the Frame to use for the class methods in which a frame is not provided.

getSelectionValues()

Returns the selection values.

getUI()

Returns the OptionPaneUI that is providing the current look and feel.

getUIClassID()

getValue()

Returns the value the user has selected.

getWantsInput()

Returns true if a component will be provided for the user to input.

selectInitialValue()

Requests that the initial value be selected.

setIcon(Icon)

Sets the icon to display.

setInitialSelectionValue(Object)

Sets the value to select in getSelectionValues to newValue.

setInitialValue(Object)

Sets the initial value that is to be enabled to newInitialValue.

setInputValue(Object)

Sets the value the user has input to newValue.

setMessage(Object)

Sets the message to newMessage.

setMessageType(int)

Sets the message type of the receiver to newType.

setOptions(Object[])

Sets the options the user is to display.

setOptionType(int)

Sets the type of option to newType.

setRootFrame(Frame)

Sets the frame to use for class methods in which a frame is not provided.

setSelectionValues(Object[])

Sets the selection values to newValues.

setUI(OptionPaneUI)

Sets the OptionPaneUI to ui that will provide the current look and feel.

setValue(Object)

Sets the value the user has chosen.

setWantsInput(boolean)

If newValue is true, a component will be provided to allow the user to input a value.

showConfirmDialog(Component, Object)

Brings up a modal dialog with the options yes, no and cancel, and the title, "Select an Option".

showConfirmDialog(Component, Object, String, int)

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

showConfirmDialog(Component, Object, String, int, int)

Brings up a modal dialog where the number of choices is determined by the optionType parameter, where the messageType parameter determines the icon to display.

showConfirmDialog(Component, Object, String, int, int, Icon)

Brings up a modal dialog with a specified icon, where the number of choices is determined by the optionType parameter.

showInputDialog(Component, Object)

Shows an input dialog requesting the user for input parented to component

showInputDialog(Component, Object, String, int)

Shows an input dialog requesting the user for input parented to component with the dialog having the title title and message type messageType.

showInputDialog(Component, Object, String, int, Icon, Object[], Object)

Prompts the user for input in a blocking dialog.

showInputDialog(Object)

Shows an input dialog requesting the user for input.

showInternalConfirmDialog(Component, Object)

Brings up an internal dialog panel displaying the message message, with the dialog pane parented to component.

showInternalConfirmDialog(Component, Object, String, int)

Brings up an internal dialog containing a JOptionPane with either, Yes and No, or Yes, No and Cancel based on optionType.

showInternalConfirmDialog(Component, Object, String, int, int)

Brings up an internal dialog containing a JOptionPane with either, Yes and No or Yes, No and Cancel based on type.

showInternalConfirmDialog(Component, Object, String, int, int, Icon)

Brings up an internal dialog containing a JOptionPane with either, icon is used to indicate the default icon to display.

showInternalInputDialog(Component, Object)

Shows an internal input dialog requesting the user for input.

showInternalInputDialog(Component, Object, String, int)

Shows an internal input dialog requesting the user for input.

showInternalInputDialog(Component, Object, String, int, Icon, Object[], Object)

Prompts the user for input in a blocking dialog.

showInternalMessageDialog(Component, Object)

Brings up an internal dialog panel displaying the message message parented to the Component component.

showInternalMessageDialog(Component, Object, String, int)

Brings up an internal dialog panel displaying the message message, with the message type messageType.

showInternalMessageDialog(Component, Object, String, int, Icon)

Brings up an internal dialog panel displaying the message message, with the message type messageType.

showInternalOptionDialog(Component, Object, String, int, int, Icon, Object[], Object)

Brings up an internal dialog displaying message with options options selecting initialValue initialValue.

showMessageDialog(Component, Object)

Brings up a confirmation dialog -- a modal dialog panel displaying a message in a dialog titled "Confirm"

showMessageDialog(Component, Object, String, int)

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

showMessageDialog(Component, Object, String, int, Icon)

Brings up a dialog displaying a message.

showOptionDialog(Component, Object, String, int, int, Icon, Object[], Object)

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

updateUI()

Called to replace the UI with the latest version from the default UIFactory.

 public static final Object UNITIALIZED_VALUE

Potential value for value, means that the user has not selected a value yet.

 public static final int DEFAULT_OPTION

Type meaning look and feel should not supply any options, and only use the options from the JOptionPane.

 public static final int YES_NO_OPTION

Type used for showConfirmDialog.

 public static final int YES_NO_CANCEL_OPTION

Type used for showConfirmDialog.

 public static final int OK_CANCEL_OPTION

Type used for showConfirmDialog.

 public static final int YES_OPTION

Return value from class method if YES is chosen.

 public static final int NO_OPTION

Return value from class method if NO is chosen.

 public static final int CANCEL_OPTION

Return value from class method if CANCEL is chosen.

 public static final int OK_OPTION

Return value form class method if OK is chosen.

 public static final int CLOSED_OPTION

Return value from class method if user closes window without selecting anything, more than likely this should be treated as either a CANCEL_OPTION or NO_OPTION.

 public static final int ERROR_MESSAGE

Used for error messages.

 public static final int INFORMATION_MESSAGE

Used for information messages.

 public static final int WARNING_MESSAGE

Used for warning messages.

 public static final int QUESTION_MESSAGE

Used for questions.

 public static final int PLAIN_MESSAGE

No icon is used.

 public static final String ICON_PROPERTY

Bound property name for icon.

 public static final String MESSAGE_PROPERTY

Bound property name for message.

 public static final String VALUE_PROPERTY

Bounds property name for value.

 public static final String OPTIONS_PROPERTY

Bounds property namer for option.

 public static final String INITIAL_VALUE_PROPERTY

Bounds property name for initialValue.

 public static final String MESSAGE_TYPE_PROPERTY

Bounds property name for type.

 public static final String OPTION_TYPE_PROPERTY

Bound property name for optionType.

 public static final String SELECTION_VALUES_PROPERTY

Bound property name for selectionValues.

 public static final String INITIAL_SELECTION_VALUE_PROPERTY

Bound property name for initialSelectionValue.

 public static final String INPUT_VALUE_PROPERTY

Bound property name for inputValue.

 public static final String WANTS_INPUT_PROPERTY

Bound property name for wantsInput.

 protected static Frame sharedFrame

Frame used for static methods in creating a frame.

 protected transient Icon icon

Icon used in pane.

 protected transient Object message

Message to display.

 protected transient Object options[]

Options to display to the user.

 protected transient Object initialValue

Value that should be initialy selected in options.

 protected int messageType

Message type.

 protected int optionType

Option type, one of DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION.

 protected transient Object value

Currently selected value, will be a valid option, or UNITIALIZED_VALUE or null.

 protected transient Object selectionValues[]

Array of values the user can choose from. Look and feel will provide the UI component to choose this from.

 protected transient Object inputValue

Value the user has input.

 protected transient Object initialSelectionValue

Initial value to select in selectionValues.

 protected boolean wantsInput

If true, a UI widget will be provided to the user to get input.

 public JOptionPane()

Creates a JOptionPane with a test message.

 public JOptionPane(Object message)

Creates an instance of JOptionPane to display the message message. message is used as the main body of the JOptionPane. If message is an instance of String or Icon it will be placed in a JLabel. If message is a Component it will be added directly to the body, and if message is an array each element will be tested for the above. The message type used is PLAIN_MESSAGE.

Parameters:

message - message to display

 public JOptionPane(Object message,
                    int messageType)

Creates an instance of JOptionPane to display the message message with the message type messageType. This uses an option type of DEFAULT_OPTION.

Parameters:

message - message to display

messageType - type of message

 public JOptionPane(Object message,
                    int messageType,
                    int optionType)

Creates an instance of JOptionPane to display the message message, with the message type messageType and options type optionType.

Parameters:

message - message to display

messageType - type of message

optionType - type of option

 public JOptionPane(Object message,
                    int messageType,
                    int optionType,
                    Icon icon)

Creates an instance of JOptionPane to display the message message, with the message type messageType option type optionType, and Icon icon.

Parameters:

message - message to display

messageType - type of message

optionType - type of option

icon - Icon to display

 public JOptionPane(Object message,
                    int messageType,
                    int optionType,
                    Icon icon,
                    Object options[])

Creates an instance of JOptionPane to display the message message, with the message type messageType option type optionType, Icon icon and options options. options should contain either instances of Components, which will be added directly, or Strings which will be wrapped in a JButton. If you provide your own Components in options you must insure that when the Component is clicked on it messages setValue in the returned JOptionPane.

Parameters:

message - message to display

messageType - type of message

optionType - type of option

icon - Icon to display

options - options for user to choose from

 public JOptionPane(Object message,
                    int messageType,
                    int optionType,
                    Icon icon,
                    Object options[],
                    Object initialValue)

Creates an instance of JOptionPane to display the message message, with the message type messageType option type optionType, Icon icon and options options and the first value to select initialValue.

Parameters:

message - message to display

messageType - type of message

optionType - type of option

icon - Icon to display

options - options for user to choose from

initialValue - value to first select

 public static String showInputDialog(Object message)

Shows an input dialog requesting the user for input.

See Also:

showInputDialog

 public static String showInputDialog(Component component,
                                      Object message)

Shows an input dialog requesting the user for input parented to component

See Also:

showInputDialog

 public static String showInputDialog(Component component,
                                      Object message,
                                      String title,
                                      int messageType)

Shows an input dialog requesting the user for input parented to component with the dialog having the title title and message type messageType.

See Also:

showInputDialog

 public static Object showInputDialog(Component component,
                                      Object message,
                                      String title,
                                      int messageType,
                                      Icon icon,
                                      Object selectionValues[],
                                      Object initialSelectionValue)

Prompts the user for input in a blocking dialog. The message message will be displayed, the dialog will have the title title, message type messageType, and icon icon. The user will able to choose from selectionValuse, null implies the user can input what ever they wish, usually by means of a JTextField and 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 will usually be one of a JComboBox, JList or JTextField.

Returns:

users input, or null meaning the user canceled the input

 public static void showMessageDialog(Component component,
                                      Object message)

Brings up a confirmation dialog -- a modal dialog panel displaying a message in a dialog titled "Confirm"

Parameters:

component - Determines the Frame in which the dialog is displayed. If null, or if the component 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.

 public static void showMessageDialog(Component component,
                                      Object message,
                                      String title,
                                      int messageType)

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

Parameters:

component - Determines the Frame in which the dialog is displayed. If null, or if the component 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

messageType - an int designating the message as an error message, an informative message, a warning, a question, or a plain message, etc.

 public static void showMessageDialog(Component component,
                                      Object message,
                                      String title,
                                      int messageType,
                                      Icon icon)

Brings up a dialog displaying a message.

Parameters:

component - Determines the Frame in which the dialog is displayed. If null, or if the component 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

messageType - an int designating the message as an error message, an informative message, a warning, a question, or a plain message, etc.

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

 public static int showConfirmDialog(Component component,
                                     Object message)

Brings up a modal dialog with the options yes, no and cancel, and the title, "Select an Option".

Parameters:

component - Determines the Frame in which the dialog is displayed. If null, or if the component 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.

Returns:

an int indicating the option selected by the user

 public static int showConfirmDialog(Component component,
                                     Object message,
                                     String title,
                                     int optionType)

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

The option-sets are:

• Yes and No
• Yes, No, and Cancel

Parameters:

component - Determines the Frame in which the dialog is displayed. If null, or if the component 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 int designating the available options as, for example, yes-no, or yes-no-cancel

Returns:

an int indicating the option selected by the user

 public static int showConfirmDialog(Component component,
                                     Object message,
                                     String title,
                                     int optionType,
                                     int messageType)

Brings up a modal dialog where the number of choices is determined by the optionType parameter, where the messageType parameter determines the icon to display.

The option-sets are:

• Yes and No
• Yes, No, and Cancel

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

Parameters:

component - Determines the Frame in which the dialog is displayed. If null, or if the component 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 int designating the available options as, for example, yes-no, or yes-no-cancel

messageType - an int designating the kind of message this is, primarily used to determine the icon from the pluggable look and feel

Returns:

an int indicating the option selected by the user

 public static int showConfirmDialog(Component component,
                                     Object message,
                                     String title,
                                     int optionType,
                                     int messageType,
                                     Icon icon)

Brings up a modal dialog with a specified icon, where the number of choices is determined by the optionType parameter.

The option-sets are:

• Yes and No
• Yes, No, and Cancel

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

Parameters:

component - Determines the Frame in which the dialog is displayed. If null, or if the component 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 int designating the available options as, for example, yes-no, or yes-no-cancel

messageType - an int designating the kind of message this is

icon - the icon to display in the dialog

Returns:

an int indicating the option selected by the user

 public static int showOptionDialog(Component component,
                                    Object message,
                                    String title,
                                    int optionType,
                                    int messageType,
                                    Icon icon,
                                    Object options[],
                                    Object initialValue)

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

The option-sets are:

• Yes and No
• Yes, No, and Cancel

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:

component - Determines the Frame in which the dialog is displayed. If null, or if the component 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 int designating the available options as, for example, yes-no, or yes-no-cancel

messageType - an int designating the kind of message this is

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

Returns:

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

 public static JDialog createDialog(Component c,
                                    String title,
                                    JOptionPane pane)

Creates and returns a new JDialog rooted in frame centered around c. If newSize is not null, the Dialog is set to that size, otherwise the size is not set. title will be the title of the returned dialog. The returned JDialog will be set up such that once it is closed, or the user clicks on the OK button, the dialog will be disposed and closed.

 public static void showInternalMessageDialog(Component component,
                                              Object message)

Brings up an internal dialog panel displaying the message message parented to the Component component. The title of the dialog will be Confirm.

 public static void showInternalMessageDialog(Component component,
                                              Object message,
                                              String title,
                                              int messageType)

Brings up an internal dialog panel displaying the message message, with the message type messageType. The dialog will have title title. component is used to determine the Frame to create the Dialog with, if component is null or has no Frame a default Frame will be used.

The icon will be determined from the messageType.

 public static void showInternalMessageDialog(Component component,
                                              Object message,
                                              String title,
                                              int messageType,
                                              Icon icon)

Brings up an internal dialog panel displaying the message message, with the message type messageType. The dialog will have title title. component is used to determine the Frame to create the Dialog with, if component is null or has no Frame a default Frame will be used.

 public static int showInternalConfirmDialog(Component component,
                                             Object message)

Brings up an internal dialog panel displaying the message message, with the dialog pane parented to component. The options will be yes, no and cancel.

Returns:

selected option

 public static int showInternalConfirmDialog(Component component,
                                             Object message,
                                             String title,
                                             int optionType)

Brings up an internal dialog containing a JOptionPane with either, Yes and No, or Yes, No and Cancel based on optionType. This method will block until the user clicks on one of the buttons or closes the window. title will be the title of the Dialog. The Component component is used to determine the Frame to create the Dialog with, if component is null or has no Frame a default Frame will be used.

 public static int showInternalConfirmDialog(Component component,
                                             Object message,
                                             String title,
                                             int optionType,
                                             int messageType)

Brings up an internal dialog containing a JOptionPane with either, Yes and No or Yes, No and Cancel based on type. messageType indicates the type of message this, and is primarily used to supply a default icon from the look and feel.

 public static int showInternalConfirmDialog(Component component,
                                             Object message,
                                             String title,
                                             int optionType,
                                             int messageType,
                                             Icon icon)

Brings up an internal dialog containing a JOptionPane with either, icon is used to indicate the default icon to display.

 public static int showInternalOptionDialog(Component component,
                                            Object message,
                                            String title,
                                            int optionType,
                                            int messageType,
                                            Icon icon,
                                            Object options[],
                                            Object initialValue)

Brings up an internal dialog displaying message with options options selecting initialValue initialValue. component is used to determine the frame for the Dialog. If component is null or does not contain a parent Frame, the root Frame from JOptionPane will be used. This method blocks until the user closes the dialog, or clicks on one of the options. The return value will indicate the index of the chosen option, or CLOSED_OPTION if the user closed the Dialog. title will be the title of the Dialog. If optionType is YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION and options is null the options will be supplied from the look and feel. messageType is primarily used to obtain a default image.

 public static String showInternalInputDialog(Component component,
                                              Object message)

Shows an internal input dialog requesting the user for input.

See Also:

showInternalInputDialog

 public static String showInternalInputDialog(Component component,
                                              Object message,
                                              String title,
                                              int messageType)

Shows an internal input dialog requesting the user for input.

See Also:

showInternalInputDialog

 public static Object showInternalInputDialog(Component component,
                                              Object message,
                                              String title,
                                              int messageType,
                                              Icon icon,
                                              Object selectionValues[],
                                              Object initialSelectionValue)

Prompts the user for input in a blocking dialog. The message message will be displayed, the dialog will have the title title, message type messageType, and icon icon. The user will able to choose from selectionValuse, null implies the user can input what ever they wish, usually by means of a JTextField and 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 will usually be one of a JComboBox, JList or JTextField.

Returns:

users input, or null meaning the user canceled the input

 public static JInternalFrame createInternalFrame(Component component,
                                                  String title,
                                                  JOptionPane pane)

Creates and returns an instance of JInternalFrame. The internal frame will be created with the passed in title title, and the JOptionPane pane will be added to the returned JInternalFrame instance. The returned JInternalFrame will be add to the JDesktopPane ancestor of component, or components parent if one its ancestors isn't a JDesktopPane, or if component doesn't have a parent and RuntimeException will be thrown.

 public static Frame getFrameForComponent(Component component)

Returns the parent Frame of component. If component is null, or does not contain a valid Frame parent getRootFrame will be returned.

 public static JDesktopPane getDesktopPaneForComponent(Component c)

Will return the parent of c that is an instance of JDesktopPane, or null if c does not have an ancestor that is a JInternalFrame.

 public static void setRootFrame(Frame newRootFrame)

Sets the frame to use for class methods in which a frame is not provided.

 public static Frame getRootFrame()

Returns the Frame to use for the class methods in which a frame is not provided.

 public void setUI(OptionPaneUI ui)

Sets the OptionPaneUI to ui that will provide the current look and feel.

 public OptionPaneUI getUI()

Returns the OptionPaneUI that is providing the current look and feel.

 public void updateUI()

Called to replace the UI with the latest version from the default UIFactory.

Overrides:

updateUI in class JComponent

 public String getUIClassID()

Returns:

"OptionPaneUI"

Overrides:

getUIClassID in class JComponent

See Also:

getUIClassID, getUI

 public void setMessage(Object newMessage)

Sets the message to newMessage. Refer to the constructor for possible values of newMessage.

This is a JavaBeans bound property.

 public Object getMessage()

Returns the message the receiver is representing.

 public void setIcon(Icon newIcon)

Sets the icon to display. If non null, the look and feel will not provide an icon.

This is a JavaBeans bound property.

 public Icon getIcon()

Returns the icon the receiver is displaying.

 public void setValue(Object newValue)

Sets the value the user has chosen. Fires a bound property

This is a JavaBeans bound property.

 public Object getValue()

Returns the value the user has selected. UNITIALIZED_VALUE implies the user has not yet made a choice, null means the user closed the window with out chosing anything otherwise the returned value will be one of the options in the receiver.

 public void setOptions(Object newOptions[])

Sets the options the user is to display. If an element in newOptions is a Comonent it is added directly to the receiver, otherwise a button is created for the element.

This is a JavaBeans bound property.

 public Object[] getOptions()

Returns the options, or choices the user can click on.

 public void setInitialValue(Object newInitialValue)

Sets the initial value that is to be enabled to newInitialValue.

This is a JavaBeans bound property.

 public Object getInitialValue()

Returns the initial value.

 public void setMessageType(int newType)

Sets the message type of the receiver to newType. newType should be one of ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE or PLAIN_MESSAGE, otherwise an exception will be thrown.

The message type is used by the look and feel to determine the icon to display (if not supplied) as well as potentially how to lay out the component.

This is a JavaBeans bound property.

 public int getMessageType()

Returns the message type.

 public void setOptionType(int newType)

Sets the type of option to newType. newType must be one of DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION If newType is not one of these an exception will be thrown. The option type is used by the look and feel to determine what buttons to show (unless options are supplied).

This is a JavaBeans bound property.

 public int getOptionType()

Returns an integer indicating the type of options that are to be displayed.

 public void setSelectionValues(Object newValues[])

Sets the selection values to newValues. If newValues are non-null this will message setWantsInput with true. If true, the UI will provide a UI widget for choosing one of the values in newValues. Use setInitialSelectionValue to set the initial value to select. After the pane as been enabled, inputValue will be set to the value the user has selected.

This is a bound property.

See Also:

setWantsInput, setInitialSelectionValue

 public Object[] getSelectionValues()

Returns the selection values.

See Also:

setSelectionValues

 public void setInitialSelectionValue(Object newValue)

Sets the value to select in getSelectionValues to newValue. This is only used if getWantsInput is true.

This is a bound property.

See Also:

setSelectionValues

 public Object getInitialSelectionValue()

Returns the value to initialy select in getSelectionValues.

See Also:

setInitialSelectionValue, setSelectionValues

 public void setInputValue(Object newValue)

Sets the value the user has input to newValue.

See Also:

setSelectionValues, setWantsInput

 public Object getInputValue()

Returns the value the user has input, if getWantsInput return true.

See Also:

setSelectionValues, setWantsInput

 public void setWantsInput(boolean newValue)

If newValue is true, a component will be provided to allow the user to input a value. If getSelectionValues returns a non-null the input value will be one from that array, otherwise the input value will be whatever the user inputs.

This is a bound property.

See Also:

setSelectionValues, setInputValue

 public boolean getWantsInput()

Returns true if a component will be provided for the user to input.

See Also:

setWantsInput

 public void selectInitialValue()

Requests that the initial value be selected. It is best to invoke this before displaying the receiver, but after the receiver is appropriately parented so that focus will be maintained.

All Packages  Class Hierarchy  This Package  Previous  Next  Index