Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}. 

 public JOptionPane() 
{
        this("JOptionPane message");
}

Creates a JOptionPane with a test message.

 public JOptionPane(Object message) 
{
        this(message, PLAIN_MESSAGE);
}

Creates a instance of JOptionPane to display a message using the plain-message message type and the default options delivered by the UI.

Parameters:

message - the Object to display

 public JOptionPane(Object message,
    int messageType) 
{
        this(message, messageType, DEFAULT_OPTION);
}

Creates an instance of JOptionPane to display a message with the specified message type and the default options,

Parameters:

message - the Object to display

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

 public JOptionPane(Object message,
    int messageType,
    int optionType) 
{
        this(message, messageType, optionType, null);
}

Creates an instance of JOptionPane to display a message with the specified message type and options.

Parameters:

message - the Object to display

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

optionType - the options to display in the pane: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, OK_CANCEL_OPTION

 public JOptionPane(Object message,
    int messageType,
    int optionType,
    Icon icon) 
{
        this(message, messageType, optionType, icon, null);
}

Creates an instance of JOptionPane to display a message with the specified message type, options, and icon.

Parameters:

message - the Object to display

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

optionType - the options to display in the pane: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, OK_CANCEL_OPTION

icon - the Icon image to display

 public JOptionPane(Object message,
    int messageType,
    int optionType,
    Icon icon,
    Object[] options) 
{
        this(message, messageType, optionType, icon, options, null);
}

Creates an instance of JOptionPane to display a message with the specified message type, icon, and options. None of the options is initially selected.

The options objects should contain either instances of Components, (which are added directly) or Strings (which are wrapped in a JButton). If you provide Components, you must ensure that when the Component is clicked it messages setValue in the created JOptionPane.

Parameters:

message - the Object to display

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

optionType - the options to display in the pane: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, OK_CANCEL_OPTION

icon - the Icon image to display

options - the choices the user can select

 public JOptionPane(Object message,
    int messageType,
    int optionType,
    Icon icon,
    Object[] options,
    Object initialValue) 
{
        this.message = message;
        this.options = options;
        this.initialValue = initialValue;
        this.icon = icon;
        setMessageType(messageType);
        setOptionType(optionType);
        value = UNINITIALIZED_VALUE;
        inputValue = UNINITIALIZED_VALUE;
        updateUI();
}

Creates an instance of JOptionPane to display a message with the specified message type, icon, and options, with the initially-selected option specified.

Parameters:

message - the Object to display

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

optionType - the options to display in the pane: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, OK_CANCEL_OPTION

icon - the Icon image to display

options - the choices the user can select

initialValue - the choice that is initially selected; if null, then nothing will be initially selected; only meaningful if options is used

 public JDialog createDialog(String title) throws HeadlessException 
{
        int style = styleFromMessageType(getMessageType());
        JDialog dialog = new JDialog((Dialog) null, title, true);
        initDialog(dialog, style, null);
        return dialog;
}

Creates and returns a new parentless JDialog with the specified title. The returned JDialog will not be resizable by the user, however programs can invoke setResizable on the JDialog instance to change this property. The returned JDialog will be set up such that once it is closed, or the user clicks on one of the buttons, the optionpane's value property will be set accordingly and the dialog will be closed. Each time the dialog is made visible, it will reset the option pane's value property to JOptionPane.UNINITIALIZED_VALUE to ensure the user's subsequent action closes the dialog properly.

 public JDialog createDialog(Component parentComponent,
    String title) throws HeadlessException 
{
        int style = styleFromMessageType(getMessageType());
        return createDialog(parentComponent, title, style);
}

Creates and returns a new JDialog wrapping this centered on the parentComponent in the parentComponent's frame. title is the title of the returned dialog. The returned JDialog will not be resizable by the user, however programs can invoke setResizable on the JDialog instance to change this property. The returned JDialog will be set up such that once it is closed, or the user clicks on one of the buttons, the optionpane's value property will be set accordingly and the dialog will be closed. Each time the dialog is made visible, it will reset the option pane's value property to JOptionPane.UNINITIALIZED_VALUE to ensure the user's subsequent action closes the dialog properly.

 public JInternalFrame createInternalFrame(Component parentComponent,
    String title) 
{
        Container parent =
                JOptionPane.getDesktopPaneForComponent(parentComponent);
        if (parent == null && (parentComponent == null ||
                (parent = parentComponent.getParent()) == null)) {
            throw new RuntimeException("JOptionPane: parentComponent does " +
                    "not have a valid parent");
        }
        // Option dialogs should be closable only
        final JInternalFrame  iFrame = new JInternalFrame(title, false, true,
                                                           false, false);
        iFrame.putClientProperty("JInternalFrame.frameType", "optionDialog");
        iFrame.putClientProperty("JInternalFrame.messageType",
                                 Integer.valueOf(getMessageType()));
        iFrame.addInternalFrameListener(new InternalFrameAdapter() {
            public void internalFrameClosing(InternalFrameEvent e) {
                if (getValue() == UNINITIALIZED_VALUE) {
                    setValue(null);
                }
            }
        });
        addPropertyChangeListener(new PropertyChangeListener() {
            public void propertyChange(PropertyChangeEvent event) {
                // Let the defaultCloseOperation handle the closing
                // if the user closed the iframe without selecting a button
                // (newValue = null in that case).  Otherwise, close the dialog.
                if (iFrame.isVisible() &&
                        event.getSource() == JOptionPane.this &&
                        event.getPropertyName().equals(VALUE_PROPERTY)) {
                // Use reflection to get Container.stopLWModal().
                try {
                    Object obj;
                    obj = AccessController.doPrivileged(
                        new ModalPrivilegedAction(
                            Container.class, "stopLWModal"));
                    if (obj != null) {
                        ((Method)obj).invoke(iFrame, (Object[])null);
                    }
                } catch (IllegalAccessException ex) {
                } catch (IllegalArgumentException ex) {
                } catch (InvocationTargetException ex) {
                }
                try {
                    iFrame.setClosed(true);
                }
                catch (java.beans.PropertyVetoException e) {
                }
                iFrame.setVisible(false);
                }
            }
        });
        iFrame.getContentPane().add(this, BorderLayout.CENTER);
        if (parent instanceof JDesktopPane) {
            parent.add(iFrame, JLayeredPane.MODAL_LAYER);
        } else {
            parent.add(iFrame, BorderLayout.CENTER);
        }
        Dimension iFrameSize = iFrame.getPreferredSize();
        Dimension rootSize = parent.getSize();
        Dimension parentSize = parentComponent.getSize();
        iFrame.setBounds((rootSize.width - iFrameSize.width) / 2,
                         (rootSize.height - iFrameSize.height) / 2,
                         iFrameSize.width, iFrameSize.height);
        // We want dialog centered relative to its parent component
        Point iFrameCoord =
          SwingUtilities.convertPoint(parentComponent, 0, 0, parent);
        int x = (parentSize.width - iFrameSize.width) / 2 + iFrameCoord.x;
        int y = (parentSize.height - iFrameSize.height) / 2 + iFrameCoord.y;
        // If possible, dialog should be fully visible
        int ovrx = x + iFrameSize.width - rootSize.width;
        int ovry = y + iFrameSize.height - rootSize.height;
        x = Math.max((ovrx  > 0? x - ovrx: x), 0);
        y = Math.max((ovry  > 0? y - ovry: y), 0);
        iFrame.setBounds(x, y, iFrameSize.width, iFrameSize.height);
        parent.validate();
        try {
            iFrame.setSelected(true);
        } catch (java.beans.PropertyVetoException e) {}
        return iFrame;
}

Creates and returns an instance of JInternalFrame. The internal frame is created with the specified title, and wrapping the JOptionPane. The returned JInternalFrame is added to the JDesktopPane ancestor of parentComponent, or components parent if one its ancestors isn't a JDesktopPane, or if parentComponent doesn't have a parent then a RuntimeException is thrown.

 public AccessibleContext getAccessibleContext() 
{
        if (accessibleContext == null) {
            accessibleContext = new AccessibleJOptionPane();
        }
        return accessibleContext;
}

Returns the AccessibleContext associated with this JOptionPane. For option panes, the AccessibleContext takes the form of an AccessibleJOptionPane. A new AccessibleJOptionPane instance is created if necessary.

 public static JDesktopPane getDesktopPaneForComponent(Component parentComponent) 
{
        if(parentComponent == null)
            return null;
        if(parentComponent instanceof JDesktopPane)
            return (JDesktopPane)parentComponent;
        return getDesktopPaneForComponent(parentComponent.getParent());
}

Returns the specified component's desktop pane.

 public static Frame getFrameForComponent(Component parentComponent) throws HeadlessException 
{
        if (parentComponent == null)
            return getRootFrame();
        if (parentComponent instanceof Frame)
            return (Frame)parentComponent;
        return JOptionPane.getFrameForComponent(parentComponent.getParent());
}

Returns the specified component's Frame.

 public Icon getIcon() 
{
        return icon;
}

Returns the icon this pane displays.

 public Object getInitialSelectionValue() 
{
        return initialSelectionValue;
}

Returns the input value that is displayed as initially selected to the user.

 public Object getInitialValue() 
{
        return initialValue;
}

Returns the initial value.

 public Object getInputValue() 
{
        return inputValue;
}

Returns the value the user has input, if wantsInput is true.

 public int getMaxCharactersPerLineCount() 
{
        return Integer.MAX_VALUE;
}

Returns the maximum number of characters to place on a line in a message. Default is to return Integer.MAX_VALUE. The value can be changed by overriding this method in a subclass.

 public Object getMessage() 
{
        return message;
}

Returns the message-object this pane displays.

 public int getMessageType() 
{
        return messageType;
}

Returns the message type.

 public int getOptionType() 
{
        return optionType;
}

Returns the type of options that are displayed.

 public Object[] getOptions() 
{
        if(options != null) {
            int             optionCount = options.length;
            Object[]        retOptions = new Object[optionCount];
            System.arraycopy(options, 0, retOptions, 0, optionCount);
            return retOptions;
        }
        return options;
}

Returns the choices the user can make.

 public static Frame getRootFrame() throws HeadlessException 
{
        Frame sharedFrame =
            (Frame)SwingUtilities.appContextGet(sharedFrameKey);
        if (sharedFrame == null) {
            sharedFrame = SwingUtilities.getSharedOwnerFrame();
            SwingUtilities.appContextPut(sharedFrameKey, sharedFrame);
        }
        return sharedFrame;
}

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

 public Object[] getSelectionValues() 
{
        return selectionValues;
}

Returns the input selection values.

 public OptionPaneUI getUI() 
{
        return (OptionPaneUI)ui;
}

Returns the UI object which implements the L&F for this component.

 public String getUIClassID() 
{
        return uiClassID;
}

Returns the name of the UI class that implements the L&F for this component.

 public Object getValue() 
{
        return value;
}

Returns the value the user has selected. UNINITIALIZED_VALUE implies the user has not yet made a choice, null means the user closed the window with out choosing anything. Otherwise the returned value will be one of the options defined in this object.

 public boolean getWantsInput() 
{
        return wantsInput;
}

Returns the value of the wantsInput property.

 static Window getWindowForComponent(Component parentComponent) throws HeadlessException 
{
        if (parentComponent == null)
            return getRootFrame();
        if (parentComponent instanceof Frame || parentComponent instanceof Dialog)
            return (Window)parentComponent;
        return JOptionPane.getWindowForComponent(parentComponent.getParent());
}

Returns the specified component's toplevel Frame or Dialog.

 protected String paramString() 
{
        String iconString = (icon != null ?
                             icon.toString() : "");
        String initialValueString = (initialValue != null ?
                                     initialValue.toString() : "");
        String messageString = (message != null ?
                                message.toString() : "");
        String messageTypeString;
        if (messageType == ERROR_MESSAGE) {
            messageTypeString = "ERROR_MESSAGE";
        } else if (messageType == INFORMATION_MESSAGE) {
            messageTypeString = "INFORMATION_MESSAGE";
        } else if (messageType == WARNING_MESSAGE) {
            messageTypeString = "WARNING_MESSAGE";
        } else if (messageType == QUESTION_MESSAGE) {
            messageTypeString = "QUESTION_MESSAGE";
        } else if (messageType == PLAIN_MESSAGE)  {
            messageTypeString = "PLAIN_MESSAGE";
        } else messageTypeString = "";
        String optionTypeString;
        if (optionType == DEFAULT_OPTION) {
            optionTypeString = "DEFAULT_OPTION";
        } else if (optionType == YES_NO_OPTION) {
            optionTypeString = "YES_NO_OPTION";
        } else if (optionType == YES_NO_CANCEL_OPTION) {
            optionTypeString = "YES_NO_CANCEL_OPTION";
        } else if (optionType == OK_CANCEL_OPTION) {
            optionTypeString = "OK_CANCEL_OPTION";
        } else optionTypeString = "";
        String wantsInputString = (wantsInput ?
                                   "true" : "false");
        return super.paramString() +
        ",icon=" + iconString +
        ",initialValue=" + initialValueString +
        ",message=" + messageString +
        ",messageType=" + messageTypeString +
        ",optionType=" + optionTypeString +
        ",wantsInput=" + wantsInputString;
}

Returns a string representation of this JOptionPane. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

 public  void selectInitialValue() 
{
        OptionPaneUI         ui = getUI();
        if (ui != null) {
            ui.selectInitialValue(this);
        }
}

Requests that the initial value be selected, which will set focus to the initial value. This method should be invoked after the window containing the option pane is made visible.

 public  void setIcon(Icon newIcon) 
{
        Object              oldIcon = icon;
        icon = newIcon;
        firePropertyChange(ICON_PROPERTY, oldIcon, icon);
}

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

 public  void setInitialSelectionValue(Object newValue) 
{
        Object          oldValue = initialSelectionValue;
        initialSelectionValue = newValue;
        firePropertyChange(INITIAL_SELECTION_VALUE_PROPERTY, oldValue,
                           newValue);
}

Sets the input value that is initially displayed as selected to the user. Only used if wantsInput is true.

 public  void setInitialValue(Object newInitialValue) 
{
        Object            oldIV = initialValue;
        initialValue = newInitialValue;
        firePropertyChange(INITIAL_VALUE_PROPERTY, oldIV, initialValue);
}

Sets the initial value that is to be enabled -- the Component that has the focus when the pane is initially displayed.

 public  void setInputValue(Object newValue) 
{
        Object              oldValue = inputValue;
        inputValue = newValue;
        firePropertyChange(INPUT_VALUE_PROPERTY, oldValue, newValue);
}

Sets the input value that was selected or input by the user. Only used if wantsInput is true. Note that this method is invoked internally by the option pane (in response to user action) and should generally not be called by client programs. To set the input value initially displayed as selected to the user, use setInitialSelectionValue.

 public  void setMessage(Object newMessage) 
{
        Object           oldMessage = message;
        message = newMessage;
        firePropertyChange(MESSAGE_PROPERTY, oldMessage, message);
}

Sets the option pane's message-object.

 public  void setMessageType(int newType) 
{
        if(newType != ERROR_MESSAGE && newType != INFORMATION_MESSAGE &&
           newType != WARNING_MESSAGE && newType != QUESTION_MESSAGE &&
           newType != PLAIN_MESSAGE)
            throw new RuntimeException("JOptionPane: type must be one of JOptionPane.ERROR_MESSAGE, JOptionPane.INFORMATION_MESSAGE, JOptionPane.WARNING_MESSAGE, JOptionPane.QUESTION_MESSAGE or JOptionPane.PLAIN_MESSAGE");
        int           oldType = messageType;
        messageType = newType;
        firePropertyChange(MESSAGE_TYPE_PROPERTY, oldType, messageType);
}

Sets the option pane's message type. 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 parentComponent.

 public  void setOptionType(int newType) 
{
        if(newType != DEFAULT_OPTION && newType != YES_NO_OPTION &&
           newType != YES_NO_CANCEL_OPTION && newType != OK_CANCEL_OPTION)
            throw new RuntimeException("JOptionPane: option type must be one of JOptionPane.DEFAULT_OPTION, JOptionPane.YES_NO_OPTION, JOptionPane.YES_NO_CANCEL_OPTION or JOptionPane.OK_CANCEL_OPTION");
        int            oldType = optionType;
        optionType = newType;
        firePropertyChange(OPTION_TYPE_PROPERTY, oldType, optionType);
}

Sets the options to display. The option type is used by the Look and Feel to determine what buttons to show (unless options are supplied).

 public  void setOptions(Object[] newOptions) 
{
        Object[]           oldOptions = options;
        options = newOptions;
        firePropertyChange(OPTIONS_PROPERTY, oldOptions, options);
}

Sets the options this pane displays. If an element in newOptions is a Component it is added directly to the pane, otherwise a button is created for the element.

 public static  void setRootFrame(Frame newRootFrame) 
{
                                               
        if (newRootFrame != null) {
            SwingUtilities.appContextPut(sharedFrameKey, newRootFrame);
        } else {
            SwingUtilities.appContextRemove(sharedFrameKey);
        }
}

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

Note: It is recommended that rather than using this method you supply a valid parent.

 public  void setSelectionValues(Object[] newValues) 
{
        Object[]           oldValues = selectionValues;
        selectionValues = newValues;
        firePropertyChange(SELECTION_VALUES_PROPERTY, oldValues, newValues);
        if(selectionValues != null)
            setWantsInput(true);
}

Sets the input selection values for a pane that provides the user with a list of items to choose from. (The UI provides a widget for choosing one of the values.) A null value implies the user can input whatever they wish, usually by means of a JTextField.

Sets wantsInput to true. Use setInitialSelectionValue to specify the initially-chosen value. After the pane as been enabled, inputValue is set to the value the user has selected.

 public  void setUI(OptionPaneUI ui) 
{
        if ((OptionPaneUI)this.ui != ui) {
            super.setUI(ui);
            invalidate();
        }
}

Sets the UI object which implements the L&F for this component.

 public  void setValue(Object newValue) 
{
        Object               oldValue = value;
        value = newValue;
        firePropertyChange(VALUE_PROPERTY, oldValue, value);
}

Sets the value the user has chosen.

 public  void setWantsInput(boolean newValue) 
{
        boolean            oldValue = wantsInput;
        wantsInput = newValue;
        firePropertyChange(WANTS_INPUT_PROPERTY, oldValue, newValue);
}

Sets the wantsInput property. If newValue is true, an input component (such as a text field or combo box) whose parent is parentComponent is provided to allow the user to input a value. If getSelectionValues returns a non-null array, the input value is one of the objects in that array. Otherwise the input value is whatever the user inputs.

This is a bound property.

 public static int showConfirmDialog(Component parentComponent,
    Object message) throws HeadlessException 
{
        return showConfirmDialog(parentComponent, message,
                                 UIManager.getString("OptionPane.titleText"),
                                 YES_NO_CANCEL_OPTION);
}

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

 public static int showConfirmDialog(Component parentComponent,
    Object message,
    String title,
    int optionType) throws HeadlessException 
{
        return showConfirmDialog(parentComponent, message, title, optionType,
                                 QUESTION_MESSAGE);
}

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

 public static int showConfirmDialog(Component parentComponent,
    Object message,
    String title,
    int optionType,
    int messageType) throws HeadlessException 
{
        return showConfirmDialog(parentComponent, message, title, optionType,
                                messageType, null);
}

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.

 public static int showConfirmDialog(Component parentComponent,
    Object message,
    String title,
    int optionType,
    int messageType,
    Icon icon) throws HeadlessException 
{
        return showOptionDialog(parentComponent, message, title, optionType,
                                messageType, icon, null, null);
}

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.

 public static String showInputDialog(Object message) throws HeadlessException 
{
                                                   
        return showInputDialog(null, message);
}

Shows a question-message dialog requesting input from