|
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
|
+--java.awt.Component
|
+--java.awt.Container
|
+--javax.swing.JComponent
|
+--javax.swing.JOptionPane
Unsafe:
| Field Summary | |
static int |
CANCEL_OPTION
Enabled: Return value from class method if CANCEL is chosen. |
static int |
CLOSED_OPTION
Enabled: Return value from class method if user closes window without selecting anything, more than likely this should be treated as either a CANCEL_OPTION or NO_OPTION. |
static int |
DEFAULT_OPTION
Enabled: Type used for showConfirmDialog. |
static int |
ERROR_MESSAGE
Enabled: Used for error messages. |
protected Icon |
icon
Icon used in pane. |
static String |
ICON_PROPERTY
Suppressed: Bound property name for icon. |
static int |
INFORMATION_MESSAGE
Enabled: Used for information messages. |
static String |
INITIAL_SELECTION_VALUE_PROPERTY
Suppressed: Bound property name for initialSelectionValue. |
static String |
INITIAL_VALUE_PROPERTY
Suppressed: Bound property name for initialValue. |
protected Object |
initialSelectionValue
Initial value to select in selectionValues. |
protected Object |
initialValue
Value that should be initially selected in options. |
static String |
INPUT_VALUE_PROPERTY
Suppressed: Bound property name for inputValue. |
protected Object |
inputValue
Value the user has input. |
protected Object |
message
Message to display. |
static String |
MESSAGE_PROPERTY
Suppressed: Bound property name for message. |
static String |
MESSAGE_TYPE_PROPERTY
Suppressed: Bound property name for type. |
protected int |
messageType
Message type. |
static int |
NO_OPTION
Enabled: Return value from class method if NO is chosen. |
static int |
OK_CANCEL_OPTION
Enabled: Type used for showConfirmDialog. |
static int |
OK_OPTION
Enabled: Return value form class method if OK is chosen. |
static String |
OPTION_TYPE_PROPERTY
Suppressed: Bound property name for optionType. |
protected Object[] |
options
Options to display to the user. |
static String |
OPTIONS_PROPERTY
Suppressed: Bound property name for option. |
protected int |
optionType
Option type, one of DEFAULT_OPTION,
YES_NO_OPTION,
YES_NO_CANCEL_OPTION or
OK_CANCEL_OPTION. |
static int |
PLAIN_MESSAGE
Enabled: No icon is used. |
static int |
QUESTION_MESSAGE
Enabled: Used for questions. |
static String |
SELECTION_VALUES_PROPERTY
Suppressed: Bound property name for selectionValues. |
protected Object[] |
selectionValues
Array of values the user can choose from. |
private static Object |
sharedFrameKey
|
private static String |
uiClassID
|
static Object |
UNINITIALIZED_VALUE
Suppressed: Indicates that the user has not yet selected a value. |
protected Object |
value
Currently selected value, will be a valid option, or UNINITIALIZED_VALUE or null. |
static String |
VALUE_PROPERTY
Suppressed: Bound property name for value. |
static String |
WANTS_INPUT_PROPERTY
Suppressed: Bound property name for wantsInput. |
protected boolean |
wantsInput
If true, a UI widget will be provided to the user to get input. |
static int |
WARNING_MESSAGE
Enabled: Used for warning messages. |
static int |
YES_NO_CANCEL_OPTION
Enabled: Type used for showConfirmDialog. |
static int |
YES_NO_OPTION
Enabled: Type used for showConfirmDialog. |
static int |
YES_OPTION
Enabled: Return value from class method if YES is chosen. |
| Fields inherited from class javax.swing.JComponent |
_bounds, accessibleContext, listenerList, paintingChild, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
| Fields inherited from class java.awt.Container |
|
| Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
| Constructor Summary | |
JOptionPane()
Enabled: Creates a JOptionPane with a test message. |
|
JOptionPane(Object message)
Enabled: Creates a instance of JOptionPane to display a
message using the
plain-message message type and the default options delivered by
the UI. |
|
JOptionPane(Object message,
int messageType)
Enabled: Creates an instance of JOptionPane to display a message
with the specified message type and the default options, |
|
JOptionPane(Object message,
int messageType,
int optionType)
Enabled: Creates an instance of JOptionPane to display a message
with the specified message type and options. |
|
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon)
Enabled: Creates an instance of JOptionPane to display a message
with the specified message type, options, and icon. |
|
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon,
Object[] options)
Enabled: Creates an instance of JOptionPane to display a message
with the specified message type, icon, and options. |
|
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon,
Object[] options,
Object initialValue)
Enabled: Creates an instance of JOptionPane to display a message
with the specified message type, icon, and options, with the
initially-selected option specified. |
|
| Method Summary | |
JDialog |
createDialog(Component parentComponent,
String title)
Enabled: Creates and returns a new JDialog wrapping
this centered on the parentComponent
in the parentComponent's frame. |
private JDialog |
createDialog(Component parentComponent,
String title,
int style)
|
JInternalFrame |
createInternalFrame(Component parentComponent,
String title)
Enabled: Creates and returns an instance of JInternalFrame. |
AccessibleContext |
getAccessibleContext()
Enabled: Returns the AccessibleContext associated with this JOptionPane. |
static JDesktopPane |
getDesktopPaneForComponent(Component parentComponent)
Enabled: Returns the specified component's desktop pane. |
static Frame |
getFrameForComponent(Component parentComponent)
Enabled: Returns the specified component's Frame. |
Icon |
getIcon()
Enabled: Returns the icon this pane displays. |
Object |
getInitialSelectionValue()
Enabled: Returns the input value that is displayed as initially selected to the user. |
Object |
getInitialValue()
Enabled: Returns the initial value. |
Object |
getInputValue()
Enabled: Returns the value the user has input, if wantsInput
is true. |
int |
getMaxCharactersPerLineCount()
Enabled: Returns the maximum number of characters to place on a line in a message. |
Object |
getMessage()
Enabled: Returns the message-object this pane displays. |
int |
getMessageType()
Enabled: Returns the message type. |
Object[] |
getOptions()
Enabled: Returns the choices the user can make. |
int |
getOptionType()
Enabled: Returns the type of options that are displayed. |
static Frame |
getRootFrame()
Enabled: Returns the Frame to use for the class methods in
which a frame is not provided. |
Object[] |
getSelectionValues()
Enabled: Returns the input selection values. |
javax.swing.plaf.OptionPaneUI |
getUI()
Enabled: Returns the UI object which implements the L&F for this component. |
String |
getUIClassID()
Enabled: Returns the name of the UI class that implements the L&F for this component. |
Object |
getValue()
Enabled: Returns the value the user has selected. |
boolean |
getWantsInput()
Enabled: Returns the value of the wantsInput property. |
(package private) static Window |
getWindowForComponent(Component parentComponent)
Returns the specified component's toplevel Frame or
Dialog. |
protected String |
paramString()
Returns a string representation of this JOptionPane. |
private void |
readObject(ObjectInputStream s)
We use the ObjectInputStream "registerValidation"
callback to update the UI for the entire tree of components
after they've all been read in. |
void |
selectInitialValue()
Enabled: Requests that the initial value be selected, which will set focus to the initial value. |
void |
setIcon(Icon newIcon)
Enabled: Sets the icon to display. |
void |
setInitialSelectionValue(Object newValue)
Enabled: Sets the input value that is initially displayed as selected to the user. |
void |
setInitialValue(Object newInitialValue)
Enabled: Sets the initial value that is to be enabled -- the Component
that has the focus when the pane is initially displayed. |
void |
setInputValue(Object newValue)
Enabled: Sets the input value that was selected or input by the user. |
void |
setMessage(Object newMessage)
Enabled: Sets the option pane's message-object. |
void |
setMessageType(int newType)
Enabled: Sets the option pane's message type. |
void |
setOptions(Object[] newOptions)
Enabled: Sets the options this pane displays. |
void |
setOptionType(int newType)
Enabled: Sets the options to display. |
static void |
setRootFrame(Frame newRootFrame)
Enabled: Sets the frame to use for class methods in which a frame is not provided. |
void |
setSelectionValues(Object[] newValues)
Enabled: Sets the input selection values for a pane that provides the user with a list of items to choose from. |
void |
setUI(javax.swing.plaf.OptionPaneUI ui)
Enabled: Sets the UI object which implements the L&F for this component. |
void |
setValue(Object newValue)
Enabled: Sets the value the user has chosen. |
void |
setWantsInput(boolean newValue)
Enabled: Sets the wantsInput property. |
static int |
showConfirmDialog(Component parentComponent,
Object message)
Enabled: Brings up a dialog with the options Yes, No and Cancel; with the title, Select an Option. |
static int |
showConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType)
Enabled: Brings up a dialog where the number of choices is determined by the optionType parameter. |
static int |
showConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType)
Enabled: Brings up a dialog where the number of choices is determined by the optionType parameter, where the
messageType
parameter determines the icon to display. |
static int |
showConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon)
Enabled: Brings up a dialog with a specified icon, where the number of choices is determined by the optionType parameter. |
static String |
showInputDialog(Component parentComponent,
Object message)
Enabled: Shows a question-message dialog requesting input from the user parented to parentComponent. |
static String |
showInputDialog(Component parentComponent,
Object message,
Object initialSelectionValue)
Enabled: Shows a question-message dialog requesting input from the user and parented to parentComponent. |
static String |
showInputDialog(Component parentComponent,
Object message,
String title,
int messageType)
Enabled: Shows a dialog requesting input from the user parented to parentComponent with the dialog having the title
title and message type messageType. |
static Object |
showInputDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon,
Object[] selectionValues,
Object initialSelectionValue)
Enabled: Prompts the user for input in a blocking dialog where the initial selection, possible selections, and all other options can be specified. |
static String |
showInputDialog(Object message)
Enabled: Shows a question-message dialog requesting input from the user. |
static String |
showInputDialog(Object message,
Object initialSelectionValue)
Enabled: Shows a question-message dialog requesting input from the user, with the input value initialized to initialSelectionValue. |
static int |
showInternalConfirmDialog(Component parentComponent,
Object message)
Enabled: Brings up an internal dialog panel with the options Yes, No and Cancel; with the title, Select an Option. |
static int |
showInternalConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType)
Enabled: Brings up a internal dialog panel where the number of choices is determined by the optionType parameter. |
static int |
showInternalConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType)
Enabled: Brings up an internal dialog panel where the number of choices is determined by the optionType parameter, where
the messageType parameter determines the icon to display. |
static int |
showInternalConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon)
Enabled: Brings up an internal dialog panel with a specified icon, where the number of choices is determined by the optionType
parameter. |
static String |
showInternalInputDialog(Component parentComponent,
Object message)
Enabled: Shows an internal question-message dialog requesting input from the user parented to parentComponent. |
static String |
showInternalInputDialog(Component parentComponent,
Object message,
String title,
int messageType)
Enabled: Shows an internal dialog requesting input from the user parented to parentComponent with the dialog having the title
title and message type messageType. |
static Object |
showInternalInputDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon,
Object[] selectionValues,
Object initialSelectionValue)
Enabled: Prompts the user for input in a blocking internal dialog where the initial selection, possible selections, and all other options can be specified. |
static void |
showInternalMessageDialog(Component parentComponent,
Object message)
Enabled: Brings up an internal confirmation dialog panel. |
static void |
showInternalMessageDialog(Component parentComponent,
Object message,
String title,
int messageType)
Enabled: Brings up an internal dialog panel that displays a message using a default icon determined by the messageType
parameter. |
static void |
showInternalMessageDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon)
Enabled: Brings up an internal dialog panel displaying a message, specifying all parameters. |
static int |
showInternalOptionDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon,
Object[] options,
Object initialValue)
Enabled: Brings up an internal dialog panel with a specified icon, where the initial choice is determined by the initialValue
parameter and the number of choices is determined by the
optionType parameter. |
static void |
showMessageDialog(Component parentComponent,
Object message)
Enabled: Brings up an information-message dialog titled "Message". |
static void |
showMessageDialog(Component parentComponent,
Object message,
String title,
int messageType)
Enabled: Brings up a dialog that displays a message using a default icon determined by the messageType parameter. |
static void |
showMessageDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon)
Enabled: Brings up a dialog displaying a message, specifying all parameters. |
static int |
showOptionDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon,
Object[] options,
Object initialValue)
Enabled: Brings up a dialog with a specified icon, where the initial choice is determined by the initialValue parameter and
the number of choices is determined by the optionType
parameter. |
private static int |
styleFromMessageType(int messageType)
|
void |
updateUI()
Enabled: Notification from the UIManager that the L&F has changed. |
private void |
writeObject(ObjectOutputStream s)
Before writing a JComponent to an
ObjectOutputStream we temporarily uninstall its UI. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
private static final String uiClassID
getUIClassID(),
readObject(java.io.ObjectInputStream)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
private static final Object sharedFrameKey
| 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 display
public 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_MESSAGEoptionType - 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_MESSAGEoptionType - the options to display in the pane:
DEFAULT_OPTION, YES_NO_OPTION,
YES_NO_CANCEL_OPTION,
OK_CANCEL_OPTIONicon - the Icon image to display
public 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
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 clic