Contents | Package | Class | Tree | Deprecated | Index | Help | Java 1.2 Beta 3 | ||
PREV | NEXT | SHOW LISTS | HIDE LISTS |
java.lang.Object | +----java.awt.Component | +----java.awt.Container | +----java.awt.swing.JComponent | +----java.awt.swing.JOptionPane
showXxxDialog
methods shown below:
Each of these methods also comes in a
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 |
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: the Frame that contains it is used as the Frame parent for the dialog box, and its screen coordinates are used in the placement of the dialog box. In general, the dialog box is placed just below the component. This parameter may be null, in which case a default Frame is used as the parent, and the dialog will be centered on the screen (depending on the L&F).
- message
- A descriptive message to be placed in the dialog box. In the most common usage, message is just a String or String constant. However, the type of this parameter is actually Object. It's 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 a JLabel and displayed in the dialog.
- others
- The object is converted to a String by calling its
toString
method. The result is wrapped in a JLabel and displayed.- messageType
- Defines the style of the message. The look&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 Strings. But the parameter type is an array of Objects. A button is created for each object depending on it's 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 its
toString
method and the result is used to label a JButton.- 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, or CLOSED_OPTION.Examples:
JOptionPane.showMessageDialog(null, "alert", "alert", ERROR_MESSAGE);
JOptionPane.showInternalMessageDialog(frame, INFORMATION_MESSAGE,
"information", "information");
JOptionPane.showConfirmDialog(null,
"choose one", "choose one", YES_NO);
JOptionPane.showInternalConfirmDialog(frame,
"please choose one", "information",
YES_NO_CANCEL, INFORMATION_MESSAGE);
Object[] options = { "OK", "CANCEL" };
JOptionPane.showOptionDialog(null, "Click OK to continue", "Warning",
DEFAULT_OPTION, WARNING_MESSAGE,
null, options, options[0]);
String inputValue = JOptionPane.showInputDialog("Please input a value");
Object[] possibleValues = { "First", "Second", "Third" };
Object selectedValue = JOptionDialog.showInputDialog(null,
"Choose one", "Input",
JOptionPane.INFORMATION_DIALOG, null,
possibleValues, possibleValues[0]);
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 Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.
Inner classes inherited from class java.awt.swing.JComponent |
JComponent.AccessibleJComponent |
Field Summary | |
static int | CANCEL_OPTION
|
static int | CLOSED_OPTION
|
static int | DEFAULT_OPTION
|
static int | ERROR_MESSAGE
|
Icon | icon
|
static String | ICON_PROPERTY
|
static int | INFORMATION_MESSAGE
|
static String | INITIAL_SELECTION_VALUE_PROPERTY
|
static String | INITIAL_VALUE_PROPERTY
|
Object | initialSelectionValue
|
Object | initialValue
|
static String | INPUT_VALUE_PROPERTY
|
Object | inputValue
|
Object | message
|
static String | MESSAGE_PROPERTY
|
static String | MESSAGE_TYPE_PROPERTY
|
int | messageType
|
static int | NO_OPTION
|
static int | OK_CANCEL_OPTION
|
static int | OK_OPTION
|
static String | OPTION_TYPE_PROPERTY
|
Object[] | options
|
static String | OPTIONS_PROPERTY
|
int | optionType
|
static int | PLAIN_MESSAGE
|
static int | QUESTION_MESSAGE
|
static String | SELECTION_VALUES_PROPERTY
|
Object[] | selectionValues
|
static Object | UNINITIALIZED_VALUE
|
Object | value
|
static String | VALUE_PROPERTY
|
static String | WANTS_INPUT_PROPERTY
|
boolean | wantsInput
|
static int | WARNING_MESSAGE
|
static int | YES_NO_CANCEL_OPTION
|
static int | YES_NO_OPTION
|
static int | YES_OPTION
|
Fields inherited from class java.awt.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 |
Constructor Summary | |
JOptionPane()
|
|
JOptionPane(Object message)
|
|
JOptionPane(Object message,
int messageType)
|
|
JOptionPane(Object message,
int messageType,
int optionType)
|
|
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon)
|
|
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon,
Object[] options)
|
|
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon,
Object[] options,
Object initialValue)
|
Method Summary | |
JDialog | createDialog(Component parentComponent,
String title)
this
centered on the parentComponent in the
parentComponent 's frame.
|
JInternalFrame | createInternalFrame(Component parentComponent,
String title)
|
static JDesktopPane | getDesktopPaneForComponent(Component parentComponent)
|
static Frame | getFrameForComponent(Component parentComponent)
|
Icon | getIcon()
|
Object | getInitialSelectionValue()
|
Object | getInitialValue()
|
Object | getInputValue()
wantsInput
is true.
|
int | getMaxCharactersPerLineCount()
|
Object | getMessage()
|
int | getMessageType()
|
Object[] | getOptions()
|
int | getOptionType()
|
static Frame | getRootFrame()
|
Object[] | getSelectionValues()
|
java.awt.swing.plaf.OptionPaneUI | getUI()
|
String | getUIClassID()
|
Object | getValue()
|
boolean | getWantsInput()
|
void | selectInitialValue()
|
void | setIcon(Icon newIcon)
|
void | setInitialSelectionValue(Object newValue)
|
void | setInitialValue(Object newInitialValue)
|
void | setInputValue(Object newValue)
|
void | setMessage(Object newMessage)
|
void | setMessageType(int newType)
|
void | setOptions(Object[] newOptions)
|
void | setOptionType(int newType)
|
static void | setRootFrame(Frame newRootFrame)
|
void | setSelectionValues(Object[] newValues)
|
void | setUI(java.awt.swing.plaf.OptionPaneUI ui)
|
void | setValue(Object newValue)
|
void | setWantsInput(boolean newValue)
newValue is true, a parentComponent is provided to
allow the user to input a value.
|
static int | showConfirmDialog(Component parentComponent,
Object message)
|
static int | showConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType)
optionType parameter.
|
static int | showConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType)
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)
optionType parameter.
|
static String | showInputDialog(Object message)
|
static String | showInputDialog(Component parentComponent,
Object message)
parentComponent .
|
static String | showInputDialog(Component parentComponent,
Object message,
String title,
int messageType)
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)
|
static int | showInternalConfirmDialog(Component parentComponent,
Object message)
|
static int | showInternalConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType)
optionType parameter.
|
static int | showInternalConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType)
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)
optionType
parameter.
|
static String | showInternalInputDialog(Component parentComponent,
Object message)
parentComponent .
|
static String | showInternalInputDialog(Component parentComponent,
Object message,
String title,
int messageType)
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)
|
static void | showInternalMessageDialog(Component parentComponent,
Object message)
|
static void | showInternalMessageDialog(Component parentComponent,
Object message,
String title,
int messageType)
|
static void | showInternalMessageDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon)
|
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.
|
static void | showMessageDialog(Component parentComponent,
Object message)
|
static void | showMessageDialog(Component parentComponent,
Object message,
String title,
int messageType)
|
static void | showMessageDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon)
|
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.
|
void | updateUI()
|
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, addImpl, addNotify, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setLayout, update, validate, validateTree |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final Object UNINITIALIZED_VALUE
public static final int DEFAULT_OPTION
public static final int YES_NO_OPTION
public static final int YES_NO_CANCEL_OPTION
public static final int OK_CANCEL_OPTION
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
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
public static final String MESSAGE_PROPERTY
public static final String VALUE_PROPERTY
public static final String OPTIONS_PROPERTY
public static final String INITIAL_VALUE_PROPERTY
public static final String MESSAGE_TYPE_PROPERTY
public static final String OPTION_TYPE_PROPERTY
public static final String SELECTION_VALUES_PROPERTY
public static final String INITIAL_SELECTION_VALUE_PROPERTY
public static final String INPUT_VALUE_PROPERTY
public static final String WANTS_INPUT_PROPERTY
protected transient Icon icon
protected transient Object message
protected transient Object[] options
protected transient Object initialValue
protected int messageType
protected int optionType
protected transient Object value
protected transient Object[] selectionValues
protected transient Object inputValue
protected transient Object initialSelectionValue
protected boolean wantsInput
Constructor Detail |
public JOptionPane()
public JOptionPane(Object message)
message
- the Object to display
public JOptionPane(Object message, int messageType)
message
- the Object to display
messageType
- 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)
message
- the Object to display
messageType
- 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)
message
- the Object to display
messageType
- 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 display
public JOptionPane(Object message, int messageType, int optionType, Icon icon, Object[] options)
The options objects should contain either instances of Components,
(which are added directly) or Strings (which are wrapped in a
JButton). If you provide Components, you must ensure that when the
Component is clicked it messages setValue
in the
created JOptionPane.
message
- the Object to display
messageType
- 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. Only meaningful if the
options
parameter is null.
icon
- the Icon image to display
options
- the choices the user can select
public JOptionPane(Object message, int messageType, int optionType, Icon icon, Object[] options, Object initialValue)
message
- the Object to display
messageType
- 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. Only meaningful if the
options
parameter is null.
icon
- the Icon image to display
options
- the choices the user can select
initialValue
- the choice that is initially selected
Method Detail |
public static String showInputDialog(Object message)
message
- the Object to display
public static String showInputDialog(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 dialog
message
- the Object to display
public 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 dialog
message
- the Object to display
title
- the String to display in the dialog title bar
messageType
- the type of message that is to be displayed:
ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE,
QUESTION_MESSAGE, or PLAIN_MESSAGE.
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 dialog
message
- the Object to display
title
- the String to display in the dialog title bar
messageType
- the type of message to be displayed:
ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE,
QUESTION_MESSAGE, or PLAIN_MESSAGE.
icon
- the Icon image to display
selectionValues
- an array of Objects that gives the possible
selections
initialSelectionValue
- the value used to initialize the input
field
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 used.
message
- The Object to display
public static void showMessageDialog(Component parentComponent, Object message, String title, int messageType)
parentComponent
- Determines the Frame in which the dialog is displayed.
If null, or if the parentComponent has no Frame, a
default Frame is used.
message
- The Object to display
title
- the title string for the dialog
messageType
- the type of message to be displayed:
ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE,
QUESTION_MESSAGE, or PLAIN_MESSAGE.
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 used.
message
- The Object to display
title
- the title string for the dialog
messageType
- 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 displayed.
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 used.
message
- The Object to display
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 used.
message
- The Object to display
title
- the title string for the dialog
optionType
- an int designating the options available on the dialog:
YES_NO_OPTION, or YES_NO_CANCEL_OPTION
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 display
title
- the title string for the dialog
optionType
- 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.
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 used.
message
- The Object to display
title
- the title string for the dialog
optionType
- 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 dialog
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 used.
message
- The Object to display
title
- the title string for the dialog
optionType
- 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 dialog
options
- an array of objects indicating the possible choices
the user can make. If the objects are components, they
are rendered properly. Non-String objects are
rendered using their toString
methods.
If this parameter is null, the options are determined
by the look and feel.
initialValue
- the object that represents the default selection
for the dialog
public JDialog createDialog(Component parentComponent, String title)
this
centered on the parentComponent
in the
parentComponent
's frame.
title
is the title of the returned dialog.
The returned JDialog will be set up such that once it is closed,
or the user clicks on the OK button, the dialog will be disposed
and closed.
Re if the parentComponent has no Frame, a
default Frame is used.
title
- the title string for the dialog
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 used.
message
- The object to display
public static void showInternalMessageDialog(Component parentComponent, Object message, String title, int messageType)
parentComponent
- Determines the Frame in which the dialog is displayed.
If null, or if the parentComponent has no Frame, a
default Frame is used.
message
- The Object to display
title
- the title string for the dialog
messageType
- 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 used.
message
- The Object to display
title
- the title string for the dialog
messageType
- 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 displayed.
public 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 used.
message
- The Object to display
public 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 used.
message
- The object to display in the dialog. A Component object
is rendered as a Component. A String object is rendered
as a string. Other objects are converted to a String
using the toString
method.
title
- the title string for the dialog
optionType
- an int designating the 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 used.
message
- The object to display in the dialog. A Component object
is rendered as a Component. A String object is rendered
as a string. Other objects are converted to a String
using the toString
method.
title
- the title string for the dialog
optionType
- an int designating the 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.
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 used.
message
- The object to display in the dialog. A Component object
is rendered as a Component. A String object is rendered
as a string. Other objects are converted to a String
using the toString
method.
title
- the title string for the dialog
optionType
- an int designating the 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 dialog
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 used.
message
- The object to display in the dialog. A Component object
is rendered as a Component. A String object is rendered
as a string. Other objects are converted to a String
using the toString
method.
title
- the title string for the dialog
optionType
- an int designating the 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 dialog
options
- an array of objects indicating the possible choices
the user can make. If the objects are components, they
are rendered properly. Non-String objects are
rendered using their toString
methods.
If this parameter is null, the options are determined
by the look and feel.
initialValue
- the object that represents the default selection
for the dialog
public 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 dialog
message
- the Object to display
public 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 dialog
message
- the Object to display
title
- the String to display in the dialog title bar
messageType
- the type of message that is to be displayed:
ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE,
QUESTION_MESSAGE, or PLAIN_MESSAGE.
public 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 dialog
message
- the Object to display
title
- the String to display in the dialog title bar
messageType
- the type of message to be displayed:
ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE,
QUESTION_MESSAGE, or PLAIN_MESSAGE.
icon
- the Icon image to display
selectionValues
- an array of Objects that gives the possible
selections
initialSelectionValue
- the value used to initialize the input
field
public JInternalFrame createInternalFrame(Component parentComponent, String title)
RuntimeException
is thrown.
parentComponent
- the parent Component for the internal frame
title
- the String to display in the frame's title bar
public static Frame getFrameForComponent(Component parentComponent)
parentComponent
- the Component to check for a Frame
public static JDesktopPane getDesktopPaneForComponent(Component parentComponent)
parentComponent
- the Component to check for a desktop
public static void setRootFrame(Frame newRootFrame)
newRootFrame
- the default Frame to use
public static Frame getRootFrame()
public void setUI(java.awt.swing.plaf.OptionPaneUI ui)
ui
- the OptionPaneUI L&F object
public java.awt.swing.plaf.OptionPaneUI getUI()
public void updateUI()
public String getUIClassID()
public void setMessage(Object newMessage)
newMessage
- the Object to display
public Object getMessage()
public void setIcon(Icon newIcon)
icon
- the Icon to display
public Icon getIcon()
public void setValue(Object newValue)
newValue
- the chosen value
public Object getValue()
public void setOptions(Object[] newOptions)
newOptions
- an array of Objects that create the buttons
the user can click on, or arbitrary Components to add
to the pane
public Object[] getOptions()
the
- array of Objects that give the user's choices
public void setInitialValue(Object newInitialValue)
newInitialValue
- the Object that gets the initial
keyboard focus
public Object getInitialValue()
public void setMessageType(int newType)
newType
- an int specifying the kind of message to display:
ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE,
QUESTION_MESSAGE, or PLAIN_MESSAGE. Otherwise,
a RuntimeEception is thrown.
public int getMessageType()
public void setOptionType(int newType)
newType
- an int specifying the options the L&F is to display:
DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION,
or OK_CANCEL_OPTION. Otherwise, a RuntimeException
is thrown.
public int getOptionType()
public void setSelectionValues(Object[] newValues)
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 selection
public Object[] getSelectionValues()
return
- the array of Objects the user can select
public void setInitialSelectionValue(Object newValue)
wantsInput
is true.
newValue
- the initially selected value
public Object getInitialSelectionValue()
public void setInputValue(Object newValue)
newValue
- the Object used to initialized the value that
the user specified (usually in a text field)
public Object getInputValue()
wantsInput
is true.public int getMaxCharactersPerLineCount()
public void setWantsInput(boolean newValue)
newValue
is true, a parentComponent is provided to
allow the user to input a value. If getSelectionValues
returns a non-null 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()
public void selectInitialValue()
Contents | Package | Class | Tree | Deprecated | Index | Help | Java 1.2 Beta 3 | ||
PREV | NEXT | SHOW LISTS | HIDE LISTS |