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
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
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;
For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JOptionPane
key assignments.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans
package. Please see java.beans.XMLEncoder.
Field Detail |
private static final String uiClassID
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 transient Object initialValue
options
.protected int messageType
protected int optionType
DEFAULT_OPTION
, YES_NO_OPTION
, YES_NO_CANCEL_OPTION
or OK_CANCEL_OPTION
.protected transient Object value
UNINITIALIZED_VALUE
or null
.protected transient Object[] selectionValues
protected transient Object inputValue
protected transient Object initialSelectionValue
selectionValues
.protected boolean wantsInput
Constructor Detail |
public JOptionPane()
JOptionPane
with a test message.public JOptionPane(Object message)
JOptionPane
to display a message using the plain-message message type and the default options delivered by the UI.message
- the Object
to displaypublic JOptionPane(Object message, int messageType)
JOptionPane
to display a message with the specified message type and the default options,message
- the Object
to displaymessageType
- the type of message to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
public JOptionPane(Object message, int messageType, int optionType)
JOptionPane
to display a message with the specified message type and options.message
- the Object
to displaymessageType
- the type of message to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
optionType
- the options to display in the pane: DEFAULT_OPTION
, YES_NO_OPTION
, YES_NO_CANCEL_OPTION
, OK_CANCEL_OPTION
public JOptionPane(Object message, int messageType, int optionType, Icon icon)
JOptionPane
to display a message with the specified message type, options, and icon.message
- the Object
to displaymessageType
- the type of message to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
optionType
- the options to display in the pane: DEFAULT_OPTION
, YES_NO_OPTION
, YES_NO_CANCEL_OPTION
, OK_CANCEL_OPTION
icon
- the Icon
image to displaypublic JOptionPane(Object message, int messageType, int optionType, Icon icon, Object[] options)
JOptionPane
to display a message with the specified message type, icon, and options. None of the options is initially selected. The options objects should contain either instances of Component
s, (which are added directly) or Strings
(which are wrapped in a JButton
). If you provide Component
s, you must ensure that when the Component
is clicked it messages setValue
in the created JOptionPane
.
message
- the Object
to displaymessageType
- the type of message to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
optionType
- the options to display in the pane: DEFAULT_OPTION
, YES_NO_OPTION
, YES_NO_CANCEL_OPTION
, OK_CANCEL_OPTION
icon
- the Icon
image to displayoptions
- the choices the user can selectpublic JOptionPane(Object message, int messageType, int optionType, Icon icon, Object[] options, Object initialValue)
JOptionPane
to display a message with the specified message type, icon, and options, with the initially-selected option specified.message
- the Object
to displaymessageType
- the type of message to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
optionType
- the options to display in the pane: DEFAULT_OPTION
, YES_NO_OPTION
, YES_NO_CANCEL_OPTION
, OK_CANCEL_OPTION
icon
- the Icon image to displayoptions
- the choices the user can selectinitialValue
- the choice that is initially selected; if null
, then nothing will be initially selected; only meaningful if options
is usedMethod Detail |
public static String showInputDialog(Object message)
message
- the Object
to displayHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static String showInputDialog(Object message, Object initialSelectionValue)
initialSelectionValue
. The dialog uses the default frame, which usually means it is centered on the screen.message
- the Object
to displayinitialSelectionValue
- the value used to initialize the input fieldpublic static String showInputDialog(Component parentComponent, Object message)
parentComponent
. The dialog is displayed on top of the Component
's frame, and is usually positioned below the Component
.parentComponent
- the parent Component
for the dialogmessage
- the Object
to displayHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static String showInputDialog(Component parentComponent, Object message, Object initialSelectionValue)
parentComponent
. The input value will be initialized to initialSelectionValue
. The dialog is displayed on top of the Component
's frame, and is usually positioned below the Component
.parentComponent
- the parent Component
for the dialogmessage
- the Object
to displayinitialSelectionValue
- the value used to initialize the input fieldpublic static String showInputDialog(Component parentComponent, Object message, String title, int messageType)
parentComponent
with the dialog having the title title
and message type messageType
.parentComponent
- the parent Component
for the dialogmessage
- the Object
to displaytitle
- the String
to display in the dialog title barmessageType
- the type of message that is to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
HeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static Object showInputDialog(Component parentComponent, Object message, String title, int messageType, Icon icon, Object[] selectionValues, Object initialSelectionValue)
selectionValues
, where null
implies the user can input whatever they wish, usually by means of a JTextField
. initialSelectionValue
is the initial value to prompt the user with. It is up to the UI to decide how best to represent the selectionValues
, but usually a JComboBox
, JList
, or JTextField
will be used.parentComponent
- the parent Component
for the dialogmessage
- the Object
to displaytitle
- the String
to display in the dialog title barmessageType
- the type of message to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
icon
- the Icon
image to displayselectionValues
- an array of Object
s that gives the possible selectionsinitialSelectionValue
- the value used to initialize the input fieldnull
meaning the user canceled the inputHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static void showMessageDialog(Component parentComponent, Object message)
parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- the Object
to displayHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static void showMessageDialog(Component parentComponent, Object message, String title, int messageType)
messageType
parameter.parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogmessageType
- the type of message to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
HeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static void showMessageDialog(Component parentComponent, Object message, String title, int messageType, Icon icon)
parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogmessageType
- the type of message to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
icon
- an icon to display in the dialog that helps the user identify the kind of message that is being displayedHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static int showConfirmDialog(Component parentComponent, Object message)
parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- the Object
to displayHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static int showConfirmDialog(Component parentComponent, Object message, String title, int optionType)
optionType
parameter.parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogoptionType
- an int designating the options available on the dialog: YES_NO_OPTION
, or YES_NO_CANCEL_OPTION
HeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static int showConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType)
optionType
parameter, where the messageType
parameter determines the icon to display. The messageType
parameter is primarily used to supply a default icon from the Look and Feel.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 displaytitle
- the title string for the dialogoptionType
- an integer designating the options available on the dialog: YES_NO_OPTION
, or YES_NO_CANCEL_OPTION
messageType
- an integer designating the kind of message this is; primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
HeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static int showConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon)
optionType
parameter. The messageType
parameter is primarily used to supply a default icon from the look and feel.parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- the Object to displaytitle
- the title string for the dialogoptionType
- an int designating the options available on the dialog: YES_NO_OPTION
, or YES_NO_CANCEL_OPTION
messageType
- an int designating the kind of message this is, primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
icon
- the icon to display in the dialogHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static int showOptionDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon, Object[] options, Object initialValue)
initialValue
parameter and the number of choices is determined by the optionType
parameter. If optionType
is YES_NO_OPTION
, or YES_NO_CANCEL_OPTION
and the options
parameter is null
, then the options are supplied by the look and feel.
The messageType
parameter is primarily used to supply a default icon from the look and feel.
parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogoptionType
- an integer designating the options available on the dialog: YES_NO_OPTION
, or YES_NO_CANCEL_OPTION
messageType
- an integer designating the kind of message this is, primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
icon
- the icon to display in the dialogoptions
- 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 FeelinitialValue
- the object that represents the default selection for the dialog; only meaningful if options
is used; can be null
CLOSED_OPTION
if the user closed the dialogHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public JDialog createDialog(Component parentComponent, String title)
JDialog
wrapping this
centered on the parentComponent
in the parentComponent
's frame. title
is the title of the returned dialog. The returned JDialog
will not be resizable by the user, however programs can invoke setResizable
on the JDialog
instance to change this property. The returned JDialog
will be set up such that once it is closed, or the user clicks on one of the buttons, the optionpane's value property will be set accordingly and the dialog will be closed. Each time the dialog is made visible, it will reset the option pane's value property to JOptionPane.UNINITIALIZED_VALUE
to ensure the user's subsequent action closes the dialog properly.parentComponent
- determines the frame in which the dialog is displayed; if the parentComponent
has no Frame
, a default Frame
is usedtitle
- the title string for the dialogJDialog
containing this instanceHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static void showInternalMessageDialog(Component parentComponent, Object message)
parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- the object to displaypublic static void showInternalMessageDialog(Component parentComponent, Object message, String title, int messageType)
messageType
parameter.parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogmessageType
- the type of message to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
public static void showInternalMessageDialog(Component parentComponent, Object message, String title, int messageType, Icon icon)
parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogmessageType
- the type of message to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
icon
- an icon to display in the dialog that helps the user identify the kind of message that is being displayedpublic static int showInternalConfirmDialog(Component parentComponent, Object message)
parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- the Object
to displaypublic static int showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType)
optionType
parameter.parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- 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
methodtitle
- the title string for the dialogoptionType
- an integer designating the options available on the dialog: YES_NO_OPTION
, or YES_NO_CANCEL_OPTION
public static int showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType)
optionType
parameter, where the messageType
parameter determines the icon to display. The messageType
parameter is primarily used to supply a default icon from the Look and Feel.parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- 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
methodtitle
- the title string for the dialogoptionType
- an integer designating the options available on the dialog: YES_NO_OPTION
, or YES_NO_CANCEL_OPTION
messageType
- an integer designating the kind of message this is, primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
public static int showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon)
optionType
parameter. The messageType
parameter is primarily used to supply a default icon from the look and feel.parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent has no Frame, a default Frame
is usedmessage
- 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
methodtitle
- the title string for the dialogoptionType
- an integer designating the options available on the dialog: YES_NO_OPTION
, or YES_NO_CANCEL_OPTION
messageType
- an integer designating the kind of message this is, primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
icon
- the icon to display in the dialog
- Returns:
- an integer indicating the option selected by the user
public static int showInternalOptionDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon, Object[] options, Object initialValue)
initialValue
parameter and the number of choices is determined by the optionType
parameter. If optionType
is YES_NO_OPTION
, or YES_NO_CANCEL_OPTION
and the options
parameter is null
, then the options are supplied by the Look and Feel.
The messageType
parameter is primarily used to supply a default icon from the look and feel.
parentComponent
- determines the Frame
in which the dialog is displayed; if null
, or if the parentComponent
has no Frame
, a default Frame
is usedmessage
- 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
methodtitle
- the title string for the dialogoptionType
- an integer designating the options available on the dialog: YES_NO_OPTION
, or YES_NO_CANCEL_OPTION
messageType
- an integer designating the kind of message this is; primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
icon
- the icon to display in the dialogoptions
- 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 FeelinitialValue
- the object that represents the default selection for the dialog; only meaningful if options
is used; can be null
CLOSED_OPTION
if the user closed the Dialogpublic static String showInternalInputDialog(Component parentComponent, Object message)
parentComponent
. The dialog is displayed in the Component
's frame, and is usually positioned below the Component
.parentComponent
- the parent Component
for the dialogmessage
- the Object
to displaypublic static String showInternalInputDialog(Component parentComponent, Object message, String title, int messageType)
parentComponent
with the dialog having the title title
and message type messageType
.parentComponent
- the parent Component
for the dialogmessage
- the Object
to displaytitle
- the String
to display in the dialog title barmessageType
- the type of message that is to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGEpublic static Object showInternalInputDialog(Component parentComponent, Object message, String title, int messageType, Icon icon, Object[] selectionValues, Object initialSelectionValue)
selectionValues
, where null
implies the user can input whatever they wish, usually by means of a JTextField
. initialSelectionValue
is the initial value to prompt the user with. It is up to the UI to decide how best to represent the selectionValues
, but usually a JComboBox
, JList
, or JTextField
will be used.parentComponent
- the parent Component
for the dialogmessage
- the Object
to displaytitle
- the String
to display in the dialog title barmessageType
- the type of message to be displayed: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
icon
- the Icon
image to displayselectionValues
- an array of Objects
that gives the possible selectionsinitialSelectionValue
- the value used to initialize the input fieldnull
meaning the user canceled the inputpublic JInternalFrame createInternalFrame(Component parentComponent, String title)
JInternalFrame
. The internal frame is created with the specified title, and wrapping the JOptionPane
. The returned JInternalFrame
is added to the JDesktopPane
ancestor of parentComponent
, or components parent if one its ancestors isn't a JDesktopPane
, or if parentComponent
doesn't have a parent then a RuntimeException
is thrown.parentComponent
- the parent Component
for the internal frametitle
- the String
to display in the frame's title barJInternalFrame
containing a JOptionPane
RuntimeException
- if parentComponent
does not have a valid parentpublic static Frame getFrameForComponent(Component parentComponent)
Frame
.parentComponent
- the Component
to check for a Frame
Frame
that contains the component, or the default frame if the component is null
, or does not have a valid Frame
parentHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
static Window getWindowForComponent(Component parentComponent)
Frame
or Dialog
.parentComponent
- the Component
to check for a Frame
or Dialog
Frame
or Dialog
that contains the component, or the default frame if the component is null
, or does not have a valid Frame
or Dialog
parentHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public static JDesktopPane getDesktopPaneForComponent(Component parentComponent)
parentComponent
- the Component
to check for a desktopJDesktopPane
that contains the component, or null
if the component is null
or does not have an ancestor that is a JInternalFrame
public static void setRootFrame(Frame newRootFrame)
newRootFrame
- the default Frame
to usepublic static Frame getRootFrame()
Frame
to use for the class methods in which a frame is not provided.Frame
to useHeadlessException
- if GraphicsEnvironment.isHeadless
returns true
public void setUI(OptionPaneUI ui)
ui
- the OptionPaneUI
L&F objectpublic OptionPaneUI getUI()
OptionPaneUI
objectpublic void updateUI()
UIManager
that the L&F has changed. Replaces the current UI object with the latest version from the UIManager
.public String getUIClassID()
public void setMessage(Object newMessage)
newMessage
- the Object
to displaypublic Object getMessage()
Object
that is displayedpublic void setIcon(Icon newIcon)
null
, the look and feel does not provide an icon.newIcon
- the Icon
to displaypublic Icon getIcon()
Icon
that is displayedpublic void setValue(Object newValue)
newValue
- the chosen valuepublic Object getValue()
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.Object
chosen by the user, UNINITIALIZED_VALUE
if the user has not yet made a choice, or null
if the user closed the window without making a choicepublic void setOptions(Object[] newOptions)
newOptions
is a Component
it is added directly to the pane, otherwise a button is created for the element.newOptions
- an array of Objects
that create the buttons the user can click on, or arbitrary Components
to add to the panepublic Object[] getOptions()
Objects
that give the user's choicespublic void setInitialValue(Object newInitialValue)
Component
that has the focus when the pane is initially displayed.newInitialValue
- the Object
that gets the initial keyboard focuspublic Object getInitialValue()
Object
that gets the initial keyboard focuspublic void setMessageType(int newType)
parentComponent
.newType
- an integer specifying the kind of message to display: ERROR_MESSAGE
, INFORMATION_MESSAGE
, WARNING_MESSAGE
, QUESTION_MESSAGE
, or PLAIN_MESSAGE
RuntimeException
- if newType
is not one of the legal values listed abovepublic int getMessageType()
public void setOptionType(int newType)
newType
- an integer specifying the options the L&F is to display: DEFAULT_OPTION
, YES_NO_OPTION
, YES_NO_CANCEL_OPTION
, or OK_CANCEL_OPTION
RuntimeException
- if newType
is not one of the legal values listed abovepublic int getOptionType()
public void setSelectionValues(Object[] newValues)
null
value implies the user can input whatever they wish, usually by means of a JTextField
. Sets wantsInput
to true. Use setInitialSelectionValue
to specify the initially-chosen value. After the pane as been enabled, inputValue
is set to the value the user has selected.
newValues
- an array of Objects
the user to be displayed (usually in a list or combo-box) from which the user can make a selectionpublic Object[] getSelectionValues()
Objects
the user can selectpublic void setInitialSelectionValue(Object newValue)
wantsInput
is true.newValue
- the initially selected valuepublic Object getInitialSelectionValue()
public void setInputValue(Object newValue)
wantsInput
is true. Note that this method is invoked internally by the option pane (in response to user action) and should generally not be called by client programs. To set the input value initially displayed as selected to the user, use setInitialSelectionValue
.newValue
- the Object
used to set the value that the user specified (usually in a text field)public Object getInputValue()
wantsInput
is true.Object
the user specified, if it was one of the objects, or a String
if it was a value typed into a fieldpublic int getMaxCharactersPerLineCount()
Integer.MAX_VALUE
. The value can be changed by overriding this method in a subclass.public void setWantsInput(boolean newValue)
wantsInput
property. If newValue
is true, an input component (such as a text field or combo box) whose parent is parentComponent
is provided to allow the user to input a value. If getSelectionValues
returns a non-null
array, the input value is one of the objects in that array. Otherwise the input value is whatever the user inputs. This is a bound property.
public boolean getWantsInput()
wantsInput
property.public void selectInitialValue()
protected String paramString()
JOptionPane
. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null
.JOptionPane
public AccessibleContext getAccessibleContext()
AccessibleContext
associated with this JOptionPane. For option panes, the AccessibleContext
takes the form of an AccessibleJOptionPane
. A new AccessibleJOptionPane
instance is created if necessary.