javax.swing
public class JOptionPane extends JComponent implements Accessible
Nested Class Summary | |
---|---|
protected class | JOptionPane.AccessibleJOptionPane
Provides the accessibility features for the JOptionPane
component. |
Field Summary | |
---|---|
static int | CANCEL_OPTION The value returned when cancel option is selected. |
static int | CLOSED_OPTION The value returned when the dialog is closed without a selection. |
static int | DEFAULT_OPTION An option used in confirmation dialog methods. |
static int | ERROR_MESSAGE Identifier for the error message type. |
protected Icon | icon The icon displayed in the dialog/internal frame. |
protected Object | initialSelectionValue The initial selected value in the input component. |
protected Object | initialValue The object that is initially selected for options. |
protected Object | inputValue The value the user inputs. |
static String | ICON_PROPERTY
The identifier for the propertyChangeEvent when the icon property
changes. |
static int | INFORMATION_MESSAGE Identifier for the information message type. |
static String | INITIAL_SELECTION_VALUE_PROPERTY
The identifier for the propertyChangeEvent when the initialSelectionValue
property changes. |
static String | INITIAL_VALUE_PROPERTY
The identifier for the propertyChangeEvent when the initialValue property
changes. |
static String | INPUT_VALUE_PROPERTY
The identifier for the propertyChangeEvent when the inputValue property
changes. |
protected Object | message The message displayed in the dialog/internal frame. |
protected int | messageType The type of message displayed. |
static String | MESSAGE_PROPERTY
The identifier for the propertyChangeEvent when the message property
changes. |
static String | MESSAGE_TYPE_PROPERTY
The identifier for the propertyChangeEvent when the messageType property
changes. |
static int | NO_OPTION The value returned when the no option is selected. |
protected Object[] | options
The options (usually buttons) aligned at the bottom for the user to
select. |
protected int | optionType The type of options to display. |
static int | OK_CANCEL_OPTION An option used in confirmation dialog methods. |
static int | OK_OPTION The value returned when the ok option is selected. |
static String | OPTIONS_PROPERTY
The identifier for the propertyChangeEvent when the options property
changes. |
static String | OPTION_TYPE_PROPERTY
The identifier for the propertyChangeEvent when the optionType property
changes. |
static int | PLAIN_MESSAGE Identifier for the plain message type. |
static int | QUESTION_MESSAGE Identifier for the question message type. |
protected Object[] | selectionValues The input values the user can select. |
static String | SELECTION_VALUES_PROPERTY
The identifier for the propertyChangeEvent when the selectionValues
property changes. |
static Object | UNINITIALIZED_VALUE The value returned when the inputValue is uninitialized. |
protected Object | value The value returned by selecting an option. |
static String | VALUE_PROPERTY
The identifier for the propertyChangeEvent when the value property
changes. |
protected boolean | wantsInput Whether the Dialog/InternalFrame needs input. |
static String | WANTS_INPUT_PROPERTY
The identifier for the propertyChangeEvent when the wantsInput property
changes. |
static int | WARNING_MESSAGE Identifier for the warning message type. |
static int | YES_NO_CANCEL_OPTION An option used in confirmation dialog methods. |
static int | YES_NO_OPTION An option used in confirmation dialog methods. |
static int | YES_OPTION The value returned when the yes option is selected. |
Constructor Summary | |
---|---|
JOptionPane()
Creates a new JOptionPane object using a message of "JOptionPane
message", using the PLAIN_MESSAGE type and DEFAULT_OPTION. | |
JOptionPane(Object message)
Creates a new JOptionPane object using the given message using the
PLAIN_MESSAGE type and DEFAULT_OPTION.
| |
JOptionPane(Object message, int messageType)
Creates a new JOptionPane object using the given message and messageType
and DEFAULT_OPTION.
| |
JOptionPane(Object message, int messageType, int optionType)
Creates a new JOptionPane object using the given message, messageType and
optionType.
| |
JOptionPane(Object message, int messageType, int optionType, Icon icon)
Creates a new JOptionPane object using the given message, messageType,
optionType and icon.
| |
JOptionPane(Object message, int messageType, int optionType, Icon icon, Object[] options)
Creates a new JOptionPane object using the given message, messageType,
optionType, icon and options.
| |
JOptionPane(Object message, int messageType, int optionType, Icon icon, Object[] options, Object initialValue)
Creates a new JOptionPane object using the given message, messageType,
optionType, icon, options and initialValue. |
Method Summary | |
---|---|
JDialog | createDialog(Component parentComponent, String title)
This method creates a new JDialog that is either centered around the
parent's frame or centered on the screen (if the parent is null). |
JInternalFrame | createInternalFrame(Component parentComponent, String title)
This method creates a new JInternalFrame that is in the JLayeredPane
which contains the parentComponent given. |
AccessibleContext | getAccessibleContext()
Returns the object that provides accessibility features for this
JOptionPane component.
|
static JDesktopPane | getDesktopPaneForComponent(Component parentComponent)
This method returns the JDesktopPane for the given parentComponent or
null if none can be found.
|
static Frame | getFrameForComponent(Component parentComponent)
This method returns the Frame for the given parentComponent or null if
none can be found.
|
Icon | getIcon()
This method returns the icon displayed.
|
Object | getInitialSelectionValue()
This method returns the value initially selected from the list of values
the user can input.
|
Object | getInitialValue()
This method returns the value that is focused from the list of options.
|
Object | getInputValue()
This method returns the value that the user input.
|
int | getMaxCharactersPerLineCount()
This method returns the maximum characters per line. |
Object | getMessage()
This method returns the message displayed.
|
int | getMessageType()
This method returns the message type.
|
Object[] | getOptions()
This method returns the options.
|
int | getOptionType()
This method returns the option type.
|
static Frame | getRootFrame()
This method returns the Frame used by JOptionPane dialog's that have no
parent.
|
Object[] | getSelectionValues()
This method returns the selection values.
|
OptionPaneUI | getUI()
This method returns the UI used by the JOptionPane.
|
String | getUIClassID()
This method returns an identifier to determine which UI class will act as
the UI.
|
Object | getValue()
This method returns the value that the user selected out of options.
|
boolean | getWantsInput()
This method returns whether this JOptionPane wants input.
|
protected String | paramString()
This method returns a String that describes this JOptionPane.
|
void | selectInitialValue()
This method requests focus for the initial value. |
void | setIcon(Icon newIcon)
This method changes the icon property.
|
void | setInitialSelectionValue(Object newValue)
This method changes the initial selection property.
|
void | setInitialValue(Object newValue)
This method changes the initial value property.
|
void | setInputValue(Object newValue)
This method changes the inputValue property.
|
void | setMessage(Object newMessage)
This method changes the message property.
|
void | setMessageType(int newType)
This method changes the messageType property.
|
void | setOptions(Object[] newOptions)
This method changes the options property.
|
void | setOptionType(int newType)
This method changes the optionType property.
|
static void | setRootFrame(Frame newRootFrame)
This method changes the Frame used for JOptionPane dialogs that have no
parent.
|
void | setSelectionValues(Object[] newValues)
This method changes the selectionValues property.
|
void | setUI(OptionPaneUI ui)
This method sets the UI used with the JOptionPane.
|
void | setValue(Object newValue)
This method sets the value has been selected out of options.
|
void | setWantsInput(boolean newValue)
This method changes the wantsInput property.
|
static int | showConfirmDialog(Component parentComponent, Object message)
This method shows a confirmation dialog with the title "Select an Option"
and displays the given message. |
static int | showConfirmDialog(Component parentComponent, Object message, String title, int optionType)
This method shows a confirmation dialog with the given message,
optionType and title. |
static int | showConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType)
This method shows a confirmation dialog with the given message, title,
messageType and optionType. |
static int | showConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon)
This method shows a confirmation dialog with the given message, title,
optionType, messageType and icon. |
static String | showInputDialog(Component parentComponent, Object message)
This method will show a QUESTION_MESSAGE input dialog with the given
message. |
static String | showInputDialog(Component parentComponent, Object message, Object initialSelectionValue)
This method will show a QUESTION_MESSAGE type input dialog with the given
message and initialSelectionValue. |
static String | showInputDialog(Component parentComponent, Object message, String title, int messageType)
This method displays a new input dialog with the given message, title and
messageType. |
static Object | showInputDialog(Component parentComponent, Object message, String title, int messageType, Icon icon, Object[] selectionValues, Object initialSelectionValue)
This method shows an input dialog with the given message, title,
messageType, icon, selectionValues, and initialSelectionValue. |
static String | showInputDialog(Object message)
This method shows a QUESTION_MESSAGE type input dialog. |
static String | showInputDialog(Object message, Object initialSelectionValue)
This method shows a QUESTION_MESSAGE type input dialog. |
static int | showInternalConfirmDialog(Component parentComponent, Object message)
This method shows an internal confirmation dialog with the given message.
|
static int | showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType)
This method shows an internal confirmation dialog with the given message,
optionType and title. |
static int | showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType)
This method shows an internal confirmation dialog with the given message,
title, optionTypes and icon for the given message type. |
static int | showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon)
This method shows an internal confirmation dialog with the given message,
title, option type, message type, and icon. |
static String | showInternalInputDialog(Component parentComponent, Object message)
This method shows an internal input dialog with the given message. |
static String | showInternalInputDialog(Component parentComponent, Object message, String title, int messageType)
This method shows an internal input dialog with the given message, title
and message type. |
static Object | showInternalInputDialog(Component parentComponent, Object message, String title, int messageType, Icon icon, Object[] selectionValues, Object initialSelectionValue)
This method shows an internal input dialog with the given message, title
message type, icon, selection value list and initial selection value.
|
static void | showInternalMessageDialog(Component parentComponent, Object message)
This method shows an internal message dialog with the given message. |
static void | showInternalMessageDialog(Component parentComponent, Object message, String title, int messageType)
This method shows an internal message dialog with the given message,
title and message type. |
static void | showInternalMessageDialog(Component parentComponent, Object message, String title, int messageType, Icon icon)
This method shows an internal message dialog with the given message,
title, message type and icon. |
static int | showInternalOptionDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon, Object[] options, Object initialValue)
This method displays an internal option dialog with the given message,
title, option type, message type, icon, option list, and initial option
value. |
static void | showMessageDialog(Component parentComponent, Object message)
This method shows an INFORMATION_MESSAGE type message dialog.
|
static void | showMessageDialog(Component parentComponent, Object message, String title, int messageType)
This method shows a message dialog with the given message, title and
messageType.
|
static void | showMessageDialog(Component parentComponent, Object message, String title, int messageType, Icon icon)
This method shows a message dialog with the given message, title,
messageType and icon.
|
static int | showOptionDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon, Object[] options, Object initialValue)
This method shows an option dialog with the given message, title,
optionType, messageType, icon, options and initialValue. |
void | updateUI()
This method resets the UI to the Look and Feel default. |
Parameters: message The message to display.
Parameters: message The message to display. messageType The type of message.
Parameters: message The message to display. messageType The type of message. optionType The type of options.
Parameters: message The message to display. messageType The type of message. optionType The type of options. icon The icon to display.
Parameters: message The message to display. messageType The type of message. optionType The type of options. icon The icon to display. options The options given.
Parameters: message The message to display. messageType The type of message. optionType The type of options. icon The icon to display. options The options given. initialValue The component to focus on initially.
Throws: IllegalArgumentException If the messageType or optionType are not legal values.
Parameters: parentComponent The parent of the Dialog. title The title in the bar of the JDialog.
Returns: A new JDialog based on the JOptionPane configuration.
Parameters: parentComponent The parent to find a JDesktopPane from. title The title of the JInternalFrame.
Returns: A new JInternalFrame based on the JOptionPane configuration.
Throws: RuntimeException If no suitable JDesktopPane is found.
UNKNOWN: The specification says that the internal frame is placed
in the nearest JDesktopPane
that is found in
parent
's ancestors. The behaviour of the JDK
is that it actually looks up the nearest
JLayeredPane
in parent
's ancestors.
So do we.
JOptionPane
component.
Returns: The accessible context (an instance of {@link AccessibleJOptionPane}).
Parameters: parentComponent The component to look in.
Returns: The JDesktopPane for the given component or null if none can be found.
Parameters: parentComponent The component to look in.
Returns: The Frame for the given component or null if none can be found.
Returns: The icon displayed.
Returns: The initial selection value.
Returns: The initial value from options.
Returns: The user's input value.
Returns: The maximum characters per line.
Returns: The message displayed.
Returns: The message type.
Returns: The options.
Returns: The option type.
Returns: The Frame used by dialogs that have no parent.
Returns: The selection values.
Returns: The UI used by the JOptionPane.
Returns: The UI identifier.
Returns: The value that the user selected out of options.
Returns: Whether this JOptionPane wants input.
Returns: A String that describes this JOptionPane.
Parameters: newIcon The new icon to use.
Parameters: newValue The new initial selection.
Parameters: newValue The new initial value.
Parameters: newValue The new inputValue.
Parameters: newMessage The new message.
Parameters: newType The new messageType.
Throws: IllegalArgumentException If the messageType is not valid.
Parameters: newOptions The new options.
Parameters: newType The new optionType.
Throws: IllegalArgumentException If the optionType is not valid.
Parameters: newRootFrame The Frame to use for dialogs that have no parent.
Parameters: newValues The new selectionValues.
Parameters: ui The UI used with the JOptionPane.
Parameters: newValue The value that has been selected out of options.
Parameters: newValue Whether this JOptionPane requires input.
Parameters: parentComponent The parentComponent to find a frame in. message The message to display.
Returns: The option that was selected.
Parameters: parentComponent The component to find a frame in. message The message displayed. title The title of the dialog. optionType The optionType.
Returns: The option that was chosen.
Parameters: parentComponent The component to find a frame in. message The message displayed. title The title of the dialog. optionType The optionType. messageType The messageType.
Returns: The selected option.
Parameters: parentComponent The component to find a frame in. message The message displayed. title The title of the dialog. optionType The optionType. messageType The messsageType. icon The icon displayed.
Returns: The selected option.
Parameters: parentComponent The component to find a frame in. message The message displayed.
Returns: The value entered by the user.
Parameters: parentComponent The component to find a frame in. message The message to display. initialSelectionValue The initially selected value.
Returns: The value the user input.
Parameters: parentComponent The component to find a frame in. message The message to display. title The title of the dialog. messageType The messageType.
Returns: The value the user input.
Parameters: parentComponent The component to find a frame in. message The message displayed. title The title of the dialog. messageType The messageType. icon The icon displayed. selectionValues The list of values to select from. initialSelectionValue The initially selected value.
Returns: The user selected value.
Parameters: message The message to display.
Returns: The user selected value.
Parameters: message The message to display. initialSelectionValue The initialSelectionValue.
Returns: The user selected value.
Parameters: parentComponent The parent to find a JDesktopPane in. message The message to display.
Returns: The value selected.
Parameters: parentComponent The parent to find a JDesktopPane in. message The message to display. title The title to display. optionType The option type.
Returns: The selected value.
Parameters: parentComponent The component to find a JDesktopPane in. message The message to display. title The title of the dialog. optionType The option type. messageType The message type.
Returns: The selected value.
Parameters: parentComponent The parent to find a JDesktopPane in. message The message to display. title The title to display. optionType The option type. messageType The message type. icon The icon to display.
Returns: The selected value.
Parameters: parentComponent The parent to find a JDesktopPane in. message The message to display.
Returns: The user selected value.
Parameters: parentComponent The component to find a JDesktopPane in. message The message to display. title The title to display. messageType The message type.
Returns: The user input value.
Parameters: parentComponent The parent to find a JDesktopPane in. message The message to display. title The title to display. messageType The message type. icon The icon to display. selectionValues The selection value list. initialSelectionValue The initial selection value.
Returns: The user input value.
Parameters: parentComponent The component to find a JDesktopPane in. message The message to display.
Parameters: parentComponent The parent component to find a JDesktopPane in. message The message to display. title The title to display. messageType The message type.
Parameters: parentComponent The component to find a JDesktopPane in. message The message to display. title The title to display. messageType The message type. icon The icon to display.
Parameters: parentComponent The parent to find a JDesktopPane in. message The message displayed. title The title displayed. optionType The option type. messageType The message type. icon The icon to display. options The array of options. initialValue The initial value selected.
Returns: The option that was selected.
Parameters: parentComponent The component to find a frame in. message The message displayed.
Parameters: parentComponent The component to find a frame in. message The message displayed. title The title of the dialog. messageType The messageType.
Parameters: parentComponent The component to find a frame in. message The message displayed. title The title of the dialog. messageType The messageType. icon The icon displayed.
Parameters: parentComponent The component to find a frame in. message The message displayed. title The title of the dialog. optionType The optionType. messageType The messageType. icon The icon displayed. options The options to choose from. initialValue The initial value.
Returns: The selected option.