Class JOptionPane

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JOptionPane
All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,Accessible
@JavaBean(defaultProperty="UI",description="A component which implements standard dialog box controls.")public classJOptionPaneextendsJComponentimplementsAccessible
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 usingJOptionPane, seeHow to Make Dialogs, a section inThe Java Tutorial.

While theJOptionPane 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 staticshowXxxDialog methods shown below:

Common JOptionPane method names and their descriptions
Method NameDescription
showConfirmDialogAsks a confirming question, like yes/no/cancel.
showInputDialogPrompt for some input.
showMessageDialogTell the user about something that has happened.
showOptionDialogThe Grand Unification of the above three.
Each of these methods also comes in ashowInternalXXX flavor, which uses an internal frame to hold the dialog box (seeJInternalFrame). Multiple convenience methods have also been defined -- overloaded versions of the basic methods that use different parameter lists.

All dialogs are modal. EachshowXxxDialog method blocks the caller until the user's interaction is complete.

Common dialog
iconmessage
input value
option buttons
The basic appearance of one of these dialog boxes is generally similar to the picture above, 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'sComponentOrientation property.

Parameters:
The parameters to these methods follow consistent patterns:

parentComponent
Defines theComponent that is to be the parent of this dialog box. It is used in two ways: theFrame that contains it is used as theFrame 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 benull, in which case a defaultFrame 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 aString orString constant. However, the type of this parameter is actuallyObject. 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
TheComponent is displayed in the dialog.
Icon
TheIcon is wrapped in aJLabel and displayed in the dialog.
others
The object is converted to aString by calling itstoString method. The result is wrapped in aJLabel 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 ofStrings. But the parameter type is an array ofObjects. A button is created for each object depending on its type:
Component
The component is added to the button row directly.
Icon
AJButton is created with this as its label.
other
TheObject is converted to a string using itstoString method and the result is used to label aJButton.
icon
A decorative icon to be placed in the dialog box. A default value for this is determined by themessageType parameter.
title
The title for the dialog box.
initialValue
The default selection (input value).

When the selection is changed,setValue is invoked, which generates aPropertyChangeEvent.

If aJOptionPane has configured to all inputsetWantsInput the bound propertyJOptionPane.INPUT_VALUE_PROPERTY can also be listened to, to determine when the user has input or selected a value.

When one of theshowXxxDialog 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 anJOptionPane directly, the standard pattern is roughly as follows:
     JOptionPane pane = new JOptionPane(arguments);     pane.set.Xxxx(...); // Configure     JDialog dialog = pane.createDialog(parentComponent, title);     dialog.setVisible(true);     Object selectedValue = pane.getValue();     if(selectedValue == null)       return CLOSED_OPTION;//If there isnot 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;

Warning: Swing is not thread safe. For more information seeSwing's Threading Policy.

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 has been added to thejava.beans package. Please seeXMLEncoder.

Since:
1.2
See Also:

  • Field Details

    • 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 meaning Look and Feel should not supply any options -- only use the options from theJOptionPane.
      See Also:

    • YES_NO_OPTION

      public static final int YES_NO_OPTION
      Type used forshowConfirmDialog.
      See Also:

    • YES_NO_CANCEL_OPTION

      public static final int YES_NO_CANCEL_OPTION
      Type used forshowConfirmDialog.
      See Also:

    • OK_CANCEL_OPTION

      public static final int OK_CANCEL_OPTION
      Type used forshowConfirmDialog.
      See Also:

    • YES_OPTION

      public static final int YES_OPTION
      Return value from class method if YES is chosen.
      See Also:

    • NO_OPTION

      public static final int NO_OPTION
      Return value from class method if NO is chosen.
      See Also:

    • CANCEL_OPTION

      public static final int CANCEL_OPTION
      Return value from class method if CANCEL is chosen.
      See Also:

    • OK_OPTION

      public static final int OK_OPTION
      Return value from class method if OK is chosen.
      See Also:

    • 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 aCANCEL_OPTION orNO_OPTION.
      See Also:

    • ERROR_MESSAGE

      public static final int ERROR_MESSAGE
      Used for error messages.
      See Also:

    • INFORMATION_MESSAGE

      public static final int INFORMATION_MESSAGE
      Used for information messages.
      See Also:

    • WARNING_MESSAGE

      public static final int WARNING_MESSAGE
      Used for warning messages.
      See Also:

    • QUESTION_MESSAGE

      public static final int QUESTION_MESSAGE
      Used for questions.
      See Also:

    • PLAIN_MESSAGE

      public static final int PLAIN_MESSAGE
      No icon is used.
      See Also:

    • ICON_PROPERTY

      public static final String ICON_PROPERTY
      Bound property name foricon.
      See Also:

    • MESSAGE_PROPERTY

      public static final String MESSAGE_PROPERTY
      Bound property name formessage.
      See Also:

    • VALUE_PROPERTY

      public static final String VALUE_PROPERTY
      Bound property name forvalue.
      See Also:

    • OPTIONS_PROPERTY

      public static final String OPTIONS_PROPERTY
      Bound property name foroption.
      See Also:

    • INITIAL_VALUE_PROPERTY

      public static final String INITIAL_VALUE_PROPERTY
      Bound property name forinitialValue.
      See Also:

    • MESSAGE_TYPE_PROPERTY

      public static final String MESSAGE_TYPE_PROPERTY
      Bound property name fortype.
      See Also:

    • OPTION_TYPE_PROPERTY

      public static final String OPTION_TYPE_PROPERTY
      Bound property name foroptionType.
      See Also:

    • SELECTION_VALUES_PROPERTY

      public static final String SELECTION_VALUES_PROPERTY
      Bound property name forselectionValues.
      See Also:

    • INITIAL_SELECTION_VALUE_PROPERTY

      public static final String INITIAL_SELECTION_VALUE_PROPERTY
      Bound property name forinitialSelectionValue.
      See Also:

    • INPUT_VALUE_PROPERTY

      public static final String INPUT_VALUE_PROPERTY
      Bound property name forinputValue.
      See Also:

    • WANTS_INPUT_PROPERTY

      public static final String WANTS_INPUT_PROPERTY
      Bound property name forwantsInput.
      See Also:

    • 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 inoptions.

    • messageType

      protected int messageType
      Message type.

    • optionType

      protected int optionType
      Option type, one ofDEFAULT_OPTION,YES_NO_OPTION,YES_NO_CANCEL_OPTION orOK_CANCEL_OPTION.

    • value

      protected transient Object value
      Currently selected value, will be a valid option, orUNINITIALIZED_VALUE ornull.

    • 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 inselectionValues.

    • wantsInput

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

  • Constructor Details

    • JOptionPane

      public JOptionPane()
      Creates aJOptionPane with a test message.

    • JOptionPane

      public JOptionPane(Object message)
      Creates a instance ofJOptionPane to display a message using the plain-message message type and the default options delivered by the UI.
      Parameters:
      message - theObject to display

    • JOptionPane

      public JOptionPane(Object message, int messageType)
      Creates an instance ofJOptionPane to display a message with the specified message type and the default options,
      Parameters:
      message - theObject to display
      messageType - the type of message to be displayed:ERROR_MESSAGE,INFORMATION_MESSAGE,WARNING_MESSAGE,QUESTION_MESSAGE, orPLAIN_MESSAGE

    • JOptionPane

      public JOptionPane(Object message, int messageType, int optionType)
      Creates an instance ofJOptionPane to display a message with the specified message type and options.
      Parameters:
      message - theObject to display
      messageType - the type of message to be displayed:ERROR_MESSAGE,INFORMATION_MESSAGE,WARNING_MESSAGE,QUESTION_MESSAGE, orPLAIN_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 ofJOptionPane to display a message with the specified message type, options, and icon.
      Parameters:
      message - theObject to display
      messageType - the type of message to be displayed:ERROR_MESSAGE,INFORMATION_MESSAGE,WARNING_MESSAGE,QUESTION_MESSAGE, orPLAIN_MESSAGE
      optionType - the options to display in the pane:DEFAULT_OPTION,YES_NO_OPTION,YES_NO_CANCEL_OPTION,OK_CANCEL_OPTION
      icon - theIcon image to display

    • JOptionPane

      public JOptionPane(Object message, int messageType, int optionType,Icon icon,Object[] options)
      Creates an instance ofJOptionPane 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 ofComponents, (which are added directly) orStrings (which are wrapped in aJButton). If you provideComponents, you must ensure that when theComponent is clicked it messagessetValue in the createdJOptionPane.

      Parameters:
      message - theObject to display
      messageType - the type of message to be displayed:ERROR_MESSAGE,INFORMATION_MESSAGE,WARNING_MESSAGE,QUESTION_MESSAGE, orPLAIN_MESSAGE
      optionType - the options to display in the pane:DEFAULT_OPTION,YES_NO_OPTION,YES_NO_CANCEL_OPTION,OK_CANCEL_OPTION
      icon - theIcon 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 ofJOptionPane to display a message with the specified message type, icon, and options, with the initially-selected option specified.
      Parameters:
      message - theObject to display
      messageType - the type of message to be displayed:ERROR_MESSAGE,INFORMATION_MESSAGE,WARNING_MESSAGE,QUESTION_MESSAGE, orPLAIN_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; ifnull, then nothing will be initially selected; only meaningful ifoptions is used

  • Method Details

    • showInputDialog

      public static String showInputDialog(Object message) throwsHeadlessException
      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 - theObject to display
      Returns:
      user's input
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • showInputDialog

      public static String showInputDialog(Object message,Object initialSelectionValue)
      Shows a question-message dialog requesting input from the user, with the input value initialized toinitialSelectionValue. The dialog uses the default frame, which usually means it is centered on the screen.
      Parameters:
      message - theObject to display
      initialSelectionValue - the value used to initialize the input field
      Returns:
      user's input
      Since:
      1.4

    • showInputDialog

      public static String showInputDialog(Component parentComponent,Object message) throwsHeadlessException
      Shows a question-message dialog requesting input from the user parented toparentComponent. The dialog is displayed on top of theComponent's frame, and is usually positioned below theComponent.
      Parameters:
      parentComponent - the parentComponent for the dialog
      message - theObject to display
      Returns:
      user's input
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • showInputDialog

      public static String showInputDialog(Component parentComponent,Object message,Object initialSelectionValue)
      Shows a question-message dialog requesting input from the user and parented toparentComponent. The input value will be initialized toinitialSelectionValue. The dialog is displayed on top of theComponent's frame, and is usually positioned below theComponent.
      Parameters:
      parentComponent - the parentComponent for the dialog
      message - theObject to display
      initialSelectionValue - the value used to initialize the input field
      Returns:
      user's input
      Since:
      1.4

    • showInputDialog

      public static String showInputDialog(Component parentComponent,Object message,String title, int messageType) throwsHeadlessException
      Shows a dialog requesting input from the user parented toparentComponent with the dialog having the titletitle and message typemessageType.
      Parameters:
      parentComponent - the parentComponent for the dialog
      message - theObject to display
      title - theString 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, orPLAIN_MESSAGE
      Returns:
      user's input
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • showInputDialog

      public static Object showInputDialog(Component parentComponent,Object message,String title, int messageType,Icon icon,Object[] selectionValues,Object initialSelectionValue) throwsHeadlessException
      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 fromselectionValues, wherenull implies the user can input whatever they wish, usually by means of aJTextField.initialSelectionValue is the initial value to prompt the user with. It is up to the UI to decide how best to represent theselectionValues, but usually aJComboBox,JList, orJTextField will be used.
      Parameters:
      parentComponent - the parentComponent for the dialog
      message - theObject to display
      title - theString to display in the dialog title bar
      messageType - the type of message to be displayed:ERROR_MESSAGE,INFORMATION_MESSAGE,WARNING_MESSAGE,QUESTION_MESSAGE, orPLAIN_MESSAGE
      icon - theIcon image to display
      selectionValues - an array ofObjects that gives the possible selections
      initialSelectionValue - the value used to initialize the input field
      Returns:
      user's input, ornull meaning the user canceled the input
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • showMessageDialog

      public static void showMessageDialog(Component parentComponent,Object message) throwsHeadlessException
      Brings up an information-message dialog titled "Message".
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - theObject to display
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • showMessageDialog

      public static void showMessageDialog(Component parentComponent,Object message,String title, int messageType) throwsHeadlessException
      Brings up a dialog that displays a message using a default icon determined by themessageType parameter.
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - theObject 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, orPLAIN_MESSAGE
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • showMessageDialog

      public static void showMessageDialog(Component parentComponent,Object message,String title, int messageType,Icon icon) throwsHeadlessException
      Brings up a dialog displaying a message, specifying all parameters.
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - theObject 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, orPLAIN_MESSAGE
      icon - an icon to display in the dialog that helps the user identify the kind of message that is being displayed
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • showConfirmDialog

      public static int showConfirmDialog(Component parentComponent,Object message) throwsHeadlessException
      Brings up a dialog with the optionsYes,No andCancel; with the title,Select an Option.
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - theObject to display
      Returns:
      an integer indicating the option selected by the user
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • showConfirmDialog

      public static int showConfirmDialog(Component parentComponent,Object message,String title, int optionType) throwsHeadlessException
      Brings up a dialog where the number of choices is determined by theoptionType parameter.
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - theObject to display
      title - the title string for the dialog
      optionType - an int designating the options available on the dialog:YES_NO_OPTION,YES_NO_CANCEL_OPTION, orOK_CANCEL_OPTION
      Returns:
      an int indicating the option selected by the user
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • showConfirmDialog

      public static int showConfirmDialog(Component parentComponent,Object message,String title, int optionType, int messageType) throwsHeadlessException
      Brings up a dialog where the number of choices is determined by theoptionType parameter, where themessageType parameter determines the icon to display. ThemessageType parameter is primarily used to supply a default icon from the Look and Feel.
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used.
      message - theObject to display
      title - the title string for the dialog
      optionType - an integer designating the options available on the dialog:YES_NO_OPTION,YES_NO_CANCEL_OPTION, orOK_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, orPLAIN_MESSAGE
      Returns:
      an integer indicating the option selected by the user
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • showConfirmDialog

      public static int showConfirmDialog(Component parentComponent,Object message,String title, int optionType, int messageType,Icon icon) throwsHeadlessException
      Brings up a dialog with a specified icon, where the number of choices is determined by theoptionType parameter. ThemessageType parameter is primarily used to supply a default icon from the look and feel.
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - the Object to display
      title - the title string for the dialog
      optionType - an int designating the options available on the dialog:YES_NO_OPTION,YES_NO_CANCEL_OPTION, orOK_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, orPLAIN_MESSAGE
      icon - the icon to display in the dialog
      Returns:
      an int indicating the option selected by the user
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • showOptionDialog

      public static int showOptionDialog(Component parentComponent,Object message,String title, int optionType, int messageType,Icon icon,Object[] options,Object initialValue) throwsHeadlessException
      Brings up a dialog with a specified icon, where the initial choice is determined by theinitialValue parameter and the number of choices is determined by theoptionType parameter.

      IfoptionType isYES_NO_OPTION, orYES_NO_CANCEL_OPTION and theoptions parameter isnull, then the options are supplied by the look and feel.

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

      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - theObject to display
      title - the title string for the dialog
      optionType - an integer designating the options available on the dialog:DEFAULT_OPTION,YES_NO_OPTION,YES_NO_CANCEL_OPTION, orOK_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, orPLAIN_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 theirtoString methods; if this parameter isnull, the options are determined by the Look and Feel
      initialValue - the object that represents the default selection for the dialog; only meaningful ifoptions is used; can benull
      Returns:
      an integer indicating the option chosen by the user, orCLOSED_OPTION if the user closed the dialog
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • createDialog

      public JDialog createDialog(Component parentComponent,String title) throwsHeadlessException
      Creates and returns a newJDialog wrappingthis centered on theparentComponent in theparentComponent's frame.title is the title of the returned dialog. The returnedJDialog will not be resizable by the user, however programs can invokesetResizable on theJDialog instance to change this property. The returnedJDialog 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 toJOptionPane.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 theparentComponent has noFrame, a defaultFrame is used
      title - the title string for the dialog
      Returns:
      a newJDialog containing this instance
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • createDialog

      public JDialog createDialog(String title) throwsHeadlessException
      Creates and returns a new parentlessJDialog with the specified title. The returnedJDialog will not be resizable by the user, however programs can invokesetResizable on theJDialog instance to change this property. The returnedJDialog 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 toJOptionPane.UNINITIALIZED_VALUE to ensure the user's subsequent action closes the dialog properly.
      Parameters:
      title - the title string for the dialog
      Returns:
      a newJDialog containing this instance
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      Since:
      1.6
      See Also:

    • 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 theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame 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 themessageType parameter.
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - theObject 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, orPLAIN_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 theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - theObject 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, orPLAIN_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 optionsYes,No andCancel; with the title,Select an Option.
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - theObject 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 theoptionType parameter.
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - the object to display in the dialog; aComponent object is rendered as aComponent; aString object is rendered as a string; other objects are converted to aString using thetoString method
      title - the title string for the dialog
      optionType - an integer designating the options available on the dialog:YES_NO_OPTION, orYES_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 theoptionType parameter, where themessageType parameter determines the icon to display. ThemessageType parameter is primarily used to supply a default icon from the Look and Feel.
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - the object to display in the dialog; aComponent object is rendered as aComponent; aString object is rendered as a string; other objects are converted to aString using thetoString method
      title - the title string for the dialog
      optionType - an integer designating the options available on the dialog:YES_NO_OPTION, orYES_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, orPLAIN_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 theoptionType parameter. ThemessageType parameter is primarily used to supply a default icon from the look and feel.
      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if the parentComponent has no Frame, a defaultFrame is used
      message - the object to display in the dialog; aComponent object is rendered as aComponent; aString object is rendered as a string; other objects are converted to aString using thetoString method
      title - the title string for the dialog
      optionType - an integer designating the options available on the dialog:YES_NO_OPTION, orYES_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, orPLAIN_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 theinitialValue parameter and the number of choices is determined by theoptionType parameter.

      IfoptionType isYES_NO_OPTION, orYES_NO_CANCEL_OPTION and theoptions parameter isnull, then the options are supplied by the Look and Feel.

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

      Parameters:
      parentComponent - determines theFrame in which the dialog is displayed; ifnull, or if theparentComponent has noFrame, a defaultFrame is used
      message - the object to display in the dialog; aComponent object is rendered as aComponent; aString object is rendered as a string. Other objects are converted to aString using thetoString method
      title - the title string for the dialog
      optionType - an integer designating the options available on the dialog:YES_NO_OPTION, orYES_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, orPLAIN_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 theirtoString methods; if this parameter isnull, the options are determined by the Look and Feel
      initialValue - the object that represents the default selection for the dialog; only meaningful ifoptions is used; can benull
      Returns:
      an integer indicating the option chosen by the user, orCLOSED_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 toparentComponent. The dialog is displayed in theComponent's frame, and is usually positioned below theComponent.
      Parameters:
      parentComponent - the parentComponent for the dialog
      message - theObject to display
      Returns:
      user's input

    • showInternalInputDialog

      public static String showInternalInputDialog(Component parentComponent,Object message,String title, int messageType)
      Shows an internal dialog requesting input from the user parented toparentComponent with the dialog having the titletitle and message typemessageType.
      Parameters:
      parentComponent - the parentComponent for the dialog
      message - theObject to display
      title - theString to display in the dialog title bar
      messageType - the type of message that is to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE
      Returns:
      user's input

    • 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 fromselectionValues, wherenull implies the user can input whatever they wish, usually by means of aJTextField.initialSelectionValue is the initial value to prompt the user with. It is up to the UI to decide how best to represent theselectionValues, but usually aJComboBox,JList, orJTextField will be used.
      Parameters:
      parentComponent - the parentComponent for the dialog
      message - theObject to display
      title - theString to display in the dialog title bar
      messageType - the type of message to be displayed:ERROR_MESSAGE,INFORMATION_MESSAGE,WARNING_MESSAGE,QUESTION_MESSAGE, orPLAIN_MESSAGE
      icon - theIcon image to display
      selectionValues - an array ofObjects that gives the possible selections
      initialSelectionValue - the value used to initialize the input field
      Returns:
      user's input, ornull meaning the user canceled the input

    • createInternalFrame

      public JInternalFrame createInternalFrame(Component parentComponent,String title)
      Creates and returns an instance ofJInternalFrame. The internal frame is created with the specified title, and wrapping theJOptionPane. The returnedJInternalFrame is added to theJDesktopPane ancestor ofparentComponent, or components parent if one its ancestors isn't aJDesktopPane, or ifparentComponent doesn't have a parent then aRuntimeException is thrown.
      Parameters:
      parentComponent - the parentComponent for the internal frame
      title - theString to display in the frame's title bar
      Returns:
      aJInternalFrame containing aJOptionPane
      Throws:
      RuntimeException - ifparentComponent does not have a valid parent

    • getFrameForComponent

      public static Frame getFrameForComponent(Component parentComponent) throwsHeadlessException
      Returns the specified component'sFrame.
      Parameters:
      parentComponent - theComponent to check for aFrame
      Returns:
      theFrame that contains the component, orgetRootFrame if the component isnull, or does not have a validFrame parent
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • getDesktopPaneForComponent

      public static JDesktopPane getDesktopPaneForComponent(Component parentComponent)
      Returns the specified component's desktop pane.
      Parameters:
      parentComponent - theComponent to check for a desktop
      Returns:
      theJDesktopPane that contains the component, ornull if the component isnull or does not have an ancestor that is aJInternalFrame

    • setRootFrame

      public static void setRootFrame(Frame newRootFrame)
      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.

      Parameters:
      newRootFrame - the defaultFrame to use

    • getRootFrame

      public static Frame getRootFrame() throwsHeadlessException
      Returns theFrame to use for the class methods in which a frame is not provided.
      Returns:
      the defaultFrame to use
      Throws:
      HeadlessException - ifGraphicsEnvironment.isHeadless returnstrue
      See Also:

    • setUI

      @BeanProperty(hidden=true,description="The UI object that implements the optionpane's LookAndFeel")public void setUI(OptionPaneUI ui)
      Sets the UI object which implements the L&F for this component.
      Parameters:
      ui - theOptionPaneUI L&F object
      See Also:

    • getUI

      public OptionPaneUI getUI()
      Returns the UI object which implements the L&F for this component.
      Overrides:
      getUI in class JComponent
      Returns:
      theOptionPaneUI object

    • updateUI

      public void updateUI()
      Notification from theUIManager that the L&F has changed. Replaces the current UI object with the latest version from theUIManager.
      Overrides:
      updateUI in class JComponent
      See Also:

    • getUIClassID

      @BeanProperty(bound=false)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:

    • setMessage

      @BeanProperty(preferred=true,description="The optionpane's message object.")public void setMessage(Object newMessage)
      Sets the option pane's message-object.
      Parameters:
      newMessage - theObject to display
      See Also:

    • getMessage

      public Object getMessage()
      Returns the message-object this pane displays.
      Returns:
      theObject that is displayed
      See Also:

    • setIcon

      @BeanProperty(preferred=true,description="The option pane's type icon.")public void setIcon(Icon newIcon)
      Sets the icon to display. If non-null, the look and feel does not provide an icon.
      Parameters:
      newIcon - theIcon to display
      See Also:

    • getIcon

      public Icon getIcon()
      Returns the icon this pane displays.
      Returns:
      theIcon that is displayed
      See Also:

    • setValue

      @BeanProperty(preferred=true,description="The option pane's value object.")public void setValue(Object newValue)
      Sets the value the user has chosen.
      Parameters:
      newValue - the chosen value
      See Also:

    • 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:
      theObject chosen by the user,UNINITIALIZED_VALUE if the user has not yet made a choice, ornull if the user closed the window without making a choice
      See Also:

    • setOptions

      @BeanProperty(description="The option pane's options objects.")public void setOptions(Object[] newOptions)
      Sets the options this pane displays. If an element innewOptions is aComponent it is added directly to the pane, otherwise a button is created for the element.
      Parameters:
      newOptions - an array ofObjects that create the buttons the user can click on, or arbitraryComponents to add to the pane
      See Also:

    • getOptions

      public Object[] getOptions()
      Returns the choices the user can make.
      Returns:
      the array ofObjects that give the user's choices
      See Also:

    • setInitialValue

      @BeanProperty(preferred=true,description="The option pane's initial value object.")public void setInitialValue(Object newInitialValue)
      Sets the initial value that is to be enabled -- theComponent that has the focus when the pane is initially displayed.
      Parameters:
      newInitialValue - theObject that gets the initial keyboard focus
      See Also:

    • getInitialValue

      public Object getInitialValue()
      Returns the initial value.
      Returns:
      theObject that gets the initial keyboard focus
      See Also:

    • setMessageType

      @BeanProperty(preferred=true,description="The option pane's message type.")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 theparentComponent.
      Parameters:
      newType - an integer specifying the kind of message to display:ERROR_MESSAGE,INFORMATION_MESSAGE,WARNING_MESSAGE,QUESTION_MESSAGE, orPLAIN_MESSAGE
      Throws:
      RuntimeException - ifnewType is not one of the legal values listed above
      See Also:

    • getMessageType

      public int getMessageType()
      Returns the message type.
      Returns:
      an integer specifying the message type
      See Also:

    • setOptionType

      @BeanProperty(preferred=true,description="The option pane's option type.")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, orOK_CANCEL_OPTION
      Throws:
      RuntimeException - ifnewType is not one of the legal values listed above
      See Also:

    • getOptionType

      public int getOptionType()
      Returns the type of options that are displayed.
      Returns:
      an integer specifying the user-selectable options
      See Also:

    • setSelectionValues

      @BeanProperty(description="The option pane's selection values.")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.) Anull value implies the user can input whatever they wish, usually by means of aJTextField.

      SetswantsInput to true. UsesetInitialSelectionValue 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 ofObjects the user to be displayed (usually in a list or combo-box) from which the user can make a selection
      See Also:

    • getSelectionValues

      public Object[] getSelectionValues()
      Returns the input selection values.
      Returns:
      the array ofObjects the user can select
      See Also:

    • setInitialSelectionValue

      @BeanProperty(description="The option pane's initial selection value object.")public void setInitialSelectionValue(Object newValue)
      Sets the input value that is initially displayed as selected to the user. Only used ifwantsInput is true.
      Parameters:
      newValue - the initially selected value
      See Also:

    • getInitialSelectionValue

      public Object getInitialSelectionValue()
      Returns the input value that is displayed as initially selected to the user.
      Returns:
      the initially selected value
      See Also:

    • setInputValue

      @BeanProperty(preferred=true,description="The option pane's input value object.")public void setInputValue(Object newValue)
      Sets the input value that was selected or input by the user. Only used ifwantsInput 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, usesetInitialSelectionValue.
      Parameters:
      newValue - theObject used to set the value that the user specified (usually in a text field)
      See Also:

    • getInputValue

      public Object getInputValue()
      Returns the value the user has input, ifwantsInput is true.
      Returns:
      theObject the user specified, if it was one of the objects, or aString if it was a value typed into a field
      See Also:

    • getMaxCharactersPerLineCount

      @BeanProperty(bound=false)public int getMaxCharactersPerLineCount()
      Returns the maximum number of characters to place on a line in a message. Default is to returnInteger.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

      @BeanProperty(preferred=true,description="Flag which allows the user to input a value.")public void setWantsInput(boolean newValue)
      Sets thewantsInput property. IfnewValue is true, an input component (such as a text field or combo box) whose parent isparentComponent is provided to allow the user to input a value. IfgetSelectionValues 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.

      Parameters:
      newValue - if true, an input component whose parent isparentComponent is provided to allow the user to input a value.
      See Also:

    • getWantsInput

      public boolean getWantsInput()
      Returns the value of thewantsInput property.
      Returns:
      true if an input component will be provided
      See Also:

    • 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 thisJOptionPane. 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 benull.
      Overrides:
      paramString in class JComponent
      Returns:
      a string representation of thisJOptionPane

    • getAccessibleContext

      @BeanProperty(bound=false,expert=true,description="The AccessibleContext associated with this option pane")public AccessibleContext getAccessibleContext()
      Returns theAccessibleContext associated with this JOptionPane. For option panes, theAccessibleContext takes the form of anAccessibleJOptionPane. A newAccessibleJOptionPane instance is created if necessary.
      Specified by:
      getAccessibleContext in interface Accessible
      Overrides:
      getAccessibleContext in class Component
      Returns:
      an AccessibleJOptionPane that serves as the AccessibleContext of this AccessibleJOptionPane