JOptionPane (Java 2 Platform SE v1.4.1_"07")

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.swing
Class JOptionPane

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

All Implemented Interfaces:
  Accessible, ImageObserver, MenuContainer, Serializable

public class JOptionPane
extends JComponent
implements Accessible

`JOptionPane` makes it easy to pop up a standard dialog box that prompts users for a value or informs them of something. For information about using `JOptionPane`, see How to Make Dialogs, a section in The Java Tutorial.

While the `JOptionPane` class may appear complex because of the large number of methods, almost all uses of this class are one-line calls to one of the static `showXxxDialog` methods shown below:

> showConfirmDialog | Asks a confirming question, like yes/no/cancel.
> showInputDialog | Prompt for some input.
> showMessageDialog | Tell the user about something that has happened.
> showOptionDialog | The Grand Unification of the above three.

Each of these methods also comes in a `showInternalXXX` flavor, which uses an internal frame to hold the dialog box (see `JInternalFrame`). Multiple convenience methods have also been defined -- overloaded versions of the basic methods that use different parameter lists.

All dialogs are modal. Each `showXxxDialog` method blocks the current thread until the user's interaction is complete.

icon | message
input value
option buttons

The basic appearance of one of these dialog boxes is generally similar to the picture at the right, although the various look-and-feels are ultimately responsible for the final result. In particular, the look-and-feels will adjust the layout to accommodate the option pane's `ComponentOrientation` property.

Parameters:
The parameters to these methods follow consistent patterns:

> parentComponent
>   Defines the `Component` that is to be the parent of this dialog box. It is used in two ways: the `Frame` that contains it is used as the `Frame` parent for the dialog box, and its screen coordinates are used in the placement of the dialog box. In general, the dialog box is placed just below the component. This parameter may be `null`, in which case a default `Frame` is used as the parent, and the dialog will be centered on the screen (depending on the L&F).
> message
>   A descriptive message to be placed in the dialog box. In the most common usage, message is just a `String` or `String` constant. However, the type of this parameter is actually `Object`. Its interpretation depends on its type:
>   Object[]
>     An array of objects is interpreted as a series of messages (one per object) arranged in a vertical stack. The interpretation is recursive -- each object in the array is interpreted according to its type.
>   Component
>     The `Component` is displayed in the dialog.
>   Icon
>     The `Icon` is wrapped in a `JLabel` and displayed in the dialog.
>   others
>     The object is converted to a `String` by calling its `toString` method. The result is wrapped in a `JLabel` and displayed.
> messageType
>   Defines the style of the message. The Look and Feel manager may lay out the dialog differently depending on this value, and will often provide a default icon. The possible values are:
>   - `ERROR_MESSAGE`
>   - `INFORMATION_MESSAGE`
>   - `WARNING_MESSAGE`
>   - `QUESTION_MESSAGE`
>   - `PLAIN_MESSAGE`
> optionType
>   Defines the set of option buttons that appear at the bottom of the dialog box:
>   - `DEFAULT_OPTION`
>   - `YES_NO_OPTION`
>   - `YES_NO_CANCEL_OPTION`
>   - `OK_CANCEL_OPTION`
>   You aren't limited to this set of option buttons. You can provide any buttons you want using the options parameter.
> options
>   A more detailed description of the set of option buttons that will appear at the bottom of the dialog box. The usual value for the options parameter is an array of `String`s. But the parameter type is an array of `Objects`. A button is created for each object depending on its type:
>   Component
>     The component is added to the button row directly.
>   Icon
>     A `JButton` is created with this as its label.
>   other
>     The `Object` is converted to a string using its `toString` method and the result is used to label a `JButton`.
> icon
>   A decorative icon to be placed in the dialog box. A default value for this is determined by the `messageType` parameter.
> title
>   The title for the dialog box.
> initialValue
>   The default selection (input value).

When the selection is changed, `setValue` is invoked, which generates 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.

When one of the `showXxxDialog` methods returns an integer, the possible values are:

- `YES_OPTION`
- `NO_OPTION`
- `CANCEL_OPTION`
- `OK_OPTION`
- `CLOSED_OPTION`

Examples:

Show an error dialog that displays the message, 'alert':
  `JOptionPane.showMessageDialog(null, "alert", "alert", JOptionPane.ERROR_MESSAGE);`

Show an internal information dialog with the message, 'information':
  `JOptionPane.showInternalMessageDialog(frame, "information",
  "information", JOptionPane.INFORMATION_MESSAGE);
  `

Show an information panel with the options yes/no and message 'choose one':
  `JOptionPane.showConfirmDialog(null,
  "choose one", "choose one", JOptionPane.YES_NO_OPTION);
  `

Show an internal information dialog with the options yes/no/cancel and message 'please choose one' and title information:
  `JOptionPane.showInternalConfirmDialog(frame,
  "please choose one", "information",
  JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.INFORMATION_MESSAGE);
  `

Show a warning dialog with the options OK, CANCEL, title 'Warning', and message 'Click OK to continue':
  `Object[] options = { "OK", "CANCEL" };
  JOptionPane.showOptionDialog(null, "Click OK to continue", "Warning",
  JOptionPane.DEFAULT_OPTION, JOptionPane.WARNING_MESSAGE,
  null, options, options[0]);
  `

Show a dialog asking the user to type in a String:
  `String inputValue = JOptionPane.showInputDialog("Please input a value");`

Show a dialog asking the user to select a String:
  `Object[] possibleValues = { "First", "Second", "Third" };
  Object selectedValue = JOptionPane.showInputDialog(null,
  "Choose one", "Input",
  JOptionPane.INFORMATION_MESSAGE, null,
  possibleValues, possibleValues[0]);
  `

Direct Use:
To create and use an `JOptionPane` directly, the standard pattern is roughly as follows:

         JOptionPane pane = new JOptionPane(arguments);
         pane.set.Xxxx(...); // Configure
         JDialog dialog = pane.createDialog(parentComponent, title);
         dialog.show();
         Object selectedValue = pane.getValue();
         if(selectedValue == null)
           return CLOSED_OPTION;
         //If there is not an array of option buttons:
         if(options == null) {
           if(selectedValue instanceof Integer)
              return ((Integer)selectedValue).intValue();
           return CLOSED_OPTION;
         }
         //If there is an array of option buttons:
         for(int counter = 0, maxCounter = options.length;
            counter < maxCounter; counter++) {
            if(options[counter].equals(selectedValue))
            return counter;
         }
         return CLOSED_OPTION;

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the `JOptionPane` key assignments.

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 JavaBeansTM has been added to the `java.beans` package. Please see `XMLEncoder`.

See Also:
  `JInternalFrame`

Nested Class Summary
`protected class` | `JOptionPane.AccessibleJOptionPane` This class implements accessibility support for the `JOptionPane` class.

Nested classes inherited from class javax.swing.JComponent
``

Nested classes inherited from class java.awt.Container
``

Nested classes inherited from class java.awt.Component
`Component.BltBufferStrategy, Component.FlipBufferStrategy`

Field Summary
`static int` | `CANCEL_OPTION` Return value from class method if CANCEL is chosen.
`static 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`.
`static int` | `DEFAULT_OPTION` Type used for `showConfirmDialog`.
`static int` | `ERROR_MESSAGE` Used for error messages.
`protected Icon` | `icon` Icon used in pane.
`static String` | `ICON_PROPERTY` Bound property name for `icon`.
`static int` | `INFORMATION_MESSAGE` Used for information messages.
`static String` | `INITIAL_SELECTION_VALUE_PROPERTY` Bound property name for `initialSelectionValue`.
`static String` | `INITIAL_VALUE_PROPERTY` Bound property name for `initialValue`.
`protected Object` | `initialSelectionValue` Initial value to select in `selectionValues`.
`protected Object` | `initialValue` Value that should be initially selected in `options`.
`static String` | `INPUT_VALUE_PROPERTY` Bound property name for `inputValue`.
`protected Object` | `inputValue` Value the user has input.
`protected Object` | `message` Message to display.
`static String` | `MESSAGE_PROPERTY` Bound property name for `message`.
`static String` | `MESSAGE_TYPE_PROPERTY` Bound property name for `type`.
`protected int` | `messageType` Message type.
`static int` | `NO_OPTION` Return value from class method if NO is chosen.
`static int` | `OK_CANCEL_OPTION` Type used for `showConfirmDialog`.
`static int` | `OK_OPTION` Return value form class method if OK is chosen.
`static String` | `OPTION_TYPE_PROPERTY` Bound property name for `optionType`.
`protected Object[]` | `options` Options to display to the user.
`static String` | `OPTIONS_PROPERTY` Bound property name for `option`.
`protected int` | `optionType` Option type, one of `DEFAULT_OPTION`, `YES_NO_OPTION`, `YES_NO_CANCEL_OPTION` or `OK_CANCEL_OPTION`.
`static int` | `PLAIN_MESSAGE` No icon is used.
`static int` | `QUESTION_MESSAGE` Used for questions.
`static String` | `SELECTION_VALUES_PROPERTY` Bound property name for `selectionValues`.
`protected Object[]` | `selectionValues` Array of values the user can choose from.
`static Object` | `UNINITIALIZED_VALUE` Indicates that the user has not yet selected a value.
`protected Object` | `value` Currently selected value, will be a valid option, or `UNINITIALIZED_VALUE` or `null`.
`static String` | `VALUE_PROPERTY` Bound property name for `value`.
`static String` | `WANTS_INPUT_PROPERTY` Bound property name for `wantsInput`.
`protected boolean` | `wantsInput` If true, a UI widget will be provided to the user to get input.
`static int` | `WARNING_MESSAGE` Used for warning messages.
`static int` | `YES_NO_CANCEL_OPTION` Type used for `showConfirmDialog`.
`static int` | `YES_NO_OPTION` Type used for `showConfirmDialog`.
`static int` | `YES_OPTION` Return value from class method if YES is chosen.

Fields inherited from class javax.swing.JComponent
`accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW`

Fields inherited from class java.awt.Component
`BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT`

Fields inherited from interface java.awt.image.ImageObserver
`ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH`

Constructor Summary
`JOptionPane()` Creates a `JOptionPane` with a test message.
`JOptionPane(Object message)` Creates a instance of `JOptionPane` to display a message using the plain-message message type and the default options delivered by the UI.
`JOptionPane(Object message, int messageType)` Creates an instance of `JOptionPane` to display a message with the specified message type and the default options,
`JOptionPane(Object message, int messageType, int optionType)` Creates an instance of `JOptionPane` to display a message with the specified message type and options.
`JOptionPane(Object message, int messageType, int optionType, Icon icon)` Creates an instance of `JOptionPane` to display a message with the specified message type, options, and icon.
`JOptionPane(Object message, int messageType, int optionType, Icon icon, Object[] options)` Creates an instance of `JOptionPane` to display a message with the specified message type, icon, and options.
`JOptionPane(Object message, int messageType, int optionType, Icon icon, Object[] options, Object initialValue)` Creates an instance of `JOptionPane` to display a message with the specified message type, icon, and options, with the initially-selected option specified.

Method Summary
`JDialog` | `createDialog(Component parentComponent, String title)` Creates and returns a new `JDialog` wrapping `this` centered on the `parentComponent` in the `parentComponent`'s frame.
`JInternalFrame` | `createInternalFrame(Component parentComponent, String title)` Creates and returns an instance of `JInternalFrame`.
`AccessibleContext` | `getAccessibleContext()` Returns the `AccessibleContext` associated with this JOptionPane.
`static JDesktopPane` | `getDesktopPaneForComponent(Component parentComponent)` Returns the specified component's desktop pane.
`static Frame` | `getFrameForComponent(Component parentComponent)` Returns the specified component's `Frame`.
`Icon` | `getIcon()` Returns the icon this pane displays.
`Object` | `getInitialSelectionValue()` Returns the input value that is displayed as initially selected to the user.
`Object` | `getInitialValue()` Returns the initial value.
`Object` | `getInputValue()` Returns the value the user has input, if `wantsInput` is true.
`int` | `getMaxCharactersPerLineCount()` Returns the maximum number of characters to place on a line in a message.
`Object` | `getMessage()` Returns the message-object this pane displays.
`int` | `getMessageType()` Returns the message type.
`Object[]` | `getOptions()` Returns the choices the user can make.
`int` | `getOptionType()` Returns the type of options that are displayed.
`static Frame` | `getRootFrame()` Returns the `Frame` to use for the class methods in which a frame is not provided.
`Object[]` | `getSelectionValues()` Returns the input selection values.
`OptionPaneUI` | `getUI()` Returns the UI object which implements the L&F for this component.
`String` | `getUIClassID()` Returns the name of the UI class that implements the L&F for this component.
`Object` | `getValue()` Returns the value the user has selected.
`boolean` | `getWantsInput()` Returns the value of the `wantsInput` property.
`protected String` | `paramString()` Returns a string representation of this `JOptionPane`.
`void` | `selectInitialValue()` Requests that the initial value be selected, which will set focus to the initial value.
`void` | `setIcon(Icon newIcon)` Sets the icon to display.
`void` | `setInitialSelectionValue(Object newValue)` Sets the input value that is initially displayed as selected to the user.
`void` | `setInitialValue(Object newInitialValue)` Sets the initial value that is to be enabled -- the `Component` that has the focus when the pane is initially displayed.
`void` | `setInputValue(Object newValue)` Sets the input value that was selected or input by the user.
`void` | `setMessage(Object newMessage)` Sets the option pane's message-object.
`void` | `setMessageType(int newType)` Sets the option pane's message type.
`void` | `setOptions(Object[] newOptions)` Sets the options this pane displays.
`void` | `setOptionType(int newType)` Sets the options to display.
`static void` | `setRootFrame(Frame newRootFrame)` Sets the frame to use for class methods in which a frame is not provided.
`void` | `setSelectionValues(Object[] newValues)` Sets the input selection values for a pane that provides the user with a list of items to choose from.
`void` | `setUI(OptionPaneUI ui)` Sets the UI object which implements the L&F for this component.
`void` | `setValue(Object newValue)` Sets the value the user has chosen.
`void` | `setWantsInput(boolean newValue)` Sets the `wantsInput` property.
`static int` | `showConfirmDialog(Component parentComponent, Object message)` Brings up a dialog with the options Yes, No and Cancel; with the title, Select an Option.
`static int` | `showConfirmDialog(Component parentComponent, Object message, String title, int optionType)` Brings up a dialog where the number of choices is determined by the `optionType` parameter.
`static int` | `showConfirmDialog(Component parentComponent, Object message, 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(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon)` Brings up a dialog with a specified icon, where the number of choices is determined by the `optionType` parameter.
`static String` | `showInputDialog(Component parentComponent, Object message)` Shows a question-message dialog requesting input from the user parented to `parentComponent`.
`static String` | `showInputDialog(Component parentComponent, Object message, Object initialSelectionValue)` Shows a question-message dialog requesting input from the user and parented to `parentComponent`.
`static String` | `showInputDialog(Component parentComponent, Object message, String title, int messageType)` Shows a dialog requesting input from the user parented to `parentComponent` with the dialog having the title `title` and message type `messageType`.
`static Object` | `showInputDialog(Component parentComponent, Object message, String title, int messageType, Icon icon, Object[] selectionValues, 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 String` | `showInputDialog(Object message)` Shows a question-message dialog requesting input from the user.
`static String` | `showInputDialog(Object message, Object initialSelectionValue)` Shows a question-message dialog requesting input from the user, with the input value initialized to `initialSelectionValue`.
`static int` | `showInternalConfirmDialog(Component parentComponent, Object message)` Brings up an internal dialog panel with the options Yes, No and Cancel; with the title, Select an Option.
`static int` | `showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType)` Brings up a internal dialog panel where the number of choices is determined by the `optionType` parameter.
`static int` | `showInternalConfirmDialog(Component parentComponent, Object message, 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(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon)` Brings up an internal dialog panel with a specified icon, where the number of choices is determined by the `optionType` parameter.
`static String` | `showInternalInputDialog(Component parentComponent, Object message)` Shows an internal question-message dialog requesting input from the user parented to `parentComponent`.
`static String` | `showInternalInputDialog(Component parentComponent, Object message, 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 Object` | `showInternalInputDialog(Component parentComponent, Object message, String title, int messageType, Icon icon, Object[] selectionValues, 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(Component parentComponent, Object message)` Brings up an internal confirmation dialog panel.
`static void` | `showInternalMessageDialog(Component parentComponent, Object message, 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(Component parentComponent, Object message, String title, int messageType, Icon icon)` Brings up an internal dialog panel displaying a message, specifying all parameters.
`static int` | `showInternalOptionDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon, Object[] options, 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(Component parentComponent, Object message)` Brings up an information-message dialog titled "Message".
`static void` | `showMessageDialog(Component parentComponent, Object message, String title, int messageType)` Brings up a dialog that displays a message using a default icon determined by the `messageType` parameter.
`static void` | `showMessageDialog(Component parentComponent, Object message, String title, int messageType, Icon icon)` Brings up a dialog displaying a message, specifying all parameters.
`static int` | `showOptionDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon, Object[] options, 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.
`void` | `updateUI()` Notification from the `UIManager` that the L&F has changed.

Methods inherited from class javax.swing.JComponent
`addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update`

Methods inherited from class java.awt.Container
`add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree`

Methods inherited from class java.awt.Component
`action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### UNINITIALIZED_VALUE

    public static final Object UNINITIALIZED_VALUE

  Indicates that the user has not yet selected a value.

### DEFAULT_OPTION

    public static final int DEFAULT_OPTION

  Type used for `showConfirmDialog`.

  See Also:
    Constant Field Values

### YES_NO_OPTION

    public static final int YES_NO_OPTION

  Type used for `showConfirmDialog`.

  See Also:
    Constant Field Values

### YES_NO_CANCEL_OPTION

    public static final int YES_NO_CANCEL_OPTION

  Type used for `showConfirmDialog`.

  See Also:
    Constant Field Values

### OK_CANCEL_OPTION

    public static final int OK_CANCEL_OPTION

  Type used for `showConfirmDialog`.

  See Also:
    Constant Field Values

### YES_OPTION

    public static final int YES_OPTION

  Return value from class method if YES is chosen.

  See Also:
    Constant Field Values

### NO_OPTION

    public static final int NO_OPTION

  Return value from class method if NO is chosen.

  See Also:
    Constant Field Values

### CANCEL_OPTION

    public static final int CANCEL_OPTION

  Return value from class method if CANCEL is chosen.

  See Also:
    Constant Field Values

### OK_OPTION

    public static final int OK_OPTION

  Return value form class method if OK is chosen.

  See Also:
    Constant Field Values

### CLOSED_OPTION

    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`.

  See Also:
    Constant Field Values

### ERROR_MESSAGE

    public static final int ERROR_MESSAGE

  Used for error messages.

  See Also:
    Constant Field Values

### INFORMATION_MESSAGE

    public static final int INFORMATION_MESSAGE

  Used for information messages.

  See Also:
    Constant Field Values

### WARNING_MESSAGE

    public static final int WARNING_MESSAGE

  Used for warning messages.

  See Also:
    Constant Field Values

### QUESTION_MESSAGE

    public static final int QUESTION_MESSAGE

  Used for questions.

  See Also:
    Constant Field Values

### PLAIN_MESSAGE

    public static final int PLAIN_MESSAGE

  No icon is used.

  See Also:
    Constant Field Values

### ICON_PROPERTY

    public static final String ICON_PROPERTY

  Bound property name for `icon`.

  See Also:
    Constant Field Values

### MESSAGE_PROPERTY

    public static final String MESSAGE_PROPERTY

  Bound property name for `message`.

  See Also:
    Constant Field Values

### VALUE_PROPERTY

    public static final String VALUE_PROPERTY

  Bound property name for `value`.

  See Also:
    Constant Field Values

### OPTIONS_PROPERTY

    public static final String OPTIONS_PROPERTY

  Bound property name for `option`.

  See Also:
    Constant Field Values

### INITIAL_VALUE_PROPERTY

    public static final String INITIAL_VALUE_PROPERTY

  Bound property name for `initialValue`.

  See Also:
    Constant Field Values

### MESSAGE_TYPE_PROPERTY

    public static final String MESSAGE_TYPE_PROPERTY

  Bound property name for `type`.

  See Also:
    Constant Field Values

### OPTION_TYPE_PROPERTY

    public static final String OPTION_TYPE_PROPERTY

  Bound property name for `optionType`.

  See Also:
    Constant Field Values

### SELECTION_VALUES_PROPERTY

    public static final String SELECTION_VALUES_PROPERTY

  Bound property name for `selectionValues`.

  See Also:
    Constant Field Values

### INITIAL_SELECTION_VALUE_PROPERTY

    public static final String INITIAL_SELECTION_VALUE_PROPERTY

  Bound property name for `initialSelectionValue`.

  See Also:
    Constant Field Values

### INPUT_VALUE_PROPERTY

    public static final String INPUT_VALUE_PROPERTY

  Bound property name for `inputValue`.

  See Also:
    Constant Field Values

### WANTS_INPUT_PROPERTY

    public static final String WANTS_INPUT_PROPERTY

  Bound property name for `wantsInput`.

  See Also:
    Constant Field Values

### icon

    protected transient Icon icon

  Icon used in pane.

### message

    protected transient Object message

  Message to display.

### options

    protected transient Object[] options

  Options to display to the user.

### initialValue

    protected transient Object initialValue

  Value that should be initially selected in `options`.

### messageType

    protected int messageType

  Message type.

### optionType

    protected int optionType

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

### value

    protected transient Object value

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

### selectionValues

    protected transient Object[] selectionValues

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

### inputValue

    protected transient Object inputValue

  Value the user has input.

### initialSelectionValue

    protected transient Object initialSelectionValue

  Initial value to select in `selectionValues`.

### wantsInput

    protected boolean wantsInput

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

Constructor Detail

### JOptionPane

    public JOptionPane()

  Creates a `JOptionPane` with a test message.

### JOptionPane

    public JOptionPane(Object 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

### JOptionPane

    public JOptionPane(Object message,
                       int messageType)

  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`

### JOptionPane

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

  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`

### JOptionPane

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

  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

### JOptionPane

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

  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 `Component`s, (which are added directly) or `Strings` (which are wrapped in a `JButton`). If you provide `Component`s, 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

### JOptionPane

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

  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

Method Detail

### showInputDialog

    public static String showInputDialog(Object message)
                                  throws HeadlessException

  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
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showInputDialog

    public static String showInputDialog(Object message,
                                         Object initialSelectionValue)

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

  Parameters:
    `message` - the `Object` to display
    `initialSelectionValue` - the value used to initialize the input field

### showInputDialog

    public static String showInputDialog(Component parentComponent,
                                         Object message)
                                  throws HeadlessException

  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
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showInputDialog

    public static String showInputDialog(Component parentComponent,
                                         Object message,
                                         Object initialSelectionValue)

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

  Parameters:
    `parentComponent` - the parent `Component` for the dialog
    `message` - the `Object` to display
    `initialSelectionValue` - the value used to initialize the input field

### showInputDialog

    public static String showInputDialog(Component parentComponent,
                                         Object message,
                                         String title,
                                         int messageType)
                                  throws HeadlessException

  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`
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showInputDialog

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

  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 `Object`s 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
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showMessageDialog

    public static void showMessageDialog(Component parentComponent,
                                         Object message)
                                  throws HeadlessException

  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
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showMessageDialog

    public static void showMessageDialog(Component parentComponent,
                                         Object message,
                                         String title,
                                         int messageType)
                                  throws HeadlessException

  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`
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showMessageDialog

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

  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
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showConfirmDialog

    public static int showConfirmDialog(Component parentComponent,
                                        Object message)
                                 throws HeadlessException

  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
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showConfirmDialog

    public static int showConfirmDialog(Component parentComponent,
                                        Object message,
                                        String title,
                                        int optionType)
                                 throws HeadlessException

  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`, or `YES_NO_CANCEL_OPTION`
  Returns:
    an int indicating the option selected by the user
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showConfirmDialog

    public static int showConfirmDialog(Component parentComponent,
                                        Object message,
                                        String title,
                                        int optionType,
                                        int messageType)
                                 throws HeadlessException

  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`, 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
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showConfirmDialog

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

  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`, or `YES_NO_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
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showOptionDialog

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

  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: `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
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### createDialog

    public JDialog createDialog(Component parentComponent,
                                String title)
                         throws HeadlessException

  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.

  Parameters:
    `parentComponent` - determines the frame in which the dialog is displayed; if the `parentComponent` has no `Frame`, a default `Frame` is used
    `title` - the title string for the dialog
  Returns:
    a new `JDialog` containing this instance
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### showInternalMessageDialog

    public static void showInternalMessageDialog(Component parentComponent,
                                                 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(Component parentComponent,
                                                 Object message,
                                                 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(Component parentComponent,
                                                 Object message,
                                                 String title,
                                                 int messageType,
                                                 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

### showInternalConfirmDialog

    public static int showInternalConfirmDialog(Component parentComponent,
                                                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(Component parentComponent,
                                                Object message,
                                                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(Component parentComponent,
                                                Object message,
                                                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(Component parentComponent,
                                                Object message,
                                                String title,
                                                int optionType,
                                                int messageType,
                                                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

### showInternalOptionDialog

    public static int showInternalOptionDialog(Component parentComponent,
                                               Object message,
                                               String title,
                                               int optionType,
                                               int messageType,
                                               Icon icon,
                                               Object[] options,
                                               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

### showInternalInputDialog

    public static String showInternalInputDialog(Component parentComponent,
                                                 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

### showInternalInputDialog

    public static String showInternalInputDialog(Component parentComponent,
                                                 Object message,
                                                 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

### showInternalInputDialog

    public static Object showInternalInputDialog(Component parentComponent,
                                                 Object message,
                                                 String title,
                                                 int messageType,
                                                 Icon icon,
                                                 Object[] selectionValues,
                                                 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

### createInternalFrame

    public JInternalFrame createInternalFrame(Component parentComponent,
                                              String title)

  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.

  Parameters:
    `parentComponent` - the parent `Component` for the internal frame
    `title` - the `String` to display in the frame's title bar
  Returns:
    a `JInternalFrame` containing a `JOptionPane`
  Throws:
    `RuntimeException` - if `parentComponent` does not have a valid parent

### getFrameForComponent

    public static Frame getFrameForComponent(Component parentComponent)
                                      throws HeadlessException

  Returns the specified component's `Frame`.

  Parameters:
    `parentComponent` - the `Component` to check for a `Frame`
  Returns:
    the `Frame` that contains the component, or the default frame if the component is `null`, or does not have a valid `Frame` parent
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### getDesktopPaneForComponent

    public static JDesktopPane getDesktopPaneForComponent(Component parentComponent)

  Returns the specified component's desktop pane.

  Parameters:
    `parentComponent` - the `Component` to check for a desktop
  Returns:
    the `JDesktopPane` that contains the component, or `null` if the component is `null` or does not have an ancestor that is a `JInternalFrame`

### setRootFrame

    public static void setRootFrame(Frame newRootFrame)

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

  Parameters:
    `newRootFrame` - the default `Frame` to use

### getRootFrame

    public static Frame getRootFrame()
                              throws HeadlessException

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

  Returns:
    the default `Frame` to use
  Throws:
    `HeadlessException` - if `GraphicsEnvironment.isHeadless` returns `true`
  See Also:
    `GraphicsEnvironment.isHeadless()`

### setUI

    public void setUI(OptionPaneUI ui)

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

  Parameters:
    `ui` - the `OptionPaneUI` L&F object
  See Also:
    `UIDefaults.getUI(javax.swing.JComponent)`

### getUI

    public OptionPaneUI getUI()

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

  Returns:
    the `OptionPaneUI` object

### updateUI

    public void updateUI()

  Notification from the `UIManager` that the L&F has changed. Replaces the current UI object with the latest version from the `UIManager`.

  Overrides:
    `updateUI` in class `JComponent`
  See Also:
    `JComponent.updateUI()`

### getUIClassID

    public String getUIClassID()

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

  Overrides:
    `getUIClassID` in class `JComponent`
  Returns:
    the string "OptionPaneUI"
  See Also:
    `JComponent.getUIClassID()`, `UIDefaults.getUI(javax.swing.JComponent)`

### setMessage

    public void setMessage(Object newMessage)

  Sets the option pane's message-object.

  Parameters:
    `newMessage` - the `Object` to display
  See Also:
    `getMessage()`

### getMessage

    public Object getMessage()

  Returns the message-object this pane displays.

  Returns:
    the `Object` that is displayed
  See Also:
    `setMessage(java.lang.Object)`

### setIcon

    public void setIcon(Icon newIcon)

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

  See Also:
    `getIcon()`

### getIcon

    public Icon getIcon()

  Returns the icon this pane displays.

  Returns:
    the `Icon` that is displayed
  See Also:
    `setIcon(javax.swing.Icon)`

### setValue

    public void setValue(Object newValue)

  Sets the value the user has chosen.

  Parameters:
    `newValue` - the chosen value
  See Also:
    `getValue()`

### getValue

    public Object getValue()

  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.

  Returns:
    the `Object` chosen by the user, `UNINITIALIZED_VALUE` if the user has not yet made a choice, or `null` if the user closed the window without making a choice
  See Also:
    `setValue(java.lang.Object)`

### setOptions

    public void setOptions(Object[] newOptions)

  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.

  Parameters:
    `newOptions` - an array of `Objects` that create the buttons the user can click on, or arbitrary `Components` to add to the pane
  See Also:
    `getOptions()`

### getOptions

    public Object[] getOptions()

  Returns the choices the user can make.

  Returns:
    the array of `Objects` that give the user's choices
  See Also:
    `setOptions(java.lang.Object[])`

### setInitialValue

    public void setInitialValue(Object newInitialValue)

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

  Parameters:
    `newInitialValue` - the `Object` that gets the initial keyboard focus
  See Also:
    `getInitialValue()`

### getInitialValue

    public Object getInitialValue()

  Returns the initial value.

  Returns:
    the `Object` that gets the initial keyboard focus
  See Also:
    `setInitialValue(java.lang.Object)`

### setMessageType

    public void setMessageType(int newType)

  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`.

  Parameters:
    `newType` - an integer specifying the kind of message to display: `ERROR_MESSAGE`, `INFORMATION_MESSAGE`, `WARNING_MESSAGE`, `QUESTION_MESSAGE`, or `PLAIN_MESSAGE`
  Throws:
    `RuntimeException` - if `newType` is not one of the legal values listed above
  See Also:
    `getMessageType()`

### getMessageType

    public int getMessageType()

  Returns the message type.

  Returns:
    an integer specifying the message type
  See Also:
    `setMessageType(int)`

### setOptionType

    public void setOptionType(int newType)

  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).

  Parameters:
    `newType` - an integer specifying the options the L&F is to display: `DEFAULT_OPTION`, `YES_NO_OPTION`, `YES_NO_CANCEL_OPTION`, or `OK_CANCEL_OPTION`
  Throws:
    `RuntimeException` - if `newType` is not one of the legal values listed above
  See Also:
    `getOptionType()`, `setOptions(java.lang.Object[])`

### getOptionType

    public int getOptionType()

  Returns the type of options that are displayed.

  Returns:
    an integer specifying the user-selectable options
  See Also:
    `setOptionType(int)`

### setSelectionValues

    public void setSelectionValues(Object[] newValues)

  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.

  Parameters:
    `newValues` - an array of `Objects` the user to be displayed (usually in a list or combo-box) from which the user can make a selection
  See Also:
    `setWantsInput(boolean)`, `setInitialSelectionValue(java.lang.Object)`, `getSelectionValues()`

### getSelectionValues

    public Object[] getSelectionValues()

  Returns the input selection values.

  Returns:
    the array of `Objects` the user can select
  See Also:
    `setSelectionValues(java.lang.Object[])`

### setInitialSelectionValue

    public void setInitialSelectionValue(Object newValue)

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

  Parameters:
    `newValue` - the initially selected value
  See Also:
    `setSelectionValues(java.lang.Object[])`, `getInitialSelectionValue()`

### getInitialSelectionValue

    public Object getInitialSelectionValue()

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

  Returns:
    the initially selected value
  See Also:
    `setInitialSelectionValue(java.lang.Object)`, `setSelectionValues(java.lang.Object[])`

### setInputValue

    public void setInputValue(Object 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`.

  Parameters:
    `newValue` - the `Object` used to set the value that the user specified (usually in a text field)
  See Also:
    `setSelectionValues(java.lang.Object[])`, `setInitialSelectionValue(java.lang.Object)`, `setWantsInput(boolean)`, `getInputValue()`

### getInputValue

    public Object getInputValue()

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

  Returns:
    the `Object` the user specified, if it was one of the objects, or a `String` if it was a value typed into a field
  See Also:
    `setSelectionValues(java.lang.Object[])`, `setWantsInput(boolean)`, `setInputValue(java.lang.Object)`

### getMaxCharactersPerLineCount

    public int getMaxCharactersPerLineCount()

  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.

  Returns:
    an integer giving the maximum number of characters on a line

### setWantsInput

    public void setWantsInput(boolean 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.

  See Also:
    `setSelectionValues(java.lang.Object[])`, `setInputValue(java.lang.Object)`

### getWantsInput

    public boolean getWantsInput()

  Returns the value of the `wantsInput` property.

  Returns:
    true if an input component will be provided
  See Also:
    `setWantsInput(boolean)`

### selectInitialValue

    public void selectInitialValue()

  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.

### paramString

    protected String paramString()

  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`.

  Overrides:
    `paramString` in class `JComponent`
  Returns:
    a string representation of this `JOptionPane`

### getAccessibleContext

    public AccessibleContext getAccessibleContext()

  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.

  Specified by:
    `getAccessibleContext` in interface `Accessible`
  Overrides:
    `getAccessibleContext` in class `JComponent`
  Returns:
    an AccessibleJOptionPane that serves as the AccessibleContext of this AccessibleJOptionPane

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.