com.jidesoft.dialog

Class JideOptionPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JOptionPane

com.jidesoft.dialog.JideOptionPane

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class JideOptionPane
extends javax.swing.JOptionPane

JideOptionPane is an enhanced version of JOptionPane.

This component is still in beta, thus we didn't include the UIDefault needed by this component into LookAndFeelFactory by default. If you want to use it, please refer to JideOptionPaneDemo's getDemoPanel method where we add all necessary UIDefaults using UIDefaultCustomizer.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JOptionPane.AccessibleJOptionPane

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOSE_OPTION A new type for the option pane to have only the close button.
static java.lang.String	DETAILS_PROPERTY Bound property name for details.
static java.lang.String	TITLE_PROPERTY Bound property name for title.

Fields inherited from class javax.swing.JOptionPane

CANCEL_OPTION, CLOSED_OPTION, DEFAULT_OPTION, ERROR_MESSAGE, icon, ICON_PROPERTY, INFORMATION_MESSAGE, INITIAL_SELECTION_VALUE_PROPERTY, INITIAL_VALUE_PROPERTY, initialSelectionValue, initialValue, INPUT_VALUE_PROPERTY, inputValue, message, MESSAGE_PROPERTY, MESSAGE_TYPE_PROPERTY, messageType, NO_OPTION, OK_CANCEL_OPTION, OK_OPTION, OPTION_TYPE_PROPERTY, options, OPTIONS_PROPERTY, optionType, PLAIN_MESSAGE, QUESTION_MESSAGE, SELECTION_VALUES_PROPERTY, selectionValues, UNINITIALIZED_VALUE, value, VALUE_PROPERTY, WANTS_INPUT_PROPERTY, wantsInput, WARNING_MESSAGE, YES_NO_CANCEL_OPTION, YES_NO_OPTION, YES_OPTION

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
JideOptionPane()
JideOptionPane(java.lang.Object message)
JideOptionPane(java.lang.Object message, int messageType)
JideOptionPane(java.lang.Object message, int messageType, int optionType)
JideOptionPane(java.lang.Object message, int messageType, int optionType, javax.swing.Icon icon)
JideOptionPane(java.lang.Object message, int messageType, int optionType, javax.swing.Icon icon, java.lang.Object[] options)
JideOptionPane(java.lang.Object message, int messageType, int optionType, javax.swing.Icon icon, java.lang.Object[] options, java.lang.Object initialValue)

Method Summary

Modifier and Type	Method and Description
javax.swing.JDialog	createDialog(java.awt.Component parentComponent, java.lang.String title) Creates and returns a new JDialog wrapping this centered on the parentComponent in the parentComponent's frame.
javax.swing.JDialog	createDialog(java.lang.String title) Creates and returns a new parentless JDialog with the specified title.
java.lang.Object	getDetails() Gets the details object.
static java.awt.Frame	getFrameForComponent(java.awt.Component parentComponent) Returns the specified component's Frame.
java.lang.String	getResourceString(java.lang.String key) Gets the localized string from resource bundle.
java.lang.Object	getTitle() Gets the title of the option pane.
protected void	initComponents()
boolean	isDetailsVisible() Checks if the details component is visible.
void	setDetails(java.lang.Object details) Sets the details object.
void	setDetailsVisible(boolean visible) Sets the details component visible.
void	setLocale(java.util.Locale l)
void	setOptionType(int newType) Overrides the method in JOptionPane to allow a new option - CLOSE_OPTION.
void	setTitle(java.lang.Object title) Sets the title of the option pane.
static int	showConfirmDialog(java.awt.Component parentComponent, java.lang.Object message) Brings up a dialog with the options Yes, No and Cancel; with the title, Select an Option.
static int	showConfirmDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType) Brings up a dialog where the number of choices is determined by the optionType parameter.
static int	showConfirmDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType, int messageType) 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(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType, int messageType, javax.swing.Icon icon) Brings up a dialog with a specified icon, where the number of choices is determined by the optionType parameter.
static java.lang.String	showInputDialog(java.awt.Component parentComponent, java.lang.Object message) Shows a question-message dialog requesting input from the user parented to parentComponent.
static java.lang.String	showInputDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.Object initialSelectionValue) Shows a question-message dialog requesting input from the user and parented to parentComponent.
static java.lang.String	showInputDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int messageType) Shows a dialog requesting input from the user parented to parentComponent with the dialog having the title title and message type messageType.
static java.lang.Object	showInputDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int messageType, javax.swing.Icon icon, java.lang.Object[] selectionValues, java.lang.Object initialSelectionValue) Prompts the user for input in a blocking dialog where the initial selection, possible selections, and all other options can be specified.
static java.lang.String	showInputDialog(java.lang.Object message) Shows a question-message dialog requesting input from the user.
static java.lang.String	showInputDialog(java.lang.Object message, java.lang.Object initialSelectionValue) Shows a question-message dialog requesting input from the user, with the input value initialized to initialSelectionValue.
static void	showMessageDialog(java.awt.Component parentComponent, java.lang.Object message) Brings up an information-message dialog titled "Message".
static void	showMessageDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int messageType) Brings up a dialog that displays a message using a default icon determined by the messageType parameter.
static void	showMessageDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int messageType, javax.swing.Icon icon) Brings up a dialog displaying a message, specifying all parameters.
static int	showOptionDialog(java.awt.Component parentComponent, java.lang.Object message, java.lang.String title, int optionType, int messageType, javax.swing.Icon icon, java.lang.Object[] options, java.lang.Object initialValue) 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.

Methods inherited from class javax.swing.JOptionPane

createInternalFrame, getAccessibleContext, getDesktopPaneForComponent, getIcon, getInitialSelectionValue, getInitialValue, getInputValue, getMaxCharactersPerLineCount, getMessage, getMessageType, getOptions, getOptionType, getRootFrame, getSelectionValues, getUI, getUIClassID, getValue, getWantsInput, paramString, selectInitialValue, setIcon, setInitialSelectionValue, setInitialValue, setInputValue, setMessage, setMessageType, setOptions, setRootFrame, setSelectionValues, setUI, setValue, setWantsInput, showInternalConfirmDialog, showInternalConfirmDialog, showInternalConfirmDialog, showInternalConfirmDialog, showInternalInputDialog, showInternalInputDialog, showInternalInputDialog, showInternalMessageDialog, showInternalMessageDialog, showInternalMessageDialog, showInternalOptionDialog, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, 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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DETAILS_PROPERTY

public static final java.lang.String DETAILS_PROPERTY

Bound property name for details.

See Also:

Constant Field Values

TITLE_PROPERTY

public static final java.lang.String TITLE_PROPERTY

Bound property name for title.

See Also:

Constant Field Values

CLOSE_OPTION

public static final int CLOSE_OPTION

A new type for the option pane to have only the close button.

See Also:

Constant Field Values

Constructor Detail

JideOptionPane

public JideOptionPane()

JideOptionPane

public JideOptionPane(java.lang.Object message)

JideOptionPane

public JideOptionPane(java.lang.Object message,
                      int messageType)

JideOptionPane

public JideOptionPane(java.lang.Object message,
                      int messageType,
                      int optionType)

JideOptionPane

public JideOptionPane(java.lang.Object message,
                      int messageType,
                      int optionType,
                      javax.swing.Icon icon)

JideOptionPane

public JideOptionPane(java.lang.Object message,
                      int messageType,
                      int optionType,
                      javax.swing.Icon icon,
                      java.lang.Object[] options)

JideOptionPane

public JideOptionPane(java.lang.Object message,
                      int messageType,
                      int optionType,
                      javax.swing.Icon icon,
                      java.lang.Object[] options,
                      java.lang.Object initialValue)

Method Detail

initComponents

protected void initComponents()

setOptionType

public void setOptionType(int newType)

Overrides the method in JOptionPane to allow a new option - CLOSE_OPTION.

Overrides:

setOptionType in class javax.swing.JOptionPane

Parameters:

newType - the type of the option pane.

setDetails

public void setDetails(java.lang.Object details)

Sets the details object. The object can be a string or a component. If it is a string, it will be put into a JTextArea. If it is a component, it will be used directly. As long as the value is not null, a "Details" button will be added to button panel allowing you to show or hide the details panel.

Parameters:

details - the details.

getDetails

public java.lang.Object getDetails()

Gets the details object. The object can be a string or a component. If it is a string, it will be put into a JTextArea. If it is a component, it will be used directly. As long as the value is not null, a "Details" button will be added to button panel allowing you to show or hide the details panel.

Returns:

the details object.

getTitle

public java.lang.Object getTitle()

Gets the title of the option pane.

Returns:

the title of the option pane.

setTitle

public void setTitle(java.lang.Object title)

Sets the title of the option pane.

Parameters:

title - the new title of the option pane.

setDetailsVisible

public void setDetailsVisible(boolean visible)

Sets the details component visible. Please note that you need to call this method before the option pane is shown. The visible flag is actually stored on a static field so if you set one option pane visible, all option panes' details component will be visible.

Parameters:

visible - true or false.

getResourceString

public java.lang.String getResourceString(java.lang.String key)

Gets the localized string from resource bundle. Subclass can override it to provide its own string. Available keys are defined in buttons.properties that begin with "Button.".

Parameters:

key - the resource string key

Returns:

the localized string.

isDetailsVisible

public boolean isDetailsVisible()

Checks if the details component is visible.

Returns:

true if visible. Otherwise false.

setLocale

public void setLocale(java.util.Locale l)

Overrides:

setLocale in class java.awt.Component

showInputDialog

public static java.lang.String showInputDialog(java.lang.Object message)
                                        throws java.awt.HeadlessException

Shows a question-message dialog requesting input from the user. The dialog uses the default frame, which usually means it is centered on the screen.

Parameters:

message - the Object to display

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showInputDialog

public static java.lang.String showInputDialog(java.lang.Object message,
                                               java.lang.Object initialSelectionValue)

Shows a question-message dialog requesting input from the user, with the input value initialized to initialSelectionValue. The dialog uses the default frame, which usually means it is centered on the screen.

Parameters:

message - the Object to display

initialSelectionValue - the value used to initialize the input field

Since:

1.4

showInputDialog

public static java.lang.String showInputDialog(java.awt.Component parentComponent,
                                               java.lang.Object message)
                                        throws java.awt.HeadlessException

Shows a question-message dialog requesting input from the user parented to parentComponent. The dialog is displayed on top of the Component's frame, and is usually positioned below the Component.

Parameters:

parentComponent - the parent Component for the dialog

message - the Object to display

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showInputDialog

public static java.lang.String showInputDialog(java.awt.Component parentComponent,
                                               java.lang.Object message,
                                               java.lang.Object initialSelectionValue)

Shows a question-message dialog requesting input from the user and parented to parentComponent. The input value will be initialized to initialSelectionValue. The dialog is displayed on top of the Component's frame, and is usually positioned below the Component.

Parameters:

parentComponent - the parent Component for the dialog

message - the Object to display

initialSelectionValue - the value used to initialize the input field

Since:

1.4

showInputDialog

public static java.lang.String showInputDialog(java.awt.Component parentComponent,
                                               java.lang.Object message,
                                               java.lang.String title,
                                               int messageType)
                                        throws java.awt.HeadlessException

Shows a dialog requesting input from the user parented to parentComponent with the dialog having the title title and message type messageType.

Parameters:

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

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showInputDialog

public static java.lang.Object showInputDialog(java.awt.Component parentComponent,
                                               java.lang.Object message,
                                               java.lang.String title,
                                               int messageType,
                                               javax.swing.Icon icon,
                                               java.lang.Object[] selectionValues,
                                               java.lang.Object initialSelectionValue)
                                        throws java.awt.HeadlessException

Prompts the user for input in a blocking dialog where the initial selection, possible selections, and all other options can be specified. The user will able to choose from 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.

Parameters:

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

Returns:

user's input, or null meaning the user canceled the input

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showMessageDialog

public static void showMessageDialog(java.awt.Component parentComponent,
                                     java.lang.Object message)
                              throws java.awt.HeadlessException

Brings up an information-message dialog titled "Message".

Parameters:

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

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showMessageDialog

public static void showMessageDialog(java.awt.Component parentComponent,
                                     java.lang.Object message,
                                     java.lang.String title,
                                     int messageType)
                              throws java.awt.HeadlessException

Brings up a dialog that displays a message using a default icon determined by the messageType parameter.

Parameters:

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

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showMessageDialog

public static void showMessageDialog(java.awt.Component parentComponent,
                                     java.lang.Object message,
                                     java.lang.String title,
                                     int messageType,
                                     javax.swing.Icon icon)
                              throws java.awt.HeadlessException

Brings up a dialog displaying a message, specifying all parameters.

Parameters:

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

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showConfirmDialog

public static int showConfirmDialog(java.awt.Component parentComponent,
                                    java.lang.Object message)
                             throws java.awt.HeadlessException

Brings up a dialog with the options Yes, No and Cancel; with the title, Select an Option.

Parameters:

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

Returns:

an integer indicating the option selected by the user

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showConfirmDialog

public static int showConfirmDialog(java.awt.Component parentComponent,
                                    java.lang.Object message,
                                    java.lang.String title,
                                    int optionType)
                             throws java.awt.HeadlessException

Brings up a dialog where the number of choices is determined by the optionType parameter.

Parameters:

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, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION

Returns:

an int indicating the option selected by the user

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showConfirmDialog

public static int showConfirmDialog(java.awt.Component parentComponent,
                                    java.lang.Object message,
                                    java.lang.String title,
                                    int optionType,
                                    int messageType)
                             throws java.awt.HeadlessException

Brings up a dialog where the number of choices is determined by the 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.

Parameters:

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 integer designating the options available on the dialog: YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION

messageType - an integer designating the kind of message this is; primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

Returns:

an integer indicating the option selected by the user

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showConfirmDialog

public static int showConfirmDialog(java.awt.Component parentComponent,
                                    java.lang.Object message,
                                    java.lang.String title,
                                    int optionType,
                                    int messageType,
                                    javax.swing.Icon icon)
                             throws java.awt.HeadlessException

Brings up a dialog with a specified icon, where the number of choices is determined by the optionType parameter. The messageType parameter is primarily used to supply a default icon from the look and feel.

Parameters:

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, YES_NO_CANCEL_OPTION, or OK_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

Returns:

an int indicating the option selected by the user

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

showOptionDialog

public static int showOptionDialog(java.awt.Component parentComponent,
                                   java.lang.Object message,
                                   java.lang.String title,
                                   int optionType,
                                   int messageType,
                                   javax.swing.Icon icon,
                                   java.lang.Object[] options,
                                   java.lang.Object initialValue)
                            throws java.awt.HeadlessException

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.

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.

Parameters:

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 integer designating the options available on the dialog: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION

messageType - an integer designating the kind of message this is, primarily used to determine the icon from the pluggable Look and Feel: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE

icon - the icon to display in the dialog

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; only meaningful if options is used; can be null

Returns:

an integer indicating the option chosen by the user, or CLOSED_OPTION if the user closed the dialog

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

createDialog

public javax.swing.JDialog createDialog(java.awt.Component parentComponent,
                                        java.lang.String title)
                                 throws java.awt.HeadlessException

Creates and returns a new JDialog wrapping this centered on the parentComponent in the parentComponent's frame. title is the title of the returned dialog. The returned JDialog will not be resizable by the user, however programs can invoke setResizable on the JDialog instance to change this property. The returned JDialog will be set up such that once it is closed, or the user clicks on one of the buttons, the optionpane's value property will be set accordingly and the dialog will be closed. Each time the dialog is made visible, it will reset the option pane's value property to JOptionPane.UNINITIALIZED_VALUE to ensure the user's subsequent action closes the dialog properly.

Overrides:

createDialog in class javax.swing.JOptionPane

Parameters:

parentComponent - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used

title - the title string for the dialog

Returns:

a new JDialog containing this instance

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

createDialog

public javax.swing.JDialog createDialog(java.lang.String title)
                                 throws java.awt.HeadlessException

Creates and returns a new parentless JDialog with the specified title. The returned JDialog will not be resizable by the user, however programs can invoke setResizable on the JDialog instance to change this property. The returned JDialog will be set up such that once it is closed, or the user clicks on one of the buttons, the optionpane's value property will be set accordingly and the dialog will be closed. Each time the dialog is made visible, it will reset the option pane's value property to JOptionPane.UNINITIALIZED_VALUE to ensure the user's subsequent action closes the dialog properly.

Overrides:

createDialog in class javax.swing.JOptionPane

Parameters:

title - the title string for the dialog

Returns:

a new JDialog containing this instance

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

Since:

1.6

See Also:

GraphicsEnvironment.isHeadless()

getFrameForComponent

public static java.awt.Frame getFrameForComponent(java.awt.Component parentComponent)
                                           throws java.awt.HeadlessException

Returns the specified component's Frame.

Parameters:

parentComponent - the Component to check for a Frame

Returns:

the Frame that contains the component, or getRootFrame if the component is null, or does not have a valid Frame parent

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

See Also:

JOptionPane.getRootFrame(), GraphicsEnvironment.isHeadless()