|
JavaTM 2 Platform Standard Ed. 5.0_13 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JOptionPane
public class JOptionPane
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:
Each of these methods also comes in a
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 current thread 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
Componentthat is to be the parent of this dialog box. It is used in two ways: theFramethat contains it is used as theFrameparent 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 defaultFrameis 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
StringorStringconstant. 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
Componentis displayed in the dialog.- Icon
- The
Iconis wrapped in aJLabeland displayed in the dialog.- others
- The object is converted to a
Stringby calling itstoStringmethod. The result is wrapped in aJLabeland 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_MESSAGEINFORMATION_MESSAGEWARNING_MESSAGEQUESTION_MESSAGEPLAIN_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_OPTIONYES_NO_OPTIONYES_NO_CANCEL_OPTIONOK_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
Strings. 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
JButtonis created with this as its label.- other
- The
Objectis converted to a string using itstoStringmethod 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
messageTypeparameter.- 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
JOptionPane.showMessageDialog(null, "alert", "alert", JOptionPane.ERROR_MESSAGE);
JOptionPane.showInternalMessageDialog(frame, "information",
"information", JOptionPane.INFORMATION_MESSAGE);
JOptionPane.showConfirmDialog(null,
"choose one", "choose one", JOptionPane.YES_NO_OPTION);
JOptionPane.showInternalConfirmDialog(frame,
"please choose one", "information",
JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.INFORMATION_MESSAGE);
Object[] options = { "OK", "CANCEL" };
JOptionPane.showOptionDialog(null, "Click OK to continue", "Warning",
JOptionPane.DEFAULT_OPTION, JOptionPane.WARNING_MESSAGE,
null, options, options[0]);
String inputValue = JOptionPane.showInputDialog("Please input a value");
Object[] possibleValues = { "First", "Second", "Third" };
Object selectedValue = JOptionPane.showInputDialog(null,
"Choose one", "Input",
JOptionPane.INFORMATION_MESSAGE, null,
possibleValues, possibleValues[0]);
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:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans package.
Please see XMLEncoder.
JInternalFrame| Nested Class Summary | |
|---|---|
protected class |
JOptionPane.AccessibleJOptionPane
This class implements accessibility support for the JOptionPane class. |
| Nested classes/interfaces inherited from class javax.swing.JComponent |
|---|
JComponent.AccessibleJComponent |
| Nested classes/interfaces inherited from class java.awt.Container |
|---|
Container.AccessibleAWTContainer |
| Nested classes/interfaces inherited from class java.awt.Component |
|---|
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy |
| Field Summary | |
|---|---|
static int |
CANCEL_OPTION
Return value from class method if CANCEL is chosen. |
static int |
CLOSED_OPTION
Return value from class method if user closes window without selecting anything, more than likely this should be treated as either a CANCEL_OPTION or NO_OPTION. |
static int |
DEFAULT_OPTION
Type used for showConfirmDialog. |
static int |
ERROR_MESSAGE
Used for error messages. |
protected Icon |
icon
Icon used in pane. |
static String |
ICON_PROPERTY
Bound property name for icon. |
static int |
INFORMATION_MESSAGE
Used for information messages. |
static String |
INITIAL_SELECTION_VALUE_PROPERTY
Bound property name for initialSelectionValue. |
static String |
INITIAL_VALUE_PROPERTY
Bound property name for initialValue. |
protected Object |
initialSelectionValue
Initial value to select in selectionValues. |
protected Object |
initialValue
Value that should be initially selected in options. |
static String |
INPUT_VALUE_PROPERTY
Bound property name for inputValue. |
protected Object |
inputValue
Value the user has input. |
protected Object |
message
Message to display. |
static String |
MESSAGE_PROPERTY
Bound property name for message. |
static String |
MESSAGE_TYPE_PROPERTY
Bound property name for type. |
protected int |
messageType
Message type. |
static int |
NO_OPTION
Return value from class method if NO is chosen. |
static int |
OK_CANCEL_OPTION
Type used for showConfirmDialog. |
static int |
OK_OPTION
Return value form class method if OK is chosen. |
static String |
OPTION_TYPE_PROPERTY
Bound property name for optionType. |
protected Object[] |
options
Options to display to the user. |
static String |
OPTIONS_PROPERTY
Bound property name for option. |
protected int |
optionType
Option type, one of DEFAULT_OPTION,
YES_NO_OPTION,
YES_NO_CANCEL_OPTION or
OK_CANCEL_OPTION. |
static int |
PLAIN_MESSAGE
No icon is used. |
static int |
QUESTION_MESSAGE
Used for questions. |
static String |
SELECTION_VALUES_PROPERTY
Bound property name for selectionValues. |
protected Object[] |
selectionValues
Array of values the user can choose from. |
static Object |
UNINITIALIZED_VALUE
Indicates that the user has not yet selected a value. |
protected Object |
value
Currently selected value, will be a valid option, or UNINITIALIZED_VALUE or null. |
static String |
VALUE_PROPERTY
Bound property name for value. |
static String |
WANTS_INPUT_PROPERTY
Bound property name for wantsInput. |
protected boolean |
wantsInput
If true, a UI widget will be provided to the user to get input. |
static int |
WARNING_MESSAGE
Used for warning messages. |
static int |
YES_NO_CANCEL_OPTION
Type used for showConfirmDialog. |
static int |
YES_NO_OPTION
Type used for showConfirmDialog. |
static int |
YES_OPTION
Return value from class method if YES is chosen. |
| Fields inherited from class javax.swing.JComponent |
|---|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
| Fields inherited from class java.awt.Component |
|---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
| Fields inherited from interface java.awt.image.ImageObserver |
|---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
| Constructor Summary | |
|---|---|
JOptionPane()
Creates a JOptionPane with a test message. |
|
JOptionPane(Object message)
Creates a instance of JOptionPane to display a
message using the
plain-message message type and the default options delivered by
the UI. |
|
JOptionPane(Object message,
int messageType)
Creates an instance of JOptionPane to display a message
with the specified message type and the default options, |
|
JOptionPane(Object message,
int messageType,
int optionType)
Creates an instance of JOptionPane to display a message
with the specified message type and options. |
|
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon)
Creates an instance of JOptionPane to display a message
with the specified message type, options, and icon. |
|
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon,
Object[] options)
Creates an instance of JOptionPane to display a message
with the specified message type, icon, and options. |
|
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon,
Object[] options,
Object initialValue)
Creates an instance of JOptionPane to display a message
with the specified message type, icon, and options, with the
initially-selected option specified. |
|
| Method Summary | |
|---|---|
JDialog |
createDialog(Component parentComponent,
String title)
Creates and returns a new JDialog wrapping
this centered on the parentComponent
in the parentComponent's frame. |
JInternalFrame |
createInternalFrame(Component parentComponent,
String title)
Creates and returns an instance of JInternalFrame. |
AccessibleContext |
getAccessibleContext()
Returns the AccessibleContext associated with this JOptionPane. |
static JDesktopPane |
getDesktopPaneForComponent(Component parentComponent)
Returns the specified component's desktop pane. |
static Frame |
getFrameForComponent(Component parentComponent)
Returns the specified component's Frame. |
Icon |
getIcon()
Returns the icon this pane displays. |
Object |
getInitialSelectionValue()
Returns the input value that is displayed as initially selected to the user. |
Object |
getInitialValue()
Returns the initial value. |
Object |
getInputValue()
Returns the value the user has input, if wantsInput
is true. |
int |
getMaxCharactersPerLineCount()
Returns the maximum number of characters to place on a line in a message. |
Object |
getMessage()
Returns the message-object this pane displays. |
int |
getMessageType()
Returns the message type. |
Object[] |
getOptions()
Returns the choices the user can make. |
int |
getOptionType()
Returns the type of options that are displayed. |
static Frame |
getRootFrame()
Returns the Frame to use for the class methods in
which a frame is not provided. |
Object[] |
getSelectionValues()
Returns the input selection values. |
OptionPaneUI |
getUI()
Returns the UI object which implements the L&F for this component. |
String |
getUIClassID()
Returns the name of the UI class that implements the L&F for this component. |
Object |
getValue()
Returns the value the user has selected. |
boolean |
getWantsInput()
Returns the value of the wantsInput property. |
protected String |
paramString()
Returns a string representation of this JOptionPane. |
void |
selectInitialValue()
Requests that the initial value be selected, which will set focus to the initial value. |
void |
setIcon(Icon newIcon)
Sets the icon to display. |
void |
setInitialSelectionValue(Object newValue)
Sets the input value that is initially displayed as selected to the user. |
void |
setInitialValue(Object newInitialValue)
Sets the initial value that is to be enabled -- the Component
that has the focus when the pane is initially displayed. |
void |
setInputValue(Object newValue)
Sets the input value that was selected or input by the user. |
void |
setMessage(Object newMessage)
Sets the option pane's message-object. |
void |
setMessageType(int newType)
Sets the option pane's message type. |
void |
setOptions(Object[] newOptions)
Sets the options this pane displays. |
void |
setOptionType(int newType)
Sets the options to display. |
static void |
setRootFrame(Frame newRootFrame)
Sets the frame to use for class methods in which a frame is not provided. |
void |
setSelectionValues(Object[] newValues)
Sets the input selection values for a pane that provides the user with a list of items to choose from. |
void |
setUI(OptionPaneUI ui)
Sets the UI object which implements the L&F for this component. |
void |
setValue(Object newValue)
Sets the value the user has chosen. |
void |
setWantsInput(boolean newValue)
Sets the wantsInput property. |
static int |
showConfirmDialog(Component parentComponent,
Object message)
Brings up a dialog with the options Yes, No and Cancel; with the title, Select an Option. |
static int |
showConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType)
Brings up a dialog where the number of choices is determined by the optionType parameter. |
static int |
showConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType)
Brings up a dialog where the number of choices is determined by the optionType parameter, where the
messageType
parameter determines the icon to display. |
static int |
showConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon)
Brings up a dialog with a specified icon, where the number of choices is determined by the optionType parameter. |
static String |
showInputDialog(Component parentComponent,
Object message)
Shows a question-message dialog requesting input from the user parented to parentComponent. |
static String |
showInputDialog(Component parentComponent,
Object message,
Object initialSelectionValue)
Shows a question-message dialog requesting input from the user and parented to parentComponent. |
static String |
showInputDialog(Component parentComponent,
Object message,
String title,
int messageType)
Shows a dialog requesting input from the user parented to parentComponent with the dialog having the title
title and message type messageType. |
static Object |
showInputDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon,
Object[] selectionValues,
Object initialSelectionValue)
Prompts the user for input in a blocking dialog where the initial selection, possible selections, and all other options can be specified. |
static String |
showInputDialog(Object message)
Shows a question-message dialog requesting input from the user. |
static String |
showInputDialog(Object message,
Object initialSelectionValue)
Shows a question-message dialog requesting input from the user, with the input value initialized to initialSelectionValue. |
static int |
showInternalConfirmDialog(Component parentComponent,
Object message)
Brings up an internal dialog panel with the options Yes, No and Cancel; with the title, Select an Option. |
static int |
showInternalConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType)
Brings up a internal dialog panel where the number of choices is determined by the optionType parameter. |
static int |
showInternalConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType)
Brings up an internal dialog panel where the number of choices is determined by the optionType parameter, where
the messageType parameter determines the icon to display. |
static int |
showInternalConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon)
Brings up an internal dialog panel with a specified icon, where the number of choices is determined by the optionType
parameter. |
static String |
showInternalInputDialog(Component parentComponent,
Object message)
Shows an internal question-message dialog requesting input from the user parented to parentComponent. |
static String |
showInternalInputDialog(Component parentComponent,
Object message,
String title,
int messageType)
Shows an internal dialog requesting input from the user parented to parentComponent with the dialog having the title
title and message type messageType. |
static Object |
showInternalInputDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon,
Object[] selectionValues,
Object initialSelectionValue)
Prompts the user for input in a blocking internal dialog where the initial selection, possible selections, and all other options can be specified. |
static void |
showInternalMessageDialog(Component parentComponent,
Object message)
Brings up an internal confirmation dialog panel. |
static void |
showInternalMessageDialog(Component parentComponent,
Object message,
String title,
int messageType)
Brings up an internal dialog panel that displays a message using a default icon determined by the messageType
parameter. |
static void |
showInternalMessageDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon)
Brings up an internal dialog panel displaying a message, specifying all parameters. |
static int |
showInternalOptionDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon,
Object[] options,
Object initialValue)
Brings up an internal dialog panel with a specified icon, where the initial choice is determined by the initialValue
parameter and the number of choices is determined by the
optionType parameter. |
static void |
showMessageDialog(Component parentComponent,
Object message)
Brings up an information-message dialog titled "Message". |
static void |
showMessageDialog(Component parentComponent,
Object message,
String title,
int messageType)
Brings up a dialog that displays a message using a default icon determined by the messageType parameter. |
static void |
showMessageDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon)
Brings up a dialog displaying a message, specifying all parameters. |
static int |
showOptionDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon,
Object[] options,
Object initialValue)
Brings up a dialog with a specified icon, where the initial choice is determined by the initialValue parameter and
the number of choices is determined by the optionType
parameter. |
void |
updateUI()
Notification from the UIManager that the L&F has changed. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final Object UNINITIALIZED_VALUE
public static final int DEFAULT_OPTION
showConfirmDialog.
public static final int YES_NO_OPTION
showConfirmDialog.
public static final int YES_NO_CANCEL_OPTION
showConfirmDialog.
public static final int OK_CANCEL_OPTION
showConfirmDialog.
public static final int YES_OPTION
public static final int NO_OPTION
public static final int CANCEL_OPTION
public static final int OK_OPTION
public static final int CLOSED_OPTION
CANCEL_OPTION or NO_OPTION.
public static final int ERROR_MESSAGE
public static final int INFORMATION_MESSAGE
public static final int WARNING_MESSAGE
public static final int QUESTION_MESSAGE
public static final int PLAIN_MESSAGE
public static final String ICON_PROPERTY
icon.
public static final String MESSAGE_PROPERTY
message.
public static final String VALUE_PROPERTY
value.
public static final String OPTIONS_PROPERTY
option.
public static final String INITIAL_VALUE_PROPERTY
initialValue.
public static final String MESSAGE_TYPE_PROPERTY
type.
public static final String OPTION_TYPE_PROPERTY
optionType.
public static final String SELECTION_VALUES_PROPERTY
selectionValues.
public static final String INITIAL_SELECTION_VALUE_PROPERTY
initialSelectionValue.
public static final String INPUT_VALUE_PROPERTY
inputValue.
public static final String WANTS_INPUT_PROPERTY
wantsInput.
protected transient Icon icon
protected transient Object message
protected transient Object[] options
protected t