All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.swing.JOptionPane 

java.lang.Object
    |
    +----java.awt.Component
            |
            +----java.awt.Container
                    |
                    +----java.awt.swing.JComponent
                            |
                            +----java.awt.swing.JOptionPane
public class JOptionPane
extends JComponent
JOptionPane is designed to make it easy to pop up a standard dialog box to prompt the user for a value or inform them of something. While this class may appear very complex because of the number of methods, there are symmetries among them that makes it actually very simple. Almost all uses of this class are one-line calls to one of the static showXxxDialog methods.
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 also comes in a "showInternalXXX" flavor, which uses an internal frame to hold the dialog box (see JInternalFrame). There are several overloaded versions of each of these with a variety of different parameter lists for different common convenience cases. All dialogs are modal, ie. the showXxxDialog method blocks until the 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 ultimatly responsible for the final result.

All of the parameters to these methods follow consistant 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. Notice that the type of this parameter is Object -- it will be interpreted differently based on its type:
Object[]
The elements of the array will be arranged as messages in a vertical stack (the interpretation is recursive)
Component
The Component is used directly.
Icon
The Icon is wrapped in a JLabel and used.
others
The object is converted to a String by calling o.toString(), and the result is wrapped in a JLabel and used.
In the most common usage, message is just a String constant.
messageType
Defines the style of the message. The look&feel manager may lay out the dialog differently depending on this, and will often provide a default icon. The possible values are:
optionType
Defines the set of option buttons that will appear at the bottom of the dialog box: You aren't limited to this set of option buttons. You can provide any you want through the options parameter.
options
A more detailed description of the set of option buttons that will appear at the bottom of the dialog box. It is an array of Objects. A button will be created for each depending on it's type:
Component
The component will be added to the button row directly.
Icon
A JButton will be created with this as its label.
other
The Object will be converted to a string via o.toString() and the result will be used to label a JButton.
The usual value for options is an array of strings.
icon
A decorative icon to be placed in the dialog box. A default value for this will be provided by messageType.
title
The title for the dialog box.
initialValue
The default selection (input value).

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

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

When one of the showXxxDialog methods returns an integer, the possible values are: YES_OPTION, NO_OPTION, CANCEL_OPTION, OK_OPTION, or CLOSED_OPTION.

Examples:

Show an error dialog with the message alert: 

JOptionPane.showMessageDialog(null, "alert", "alert", ERROR_MESSAGE);
Show an internal information dialog with the message information: 
JOptionPane.showInternalMessageDialog(frame, INFORMATION_MESSAGE,
 		"information", "information");
Show an information panel with the options yes/no and message 'choose one': 
JOptionPane.showConfirmDialog(null,
 		"choose one", "choose one", YES_NO);
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",
 		YES_NO_CANCEL, 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",
 		DEFAULT_OPTION, 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 = JOptionDialog.showInputDialog(null,
 		"Choose one", "Input",
 		JOptionPane.INFORMATION_DIALOG, null,
 		possibleValues, possibleValues[0]);

If you want to create and use JOptionPanes directly, the standard pattern for using them 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;

Variable Index

o CANCEL_OPTION
Return value from class method if CANCEL is chosen.
o 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.
o DEFAULT_OPTION
Type meaning look and feel should not supply any options, and only use the options from the JOptionPane.
o ERROR_MESSAGE
Used for error messages.
o icon
Icon used in pane.
o ICON_PROPERTY
Bound property name for icon.
o INFORMATION_MESSAGE
Used for information messages.
o INITIAL_SELECTION_VALUE_PROPERTY
Bound property name for initialSelectionValue.
o INITIAL_VALUE_PROPERTY
Bounds property name for initialValue.
o initialSelectionValue
Initial value to select in selectionValues.
o initialValue
Value that should be initialy selected in options.
o INPUT_VALUE_PROPERTY
Bound property name for inputValue.
o inputValue
Value the user has input.
o isOpaque
If true, the UI will paint the background.
o message
Message to display.
o MESSAGE_PROPERTY
Bound property name for message.
o MESSAGE_TYPE_PROPERTY
Bounds property name for type.
o messageType
Message type.
o NO_OPTION
Return value from class method if NO is chosen.
o OK_CANCEL_OPTION
Type used for showConfirmDialog.
o OK_OPTION
Return value form class method if OK is chosen.
o OPTION_TYPE_PROPERTY
Bound property name for optionType.
o options
Options to display to the user.
o OPTIONS_PROPERTY
Bounds property namer for option.
o optionType
Option type, one of DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION.
o PLAIN_MESSAGE
No icon is used.
o QUESTION_MESSAGE
Used for questions.
o SELECTION_VALUES_PROPERTY
Bound property name for selectionValues.
o selectionValues
Array of values the user can choose from.
o sharedFrame
Frame used for static methods in creating a frame.
o UNITIALIZED_VALUE
Potential value for value, means that the user has not selected a value yet.
o value
Currently selected value, will be a valid option, or UNITIALIZED_VALUE or null.
o VALUE_PROPERTY
Bounds property name for value.
o WANTS_INPUT_PROPERTY
Bound property name for wantsInput.
o wantsInput
If true, a UI widget will be provided to the user to get input.
o WARNING_MESSAGE
Used for warning messages.
o YES_NO_CANCEL_OPTION
Type used for showConfirmDialog.
o YES_NO_OPTION
Type used for showConfirmDialog.
o YES_OPTION
Return value from class method if YES is chosen.

Constructor Index

o JOptionPane()
Creates a JOptionPane with a test message.
o JOptionPane(Object)
Creates an instance of JOptionPane to display the message message.
o JOptionPane(Object, int)
Creates an instance of JOptionPane to display the message message with the message type messageType.
o JOptionPane(Object, int, int)
Creates an instance of JOptionPane to display the message message, with the message type messageType and options type optionType.
o JOptionPane(Object, int, int, Icon)
Creates an instance of JOptionPane to display the message message, with the message type messageType option type optionType, and Icon icon.
o JOptionPane(Object, int, int, Icon, Object[])
Creates an instance of JOptionPane to display the message message, with the message type messageType option type optionType, Icon icon and options options.
o JOptionPane(Object, int, int, Icon, Object[], Object)
Creates an instance of JOptionPane to display the message message, with the message type messageType option type optionType, Icon icon and options options and the first value to select initialValue.

Method Index

o createDialog(Component, String)
Creates and returns a new JDialog wrapping this centered around c.
o createInternalFrame(Component, String)
Creates and returns an instance of JInternalFrame.
o getDesktopPaneForComponent(Component)
Will return the parent of parentComponent that is an instance of JDesktopPane, or null if parentComponent does not have an ancestor that is a JInternalFrame.
o getFrameForComponent(Component)
Returns the parent Frame of parentComponent.
o getIcon()
Returns the icon the receiver is displaying.
o getInitialSelectionValue()
Returns the value to initialy select in getSelectionValues.
o getInitialValue()
Returns the initial value.
o getInputValue()
Returns the value the user has input, if getWantsInput return true.
o getMaxCharactersPerLineCount()
Returns the maximum number of characters to place on a line in a message.
o getMessage()
Returns the message the receiver is representing.
o getMessageType()
Returns the message type.
o getOptions()
Returns the options, or choices the user can click on.
o getOptionType()
Returns an integer indicating the type of options that are to be displayed.
o getRootFrame()
Returns the Frame to use for the class methods in which a frame is not provided.
o getSelectionValues()
Returns the selection values.
o getUI()
Returns the OptionPaneUI that is providing the current look and feel.
o getUIClassID()
o getValue()
Returns the value the user has selected.
o getWantsInput()
Returns true if a parentComponent will be provided for the user to input.
o isOpaque()
Return whether the receiving OptionPane is opaque This method is overriden from JComponent
o selectInitialValue()
Requests that the initial value be selected.
o setIcon(Icon)
Sets the icon to display.
o setInitialSelectionValue(Object)
Sets the value to select in getSelectionValues to newValue.
o setInitialValue(Object)
Sets the initial value that is to be enabled to newInitialValue.
o setInputValue(Object)
Sets the value the user has input to newValue.
o setMessage(Object)
Sets the message to newMessage.
o setMessageType(int)
Sets the message type of the receiver to newType.
o setOpaque(boolean)
Set whether the receiving OptionPane is opaque If the JPanel is opaque, it will paint its background
o setOptions(Object[])
Sets the options the user is to display.
o setOptionType(int)
Sets the type of option to newType.
o setRootFrame(Frame)
Sets the frame to use for class methods in which a frame is not provided.
o setSelectionValues(Object[])
Sets the selection values to newValues.
o setUI(OptionPaneUI)
Sets the OptionPaneUI to ui that will provide the current look and feel.
o setValue(Object)
Sets the value the user has chosen.
o setWantsInput(boolean)
If newValue is true, a parentComponent will be provided to allow the user to input a value.
o showConfirmDialog(Component, Object)
Brings up a modal dialog with the options yes, no and cancel, and the title, "Select an Option".
o showConfirmDialog(Component, Object, String, int)
Brings up a modal dialog where the number of choices is determined by the optionType parameter.
o showConfirmDialog(Component, Object, String, int, int)
Brings up a modal dialog where the number of choices is determined by the optionType parameter, where the messageType parameter determines the icon to display.
o showConfirmDialog(Component, Object, String, int, int, Icon)
Brings up a modal dialog with a specified icon, where the number of choices is determined by the optionType parameter.
o showInputDialog(Component, Object)
Shows an input dialog requesting the user for input parented to parentComponent
o showInputDialog(Component, Object, String, int)
Shows an input dialog requesting the user for input parented to parentComponent with the dialog having the title title and message type messageType.
o showInputDialog(Component, Object, String, int, Icon, Object[], Object)
Prompts the user for input in a blocking dialog.
o showInputDialog(Object)
Shows an input dialog requesting the user for input.
o showInternalConfirmDialog(Component, Object)
Brings up an internal dialog panel displaying the message message, with the dialog pane parented to parentComponent.
o showInternalConfirmDialog(Component, Object, String, int)
Brings up an internal dialog containing a JOptionPane with either, Yes and No, or Yes, No and Cancel based on optionType.
o showInternalConfirmDialog(Component, Object, String, int, int)
Brings up an internal dialog containing a JOptionPane with either, Yes and No or Yes, No and Cancel based on type.
o showInternalConfirmDialog(Component, Object, String, int, int, Icon)
Brings up an internal dialog containing a JOptionPane with either, icon is used to indicate the default icon to display.
o showInternalInputDialog(Component, Object)
Shows an internal input dialog requesting the user for input.
o showInternalInputDialog(Component, Object, String, int)
Shows an internal input dialog requesting the user for input.
o showInternalInputDialog(Component, Object, String, int, Icon, Object[], Object)
Prompts the user for input in a blocking dialog.
o showInternalMessageDialog(Component, Object)
Brings up an internal dialog panel displaying the message message parented to the Component parentComponent.
o showInternalMessageDialog(Component, Object, String, int)
Brings up an internal dialog panel displaying the message message, with the message type messageType.
o showInternalMessageDialog(Component, Object, String, int, Icon)
Brings up an internal dialog panel displaying the message message, with the message type messageType.
o showInternalOptionDialog(Component, Object, String, int, int, Icon, Object[], Object)
Brings up an internal dialog displaying message with options options selecting initialValue initialValue.
o showMessageDialog(Component, Object)
Brings up a confirmation dialog -- a modal dialog panel displaying a message in a dialog titled "Confirm"
o showMessageDialog(Component, Object, String, int)
Brings up a dialog that displays a message using a default icon determined by the messageType parameter.
o showMessageDialog(Component, Object, String, int, Icon)
Brings up a dialog displaying a message.
o showOptionDialog(Component, Object, String, int, int, Icon, Object[], Object)
Brings up a modal dialog with a specified icon, where the initial choice is dermined by the initialValue parameter and the number of choices is determined by the optionType parameter.
o updateUI()
Called to replace the UI with the latest version from the default UIFactory.

Variables

o UNITIALIZED_VALUE 
public static final Object UNITIALIZED_VALUE
Potential value for value, means that the user has not selected a value yet.

o DEFAULT_OPTION 
public static final int DEFAULT_OPTION
Type meaning look and feel should not supply any options, and only use the options from the JOptionPane.

o YES_NO_OPTION 
public static final int YES_NO_OPTION
Type used for showConfirmDialog.

o YES_NO_CANCEL_OPTION 
public static final int YES_NO_CANCEL_OPTION
Type used for showConfirmDialog.

o OK_CANCEL_OPTION 
public static final int OK_CANCEL_OPTION
Type used for showConfirmDialog.

o YES_OPTION 
public static final int YES_OPTION
Return value from class method if YES is chosen.

o NO_OPTION 
public static final int NO_OPTION
Return value from class method if NO is chosen.

o CANCEL_OPTION 
public static final int CANCEL_OPTION
Return value from class method if CANCEL is chosen.

o OK_OPTION 
public static final int OK_OPTION
Return value form class method if OK is chosen.

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

o ERROR_MESSAGE 
public static final int ERROR_MESSAGE
Used for error messages.

o INFORMATION_MESSAGE 
public static final int INFORMATION_MESSAGE
Used for information messages.

o WARNING_MESSAGE 
public static final int WARNING_MESSAGE
Used for warning messages.

o QUESTION_MESSAGE 
public static final int QUESTION_MESSAGE
Used for questions.

o PLAIN_MESSAGE 
public static final int PLAIN_MESSAGE
No icon is used.

o ICON_PROPERTY 
public static final String ICON_PROPERTY
Bound property name for icon.

o MESSAGE_PROPERTY 
public static final String MESSAGE_PROPERTY
Bound property name for message.

o VALUE_PROPERTY 
public static final String VALUE_PROPERTY
Bounds property name for value.

o OPTIONS_PROPERTY 
public static final String OPTIONS_PROPERTY
Bounds property namer for option.

o INITIAL_VALUE_PROPERTY 
public static final String INITIAL_VALUE_PROPERTY
Bounds property name for initialValue.

o MESSAGE_TYPE_PROPERTY 
public static final String MESSAGE_TYPE_PROPERTY
Bounds property name for type.

o OPTION_TYPE_PROPERTY 
public static final String OPTION_TYPE_PROPERTY
Bound property name for optionType.

o SELECTION_VALUES_PROPERTY 
public static final String SELECTION_VALUES_PROPERTY
Bound property name for selectionValues.

o INITIAL_SELECTION_VALUE_PROPERTY 
public static final String INITIAL_SELECTION_VALUE_PROPERTY
Bound property name for initialSelectionValue.

o INPUT_VALUE_PROPERTY 
public static final String INPUT_VALUE_PROPERTY
Bound property name for inputValue.

o WANTS_INPUT_PROPERTY 
public static final String WANTS_INPUT_PROPERTY
Bound property name for wantsInput.

o sharedFrame 
protected static Frame sharedFrame
Frame used for static methods in creating a frame.

o icon 
protected transient Icon icon
Icon used in pane.

o message 
protected transient Object message
Message to display.

o options 
protected transient Object[] options
Options to display to the user.

o initialValue 
protected transient Object initialValue
Value that should be initialy selected in options.

o messageType 
protected int messageType
Message type.

o optionType 
protected int optionType
Option type, one of DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION.

o value 
protected transient Object value
Currently selected value, will be a valid option, or UNITIALIZED_VALUE or null.

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

o inputValue 
protected transient Object inputValue
Value the user has input.

o initialSelectionValue 
protected transient Object initialSelectionValue
Initial value to select in selectionValues.

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

o isOpaque 
protected boolean isOpaque
If true, the UI will paint the background.

Constructors

o JOptionPane 
public JOptionPane()
Creates a JOptionPane with a test message.

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

Parameters:
message - message to display
o JOptionPane 
public JOptionPane(Object message,
                   int messageType)
Creates an instance of JOptionPane to display the message message with the message type messageType. This uses an option type of DEFAULT_OPTION.

Parameters:
message - message to display
messageType - type of message
o JOptionPane 
public JOptionPane(Object message,
                   int messageType,
                   int optionType)
Creates an instance of JOptionPane to display the message message, with the message type messageType and options type optionType.

Parameters:
message - message to display
messageType - type of message
optionType - type of option
o JOptionPane 
public JOptionPane(Object message,
                   int messageType,
                   int optionType,
                   Icon icon)
Creates an instance of JOptionPane to display the message message, with the message type messageType option type optionType, and Icon icon.

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

Parameters:
message - message to display
messageType - type of message
optionType - type of option
icon - Icon to display
options - options for user to choose from
o JOptionPane 
public JOptionPane(Object message,
                   int messageType,
                   int optionType,
                   Icon icon,
                   Object[] options,
                   Object initialValue)
Creates an instance of JOptionPane to display the message message, with the message type messageType option type optionType, Icon icon and options options and the first value to select initialValue.

Parameters:
message - message to display
messageType - type of message
optionType - type of option
icon - Icon to display
options - options for user to choose from
initialValue - value to first select

Methods

o showInputDialog 
public static String showInputDialog(Object message)
Shows an input dialog requesting the user for input.

See Also:
showInputDialog
o showInputDialog 
public static String showInputDialog(Component parentComponent,
                                     Object message)
Shows an input dialog requesting the user for input parented to parentComponent

See Also:
#showInputDialog(java.awt.Component, java.lang.Object, java.lang.String, int)
o showInputDialog 
public static String showInputDialog(Component parentComponent,
                                     Object message,
                                     String title,
                                     int messageType)
Shows an input dialog requesting the user for input parented to parentComponent with the dialog having the title title and message type messageType.

See Also:
#showInputDialog(java.awt.Component, java.lang.Object, java.lang.String, int, java.awt.swing.Icon, java.lang.Object [], java.lang.Object)
o showInputDialog 
public 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. The message message will be displayed, the dialog will have the title title, message type messageType, and icon icon. The user will able to choose from selectionValuse, null implies the user can input what ever they wish, usually by means of a JTextField and initialSelectionValue is the initial value to prompt the user with. It is up to the UI to decide how best to represent the selectionValues, but will usually be one of a JComboBox, JList or JTextField.

Returns:
users input, or null meaning the user canceled the input
o showMessageDialog 
public static void showMessageDialog(Component parentComponent,
                                     Object message)
Brings up a confirmation dialog -- a modal dialog panel displaying a message in a dialog titled "Confirm"

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.
o showMessageDialog 
public 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.

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
messageType - an int designating the message as an error message, an informative message, a warning, a question, or a plain message, etc.
o showMessageDialog 
public static void showMessageDialog(Component parentComponent,
                                     Object message,
                                     String title,
                                     int messageType,
                                     Icon icon)
Brings up a dialog displaying a 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 in the dialog. A Component object is rendered as a Component. A String object is rendered as a string. Other objects are converted to a String using the toString method.
title - the title string for the dialog
messageType - an int designating the message as an error message, an informative message, a warning, a question, or a plain message, etc.
icon - an icon to display in the dialog that helps the user identify the kind of message that is being displayed.
o showConfirmDialog 
public static int showConfirmDialog(Component parentComponent,
                                    Object message)
Brings up a modal dialog with the options yes, no and cancel, and 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 in the dialog. A Component object is rendered as a Component. A String object is rendered as a string. Other objects are converted to a String using the toString method.
Returns:
an int indicating the option selected by the user
o showConfirmDialog 
public static int showConfirmDialog(Component parentComponent,
                                    Object message,
                                    String title,
                                    int optionType)
Brings up a modal dialog where the number of choices is determined by the optionType parameter.

The option-sets are:

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 int designating the available options as, for example, yes-no, or yes-no-cancel
Returns:
an int indicating the option selected by the user
o showConfirmDialog 
public static int showConfirmDialog(Component parentComponent,
                                    Object message,
                                    String title,
                                    int optionType,
                                    int messageType)
Brings up a modal dialog where the number of choices is determined by the optionType parameter, where the messageType parameter determines the icon to display.

The option-sets are:

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 int designating the available options as, for example, yes-no, or yes-no-cancel
messageType - an int designating the kind of message this is, primarily used to determine the icon from the pluggable look and feel
Returns:
an int indicating the option selected by the user
o showConfirmDialog 
public static int showConfirmDialog(Component parentComponent,
                                    Object message,
                                    String title,
                                    int optionType,
                                    int messageType,
                                    Icon icon)
Brings up a modal dialog with a specified icon, where the number of choices is determined by the optionType parameter.

The option-sets are:

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 int designating the available options as, for example, yes-no, or yes-no-cancel
messageType - an int designating the kind of message this is
icon - the icon to display in the dialog
Returns:
an int indicating the option selected by the user
o showOptionDialog 
public static int showOptionDialog(Component parentComponent,
                                   Object message,
                                   String title,
                                   int optionType,
                                   int messageType,
                                   Icon icon,
                                   Object[] options,
                                   Object initialValue)
Brings up a modal dialog with a specified icon, where the initial choice is dermined by the initialValue parameter and the number of choices is determined by the optionType parameter.

The option-sets are:

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 int designating the available options as, for example, yes-no, or yes-no-cancel
messageType - an int designating the kind of message this is
icon - the icon to display in the dialog
options - an array of objects indicating the possible choices the user can make. If the objects are components, they are rendered properly. Non-String objects are rendered using their toString methods. If this parameter is null, the options are determined by the look and feel.
initialValue - the object that represents the default selection for the dialog
Returns:
an int indicating the option chosen by the user, or CLOSED_OPTION if the user closed the Dialog
o createDialog 
public JDialog createDialog(Component parentComponent,
                            String title)
Creates and returns a new JDialog wrapping this centered around c. title will be the title of the returned dialog. The returned JDialog will be set up such that once it is closed, or the user clicks on the OK button, the dialog will be disposed and closed.

o showInternalMessageDialog 
public static void showInternalMessageDialog(Component parentComponent,
                                             Object message)
Brings up an internal dialog panel displaying the message message parented to the Component parentComponent. The title of the dialog will be Confirm.

o showInternalMessageDialog 
public static void showInternalMessageDialog(Component parentComponent,
                                             Object message,
                                             String title,
                                             int messageType)
Brings up an internal dialog panel displaying the message message, with the message type messageType. The dialog will have title title. parentComponent is used to determine the Frame to create the Dialog with, if parentComponent is null or has no Frame a default Frame will be used.

The icon will be determined from the messageType.

o showInternalMessageDialog 
public static void showInternalMessageDialog(Component parentComponent,
                                             Object message,
                                             String title,
                                             int messageType,
                                             Icon icon)
Brings up an internal dialog panel displaying the message message, with the message type messageType. The dialog will have title title. parentComponent is used to determine the Frame to create the Dialog with, if parentComponent is null or has no Frame a default Frame will be used.

o showInternalConfirmDialog 
public static int showInternalConfirmDialog(Component parentComponent,
                                            Object message)
Brings up an internal dialog panel displaying the message message, with the dialog pane parented to parentComponent. The options will be yes, no and cancel.

Returns:
selected option
o showInternalConfirmDialog 
public static int showInternalConfirmDialog(Component parentComponent,
                                            Object message,
                                            String title,
                                            int optionType)
Brings up an internal dialog containing a JOptionPane with either, Yes and No, or Yes, No and Cancel based on optionType. This method will block until the user clicks on one of the buttons or closes the window. title will be the title of the Dialog. The Component parentComponent is used to determine the Frame to create the Dialog with, if parentComponent is null or has no Frame a default Frame will be used.

o showInternalConfirmDialog 
public static int showInternalConfirmDialog(Component parentComponent,
                                            Object message,
                                            String title,
                                            int optionType,
                                            int messageType)
Brings up an internal dialog containing a JOptionPane with either, Yes and No or Yes, No and Cancel based on type. messageType indicates the type of message this, and is primarily used to supply a default icon from the look and feel.

o showInternalConfirmDialog 
public static int showInternalConfirmDialog(Component parentComponent,
                                            Object message,
                                            String title,
                                            int optionType,
                                            int messageType,
                                            Icon icon)
Brings up an internal dialog containing a JOptionPane with either, icon is used to indicate the default icon to display.

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

o showInternalInputDialog 
public static String showInternalInputDialog(Component parentComponent,
                                             Object message)
Shows an internal input dialog requesting the user for input.

See Also:
#showInternalInputDialog(java.awt.Component, java.lang.Object, java.lang.String, int)
o showInternalInputDialog 
public static String showInternalInputDialog(Component parentComponent,
                                             Object message,
                                             String title,
                                             int messageType)
Shows an internal input dialog requesting the user for input.

See Also:
#showInternalInputDialog(java.awt.Component, java.lang.Object, java.lang.String, int, java.awt.swing.Icon, java.lang.Object [], java.lang.Object)
o 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 dialog. The message message will be displayed, the dialog will have the title title, message type messageType, and icon icon. The user will able to choose from selectionValuse, null implies the user can input what ever they wish, usually by means of a JTextField and initialSelectionValue is the initial value to prompt the user with. It is up to the UI to decide how best to represent the selectionValues, but will usually be one of a JComboBox, JList or JTextField.

Returns:
users input, or null meaning the user canceled the input
o createInternalFrame 
public JInternalFrame createInternalFrame(Component parentComponent,
                                          String title)
Creates and returns an instance of JInternalFrame. The internal frame will be created with the passed in title, and wrapping the JOptionPane. The returned JInternalFrame will be add 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 and RuntimeException will be thrown.

o getFrameForComponent 
public static Frame getFrameForComponent(Component parentComponent)
Returns the parent Frame of parentComponent. If parentComponent is null, or does not contain a valid Frame parent getRootFrame will be returned.

o getDesktopPaneForComponent 
public static JDesktopPane getDesktopPaneForComponent(Component parentComponent)
Will return the parent of parentComponent that is an instance of JDesktopPane, or null if parentComponent does not have an ancestor that is a JInternalFrame.

o setRootFrame 
public static void setRootFrame(Frame newRootFrame)
Sets the frame to use for class methods in which a frame is not provided.

o getRootFrame 
public static Frame getRootFrame()
Returns the Frame to use for the class methods in which a frame is not provided.

o setUI 
public void setUI(OptionPaneUI ui)
Sets the OptionPaneUI to ui that will provide the current look and feel.

o getUI 
public OptionPaneUI getUI()
Returns the OptionPaneUI that is providing the current look and feel.

o updateUI 
public void updateUI()
Called to replace the UI with the latest version from the default UIFactory.

Overrides:
updateUI in class JComponent
o getUIClassID 
public String getUIClassID()
Returns:
"OptionPaneUI"
Overrides:
getUIClassID in class JComponent
See Also:
getUIClassID, getUI
o setMessage 
public void setMessage(Object newMessage)
Sets the message to newMessage. Refer to the constructor for possible values of newMessage.

This is a JavaBeans bound property.

o getMessage 
public Object getMessage()
Returns the message the receiver is representing.

o setIcon 
public void setIcon(Icon newIcon)
Sets the icon to display. If non null, the look and feel will not provide an icon.

This is a JavaBeans bound property.

o getIcon 
public Icon getIcon()
Returns the icon the receiver is displaying.

o setValue 
public void setValue(Object newValue)
Sets the value the user has chosen. Fires a bound property

This is a JavaBeans bound property.

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

o setOptions 
public void setOptions(Object[] newOptions)
Sets the options the user is to display. If an element in newOptions is a Comonent it is added directly to the receiver, otherwise a button is created for the element.

This is a JavaBeans bound property.

o getOptions 
public Object[] getOptions()
Returns the options, or choices the user can click on.

o setInitialValue 
public void setInitialValue(Object newInitialValue)
Sets the initial value that is to be enabled to newInitialValue.

This is a JavaBeans bound property.

o getInitialValue 
public Object getInitialValue()
Returns the initial value.

o setMessageType 
public void setMessageType(int newType)
Sets the message type of the receiver to newType. newType should be one of ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE or PLAIN_MESSAGE, otherwise an exception will be thrown.

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

This is a JavaBeans bound property.

o getMessageType 
public int getMessageType()
Returns the message type.

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

This is a JavaBeans bound property.

o getOptionType 
public int getOptionType()
Returns an integer indicating the type of options that are to be displayed.

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

This is a bound property.

See Also:
setWantsInput, setInitialSelectionValue
o getSelectionValues 
public Object[] getSelectionValues()
Returns the selection values.

See Also:
setSelectionValues
o setInitialSelectionValue 
public void setInitialSelectionValue(Object newValue)
Sets the value to select in getSelectionValues to newValue. This is only used if getWantsInput is true.

This is a bound property.

See Also:
setSelectionValues
o getInitialSelectionValue 
public Object getInitialSelectionValue()
Returns the value to initialy select in getSelectionValues.

See Also:
setInitialSelectionValue, setSelectionValues
o setInputValue 
public void setInputValue(Object newValue)
Sets the value the user has input to newValue.

See Also:
setSelectionValues, setWantsInput
o getInputValue 
public Object getInputValue()
Returns the value the user has input, if getWantsInput return true.

See Also:
setSelectionValues, setWantsInput
o 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 through overriding by subclasses.

o setWantsInput 
public void setWantsInput(boolean newValue)
If newValue is true, a parentComponent will be provided to allow the user to input a value. If getSelectionValues returns a non-null the input value will be one from that array, otherwise the input value will be whatever the user inputs.

This is a bound property.

See Also:
setSelectionValues, setInputValue
o getWantsInput 
public boolean getWantsInput()
Returns true if a parentComponent will be provided for the user to input.

See Also:
setWantsInput
o selectInitialValue 
public void selectInitialValue()
Requests that the initial value be selected. It is best to invoke this before displaying the receiver, but after the receiver is appropriately parented so that focus will be maintained.

o setOpaque 
public void setOpaque(boolean isOpaque)
Set whether the receiving OptionPane is opaque If the JPanel is opaque, it will paint its background

o isOpaque 
public boolean isOpaque()
Return whether the receiving OptionPane is opaque This method is overriden from JComponent

Overrides:
isOpaque in class JComponent
All Packages  Class Hierarchy  This Package  Previous  Next  Index
Submit a bug or feature