javax.swing

Class JOptionPane

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JOptionPane

Implemented Interfaces:: Accessible, ImageObserver, MenuContainer, Serializable

public class JOptionPane

extends JComponent

implements Accessible

This class creates different types of JDialogs and JInternalFrames that can ask users for input or pass on information. JOptionPane can be used by calling one of the show static methods or by creating an instance of JOptionPane and calling createDialog or createInternalFrame.

See Also:: Serialized Form

Nested Class Summary
`protected class`	`JOptionPane.AccessibleJOptionPane` Provides the accessibility features for the `JOptionPane` component.

Nested classes/interfaces inherited from class javax.swing.JComponent
`JComponent.AccessibleJComponent`

Nested classes/interfaces inherited from class java.awt.Container
`Container.AccessibleAWTContainer`

Nested classes/interfaces inherited from class java.awt.Component
`Component.AccessibleAWTComponent`, `Component.BltBufferStrategy`, `Component.FlipBufferStrategy`

Field Summary
`static int`	`CANCEL_OPTION` 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.
`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.
`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.
`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.
`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.
`static String`	`VALUE_PROPERTY` The identifier for the propertyChangeEvent when the value property changes.
`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.
`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.
`protected Object`	`message` The message displayed in the dialog/internal frame.
`protected int`	`messageType` The type of message displayed.
`protected int`	`optionType` The type of options to display.
`protected Object[]`	`options` The options (usually buttons) aligned at the bottom for the user to select.
`protected Object[]`	`selectionValues` The input values the user can select.
`protected Object`	`value` The value returned by selecting an option.
`protected boolean`	`wantsInput` Whether the Dialog/InternalFrame needs input.

Fields inherited from class javax.swing.JComponent
`TOOL_TIP_TEXT_KEY`, `UNDEFINED_CONDITION`, `WHEN_ANCESTOR_OF_FOCUSED_COMPONENT`, `WHEN_FOCUSED`, `WHEN_IN_FOCUSED_WINDOW`, `accessibleContext`, `listenerList`, `ui`

Fields inherited from class java.awt.Component
`BOTTOM_ALIGNMENT`, `CENTER_ALIGNMENT`, `LEFT_ALIGNMENT`, `RIGHT_ALIGNMENT`, `TOP_ALIGNMENT`

Fields inherited from interface java.awt.image.ImageObserver
`ABORT`, `ALLBITS`, `ERROR`, `FRAMEBITS`, `HEIGHT`, `PROPERTIES`, `SOMEBITS`, `WIDTH`

Constructor Summary
`JOptionPane()` Creates a 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.
`int`	`getOptionType()` This method returns the option type.
`Object[]`	`getOptions()` This method returns the options.
`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`	`setOptionType(int newType)` This method changes the optionType property.
`void`	`setOptions(Object[] newOptions)` This method changes the options 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.

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, extends EventListener> T[] getListeners, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponentZOrder, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate, validateTree

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFocusable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFocusable, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.lang.Object
`clone`, `equals`, `extends Object> getClass`, `finalize`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait`

CANCEL_OPTION

public static final int CANCEL_OPTION

The value returned when cancel option is selected.
Field Value:
2

CLOSED_OPTION

public static final int CLOSED_OPTION

The value returned when the dialog is closed without a selection.
Field Value:
-1

DEFAULT_OPTION

public static final int DEFAULT_OPTION

An option used in confirmation dialog methods.
Field Value:
-1

ERROR_MESSAGE

public static final int ERROR_MESSAGE

Identifier for the error message type.
Field Value:
0

ICON_PROPERTY

public static final String ICON_PROPERTY

The identifier for the propertyChangeEvent when the icon property changes.
Field Value:
"icon"

INFORMATION_MESSAGE

public static final int INFORMATION_MESSAGE

Identifier for the information message type.
Field Value:
1

INITIAL_SELECTION_VALUE_PROPERTY

public static final String INITIAL_SELECTION_VALUE_PROPERTY

Overview Package Class Use Source Tree Index Deprecated About	GNU Classpath (0.95)
Prev Class \| Next Class	GNU Classpath (0.95)	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr

javax.swing

Class JOptionPane

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object