- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
JOptionPane
makes it easy to pop up a standard dialog box that
prompts users for a value or informs them of something.
For information about using JOptionPane
, see
How to Make Dialogs,
a section in The Java Tutorial.
While the JOptionPane
class may appear complex because of the large number of methods, almost
all uses of this class are one-line calls to one of the static
showXxxDialog
methods shown below:
Method Name | Description |
---|---|
showConfirmDialog | Asks a confirming question, like yes/no/cancel. |
showInputDialog | Prompt for some input. |
showMessageDialog | Tell the user about something that has happened. |
showOptionDialog | The Grand Unification of the above three. |
showInternalXXX
flavor, which uses an internal frame to hold the dialog box (see
JInternalFrame
).
Multiple convenience methods have also been defined -- overloaded
versions of the basic methods that use different parameter lists.
All dialogs are modal. Each showXxxDialog
method blocks
the caller until the user's interaction is complete.
icon | message |
input value | |
option buttons |
ComponentOrientation
property.
Parameters:
The parameters to these methods follow consistent patterns:
- parentComponent
- Defines the
Component
that is to be the parent of this dialog box. It is used in two ways: 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 a
String
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
- The
Component
is displayed in the dialog.- Icon
- The
Icon
is wrapped in aJLabel
and displayed in the dialog.- others
- The object is converted to a
String
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: You aren't limited to this set of option buttons. You can provide any buttons you want using the options parameter.
DEFAULT_OPTION
YES_NO_OPTION
YES_NO_CANCEL_OPTION
OK_CANCEL_OPTION
options A more detailed description of the set of option buttons that will appear at the bottom of the dialog box. The usual value for the options parameter is an array of String
s. But the parameter type is an array ofObjects
. A button is created for each object depending on its type:
- Component
- The component is added to the button row directly.
- Icon
- A
JButton
is created with this as its label.- other
- The
Object
is converted to a string using 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 the messageType
parameter.title The title for the dialog box. initialValue The default selection (input value).
When the selection is changed, setValue
is invoked,
which generates a PropertyChangeEvent
.
If a JOptionPane
has configured to all input
setWantsInput
the bound property JOptionPane.INPUT_VALUE_PROPERTY
can also be listened
to, to determine when the user has input or selected a value.
When one of the showXxxDialog
methods returns an integer,
the possible values are:
YES_OPTION
NO_OPTION
CANCEL_OPTION
OK_OPTION
CLOSED_OPTION
- 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]);
To create and use an
JOptionPane
directly, the
standard pattern is roughly as follows:
JOptionPane pane = new JOptionPane(arguments); pane.set.Xxxx(...); // Configure JDialog dialog = pane.createDialog(parentComponent, title); dialog.show(); Object selectedValue = pane.getValue(); if(selectedValue == null) return CLOSED_OPTION; //If there is not an array of option buttons: if(options == null) { if(selectedValue instanceof Integer) return ((Integer)selectedValue).intValue(); return CLOSED_OPTION; } //If there is an array of option buttons: for(int counter = 0, maxCounter = options.length; counter < maxCounter; counter++) { if(options[counter].equals(selectedValue)) return counter; } return CLOSED_OPTION;
Warning: Swing is not thread safe. For more information see Swing'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 the java.beans
package.
Please see XMLEncoder
.
- Since:
- 1.2
- See Also:
JInternalFrame
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected class
This class implements accessibility support for theJOptionPane
class.Nested classes/interfaces declared in class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic int
Return value from class method if CANCEL is chosen.static int
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
.static int
Type meaning Look and Feel should not supply any options -- only use the options from theJOptionPane
.static int
Used for error messages.protected Icon
Icon used in pane.static String
Bound property name foricon
.static int
Used for information messages.static String
Bound property name forinitialSelectionValue
.static String
Bound property name forinitialValue
.protected Object
Initial value to select inselectionValues
.protected Object
Value that should be initially selected inoptions
.static String
Bound property name forinputValue
.protected Object
Value the user has input.protected Object
Message to display.static String
Bound property name formessage
.static String
Bound property name fortype
.protected int
Message type.static int
Return value from class method if NO is chosen.static int
Type used forshowConfirmDialog
.static int
Return value form class method if OK is chosen.static String
Bound property name foroptionType
.protected Object[]
Options to display to the user.static String
Bound property name foroption
.protected int
Option type, one ofDEFAULT_OPTION
,YES_NO_OPTION
,YES_NO_CANCEL_OPTION
orOK_CANCEL_OPTION
.static int
No icon is used.static int
Used for questions.static String
Bound property name forselectionValues
.protected Object[]
Array of values the user can choose from.static Object
Indicates that the user has not yet selected a value.protected Object
Currently selected value, will be a valid option, orUNINITIALIZED_VALUE
ornull
.static String
Bound property name forvalue
.static String
Bound property name forwantsInput
.protected boolean
If true, a UI widget will be provided to the user to get input.static int
Used for warning messages.static int
Type used forshowConfirmDialog
.static int
Type used forshowConfirmDialog
.static int
Return value from class method if YES is chosen.Fields declared in class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Fields declared in class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
Constructor Summary
ConstructorsConstructorDescriptionCreates aJOptionPane
with a test message.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.JOptionPane(Object message, int messageType)
Creates an instance ofJOptionPane
to display a message with the specified message type and the default options,JOptionPane(Object message, int messageType, int optionType)
Creates an instance ofJOptionPane
to display a message with the specified message type and options.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.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.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. -
Method Summary
Modifier and TypeMethodDescriptioncreateDialog(Component parentComponent, String title)
Creates and returns a newJDialog
wrappingthis
centered on theparentComponent
in theparentComponent
's frame.createDialog(String title)
Creates and returns a new parentlessJDialog
with the specified title.createInternalFrame(Component parentComponent, String title)
Creates and returns an instance ofJInternalFrame
.Returns theAccessibleContext
associated with this JOptionPane.static JDesktopPane
getDesktopPaneForComponent(Component parentComponent)
Returns the specified component's desktop pane.static Frame
getFrameForComponent(Component parentComponent)
Returns the specified component'sFrame
.getIcon()
Returns the icon this pane displays.Returns the input value that is displayed as initially selected to the user.Returns the initial value.Returns the value the user has input, ifwantsInput
is true.int
Returns the maximum number of characters to place on a line in a message.Returns the message-object this pane displays.int
Returns the message type.Object[]
Returns the choices the user can make.int
Returns the type of options that are displayed.static Frame
Returns theFrame
to use for the class methods in which a frame is not provided.Object[]
Returns the input selection values.getUI()
Returns the UI object which implements the L&F for this component.Returns the name of the UI class that implements the L&F for this component.getValue()
Returns the value the user has selected.boolean
Returns the value of thewantsInput
property.protected String
Returns a string representation of thisJOptionPane
.void
Requests that the initial value be selected, which will set focus to the initial value.void
Sets the icon to display.void
setInitialSelectionValue(Object newValue)
Sets the input value that is initially displayed as selected to the user.void
setInitialValue(Object newInitialValue)
Sets the initial value that is to be enabled -- theComponent
that has the focus when the pane is initially displayed.void
setInputValue(Object newValue)
Sets the input value that was selected or input by the user.void
setMessage(Object newMessage)
Sets the option pane's message-object.void
setMessageType(int newType)
Sets the option pane's message type.void
setOptions(Object[] newOptions)
Sets the options this pane displays.void
setOptionType(int newType)
Sets the options to display.static void
setRootFrame(Frame newRootFrame)
Sets the frame to use for class methods in which a frame is not provided.void
setSelectionValues(Object[] newValues)
Sets the input selection values for a pane that provides the user with a list of items to choose from.void
setUI(OptionPaneUI ui)
Sets the UI object which implements the L&F for this component.void
Sets the value the user has chosen.void
setWantsInput(boolean newValue)
Sets thewantsInput
property.static int
showConfirmDialog(Component parentComponent, Object message)
Brings up a dialog with the options Yes, No and Cancel; with the title, Select an Option.static int
showConfirmDialog(Component parentComponent, Object message, String title, int optionType)
Brings up a dialog where the number of choices is determined by theoptionType
parameter.static int
showConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType)
Brings up a dialog where the number of choices is determined by theoptionType
parameter, where themessageType
parameter determines the icon to display.static int
showConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon)
Brings up a dialog with a specified icon, where the number of choices is determined by theoptionType
parameter.static String
showInputDialog(Component parentComponent, Object message)
Shows a question-message dialog requesting input from the user parented toparentComponent
.static String
showInputDialog(Component parentComponent, Object message, Object initialSelectionValue)
Shows a question-message dialog requesting input from the user and parented toparentComponent
.static String
showInputDialog(Component parentComponent, Object message, String title, int messageType)
Shows a dialog requesting input from the user parented toparentComponent
with the dialog having the titletitle
and message typemessageType
.static Object
showInputDialog(Component parentComponent, Object message, String title, int messageType, Icon icon, Object[] selectionValues, Object initialSelectionValue)
Prompts the user for input in a blocking dialog where the initial selection, possible selections, and all other options can be specified.static String
showInputDialog(Object message)
Shows a question-message dialog requesting input from the user.static String
showInputDialog(Object message, Object initialSelectionValue)
Shows a question-message dialog requesting input from the user, with the input value initialized toinitialSelectionValue
.static int
showInternalConfirmDialog(Component parentComponent, Object message)
Brings up an internal dialog panel with the options Yes, No and Cancel; with the title, Select an Option.static int
showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType)
Brings up a internal dialog panel where the number of choices is determined by theoptionType
parameter.static int
showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType)
Brings up an internal dialog panel where the number of choices is determined by theoptionType
parameter, where themessageType
parameter determines the icon to display.static int
showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon)
Brings up an internal dialog panel with a specified icon, where the number of choices is determined by theoptionType
parameter.static String
showInternalInputDialog(Component parentComponent, Object message)
Shows an internal question-message dialog requesting input from the user parented toparentComponent
.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
.static Object
showInternalInputDialog(Component parentComponent, Object message, String title, int messageType, Icon icon, Object[] selectionValues, Object initialSelectionValue)
Prompts the user for input in a blocking internal dialog where the initial selection, possible selections, and all other options can be specified.static void
showInternalMessageDialog(Component parentComponent, Object message)
Brings up an internal confirmation dialog panel.static void
showInternalMessageDialog(Component parentComponent, Object message, String title, int messageType)
Brings up an internal dialog panel that displays a message using a default icon determined by themessageType
parameter.static void
showInternalMessageDialog(Component parentComponent, Object message, String title, int messageType, Icon icon)
Brings up an internal dialog panel displaying a message, specifying all parameters.static int
showInternalOptionDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon, Object[] options, Object initialValue)
Brings up an internal dialog panel with a specified icon, where the initial choice is determined by theinitialValue
parameter and the number of choices is determined by theoptionType
parameter.static void
showMessageDialog(Component parentComponent, Object message)
Brings up an information-message dialog titled "Message".static void