| JavaTM 2 Platform Std. Ed. v1.6.0
javax.swing
Class JDialog
java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Dialog
javax.swing.JDialog
- All Implemented Interfaces:
- ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants
public class JDialog - extends Dialog
- implements WindowConstants, Accessible, RootPaneContainer
The main class for creating a dialog window. You can use this class
to create a custom dialog, or invoke the many class methods
in JOptionPane to create a variety of standard dialogs.
For information about creating dialogs, see
The Java Tutorial section
How
to Make Dialogs.
The JDialog component contains a JRootPane
as its only child.
The contentPane should be the parent of any children of the
JDialog.
As a convenience add and its variants, remove and
setLayout have been overridden to forward to the
contentPane as necessary. This means you can write:
dialog.add(child);
And the child will be added to the contentPane.
The contentPane is always non-null.
Attempting to set it to null generates an exception.
The default contentPane has a BorderLayout
manager set on it.
Refer to RootPaneContainer
for details on adding, removing and setting the LayoutManager
of a JDialog.
Please see the JRootPane documentation for a complete
description of the contentPane, glassPane,
and layeredPane components.
In a multi-screen environment, you can create a JDialog
on a different screen device than its owner. See Frame for
more information.
Warning: Swing is not thread safe. For more
information see Swing's Threading
Policy.
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 applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans package.
Please see XMLEncoder.
- See Also:
JOptionPane,
JRootPane,
RootPaneContainer
|
Nested Class Summary |
protected class |
JDialog.AccessibleJDialog
This class implements accessibility support for the
JDialog class. |
|
Constructor Summary |
JDialog()
Creates a modeless dialog without a title and without a specified
Frame owner. |
JDialog(Dialog owner)
Creates a modeless dialog without a title with the
specified Dialog as its owner. |
JDialog(Dialog owner,
boolean modal)
Creates a dialog with the specified owner Dialog and modality. |
JDialog(Dialog owner,
String title)
Creates a modeless dialog with the specified title and
with the specified owner dialog. |
JDialog(Dialog owner,
String title,
boolean modal)
Creates a dialog with the specified title, modality
and the specified owner Dialog. |
JDialog(Dialog owner,
String title,
boolean modal,
GraphicsConfiguration gc)
Creates a dialog with the specified title, owner Dialog,
modality and GraphicsConfiguration. |
JDialog(Frame owner)
Creates a modeless dialog without a title with the
specified Frame as its owner. |
JDialog(Frame owner,
boolean modal)
Creates a dialog with the specified owner Frame, modality
and an empty title. |
JDialog(Frame owner,
String title)
Creates a modeless dialog with the specified title and
with the specified owner frame. |
JDialog(Frame owner,
String title,
boolean modal)
Creates a dialog with the specified title, owner Frame
and modality. |
JDialog(Frame owner,
String title,
boolean modal,
GraphicsConfiguration gc)
Creates a dialog with the specified title,
owner Frame, modality and GraphicsConfiguration. |
JDialog(Window owner)
Creates a modeless dialog with the specified owner Window and
an empty title. |
JDialog(Window owner,
Dialog.ModalityType modalityType)
Creates a dialog with the specified owner Window, modality
and an empty title. |
JDialog(Window owner,
String title)
Creates a modeless dialog with the specified title and owner
Window. |
JDialog(Window owner,
String title,
Dialog.ModalityType modalityType)
Creates a dialog with the specified title, owner Window and
modality. |
JDialog(Window owner,
String title,
Dialog.ModalityType modalityType,
GraphicsConfiguration gc)
Creates a dialog with the specified title, owner Window,
modality and GraphicsConfiguration. |
| Methods inherited from class java.awt.Dialog |
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack |
| Methods inherited from class java.awt.Window |
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, toFront |
| Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle |
rootPane
protected JRootPane rootPane
- See Also:
getRootPane(),
setRootPane(javax.swing.JRootPane)
rootPaneCheckingEnabled
protected boolean rootPaneCheckingEnabled
- If true then calls to
add and setLayout
will be forwarded to the contentPane. This is initially
false, but is set to true when the JDialog is constructed.
- See Also:
isRootPaneCheckingEnabled(),
setRootPaneCheckingEnabled(boolean),
RootPaneContainer
accessibleContext
protected AccessibleContext accessibleContext
JDialog
public JDialog()
- Creates a modeless dialog without a title and without a specified
Frame owner. A shared, hidden frame will be
set as the owner of the dialog.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
NOTE: This constructor does not allow you to create an unowned
JDialog. To create an unowned JDialog
you must use either the JDialog(Window) or
JDialog(Dialog) constructor with an argument of
null.
- Throws:
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.- See Also:
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Frame owner)
- Creates a modeless dialog without a title with the
specified
Frame as its owner. If owner
is null, a shared, hidden frame will be set as the
owner of the dialog.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
NOTE: This constructor does not allow you to create an unowned
JDialog. To create an unowned JDialog
you must use either the JDialog(Window) or
JDialog(Dialog) constructor with an argument of
null.
- Parameters:
owner - the Frame from which the dialog is displayed
- Throws:
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.- See Also:
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Frame owner,
boolean modal)
- Creates a dialog with the specified owner
Frame, modality
and an empty title. If owner is null,
a shared, hidden frame will be set as the owner of the dialog.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
NOTE: This constructor does not allow you to create an unowned
JDialog. To create an unowned JDialog
you must use either the JDialog(Window) or
JDialog(Dialog) constructor with an argument of
null.
- Parameters:
owner - the Frame from which the dialog is displayedmodal - specifies whether dialog blocks user input to other top-level
windows when shown. If true, the modality type property is set to
DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless.
- Throws:
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.- See Also:
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Frame owner,
String title)
- Creates a modeless dialog with the specified title and
with the specified owner frame. If
owner
is null, a shared, hidden frame will be set as the
owner of the dialog.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
NOTE: This constructor does not allow you to create an unowned
JDialog. To create an unowned JDialog
you must use either the JDialog(Window) or
JDialog(Dialog) constructor with an argument of
null.
- Parameters:
owner - the Frame from which the dialog is displayedtitle - the String to display in the dialog's
title bar
- Throws:
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.- See Also:
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Frame owner,
String title,
boolean modal)
- Creates a dialog with the specified title, owner
Frame
and modality. If owner is null,
a shared, hidden frame will be set as the owner of this dialog.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
NOTE: Any popup components (JComboBox,
JPopupMenu, JMenuBar)
created within a modal dialog will be forced to be lightweight.
NOTE: This constructor does not allow you to create an unowned
JDialog. To create an unowned JDialog
you must use either the JDialog(Window) or
JDialog(Dialog) constructor with an argument of
null.
- Parameters:
owner - the Frame from which the dialog is displayedtitle - the String to display in the dialog's
title barmodal - specifies whether dialog blocks user input to other top-level
windows when shown. If true, the modality type property is set to
DEFAULT_MODALITY_TYPE otherwise the dialog is modeless
- Throws:
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.- See Also:
Dialog.ModalityType,
Dialog.ModalityType.MODELESS,
Dialog.DEFAULT_MODALITY_TYPE,
Dialog.setModal(boolean),
Dialog.setModalityType(java.awt.Dialog.ModalityType),
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Frame owner,
String title,
boolean modal,
GraphicsConfiguration gc)
- Creates a dialog with the specified title,
owner
Frame, modality and GraphicsConfiguration.
If owner is null,
a shared, hidden frame will be set as the owner of this dialog.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
NOTE: Any popup components (JComboBox,
JPopupMenu, JMenuBar)
created within a modal dialog will be forced to be lightweight.
NOTE: This constructor does not allow you to create an unowned
JDialog. To create an unowned JDialog
you must use either the JDialog(Window) or
JDialog(Dialog) constructor with an argument of
null.
- Parameters:
owner - the Frame from which the dialog is displayedtitle - the String to display in the dialog's
title barmodal - specifies whether dialog blocks user input to other top-level
windows when shown. If true, the modality type property is set to
DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless.gc - the GraphicsConfiguration
of the target screen device. If gc is
null, the same
GraphicsConfiguration as the owning Frame is used.
- Throws:
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.- Since:
- 1.4
- See Also:
Dialog.ModalityType,
Dialog.ModalityType.MODELESS,
Dialog.DEFAULT_MODALITY_TYPE,
Dialog.setModal(boolean),
Dialog.setModalityType(java.awt.Dialog.ModalityType),
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Dialog owner)
- Creates a modeless dialog without a title with the
specified
Dialog as its owner.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
- Parameters:
owner - the owner Dialog from which the dialog is displayed
or null if this dialog has no owner
- Throws:
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.- See Also:
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Dialog owner,
boolean modal)
- Creates a dialog with the specified owner
Dialog and modality.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
- Parameters:
owner - the owner Dialog from which the dialog is displayed
or null if this dialog has no ownermodal - specifies whether dialog blocks user input to other top-level
windows when shown. If true, the modality type property is set to
DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless.
- Throws:
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.- See Also:
Dialog.ModalityType,
Dialog.ModalityType.MODELESS,
Dialog.DEFAULT_MODALITY_TYPE,
Dialog.setModal(boolean),
Dialog.setModalityType(java.awt.Dialog.ModalityType),
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Dialog owner,
String title)
- Creates a modeless dialog with the specified title and
with the specified owner dialog.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
- Parameters:
owner - the owner Dialog from which the dialog is displayed
or null if this dialog has no ownertitle - the String to display in the dialog's
title bar
- Throws:
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.- See Also:
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Dialog owner,
String title,
boolean modal)
- Creates a dialog with the specified title, modality
and the specified owner
Dialog.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
- Parameters:
owner - the owner Dialog from which the dialog is displayed
or null if this dialog has no ownertitle - the String to display in the dialog's
title barmodal - specifies whether dialog blocks user input to other top-level
windows when shown. If true, the modality type property is set to
DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless
- Throws:
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.- See Also:
Dialog.ModalityType,
Dialog.ModalityType.MODELESS,
Dialog.DEFAULT_MODALITY_TYPE,
Dialog.setModal(boolean),
Dialog.setModalityType(java.awt.Dialog.ModalityType),
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Dialog owner,
String title,
boolean modal,
GraphicsConfiguration gc)
- Creates a dialog with the specified title, owner
Dialog,
modality and GraphicsConfiguration.
NOTE: Any popup components (JComboBox,
JPopupMenu, JMenuBar)
created within a modal dialog will be forced to be lightweight.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
- Parameters:
owner - the owner Dialog from which the dialog is displayed
or null if this dialog has no ownertitle - the String to display in the dialog's
title barmodal - specifies whether dialog blocks user input to other top-level
windows when shown. If true, the modality type property is set to
DEFAULT_MODALITY_TYPE, otherwise the dialog is modelessgc - the GraphicsConfiguration
of the target screen device. If gc is
null, the same
GraphicsConfiguration as the owning Dialog is used.
- Throws:
HeadlessException - if GraphicsEnvironment.isHeadless()
returns true.- Since:
- 1.4
- See Also:
Dialog.ModalityType,
Dialog.ModalityType.MODELESS,
Dialog.DEFAULT_MODALITY_TYPE,
Dialog.setModal(boolean),
Dialog.setModalityType(java.awt.Dialog.ModalityType),
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Window owner)
- Creates a modeless dialog with the specified owner
Window and
an empty title.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
- Parameters:
owner - the Window from which the dialog is displayed or
null if this dialog has no owner
- Throws:
HeadlessException - when
GraphicsEnvironment.isHeadless() returns true- Since:
- 1.6
- See Also:
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Window owner,
Dialog.ModalityType modalityType)
- Creates a dialog with the specified owner
Window, modality
and an empty title.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
- Parameters:
owner - the Window from which the dialog is displayed or
null if this dialog has no ownermodalityType - specifies whether dialog blocks input to other
windows when shown. null value and unsupported modality
types are equivalent to MODELESS
- Throws:
HeadlessException - when
GraphicsEnvironment.isHeadless() returns true- Since:
- 1.6
- See Also:
Dialog.ModalityType,
Dialog.setModal(boolean),
Dialog.setModalityType(java.awt.Dialog.ModalityType),
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Window owner,
String title)
- Creates a modeless dialog with the specified title and owner
Window.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
- Parameters:
owner - the Window from which the dialog is displayed or
null if this dialog has no ownertitle - the String to display in the dialog's
title bar or null if the dialog has no title
- Throws:
HeadlessException - when
GraphicsEnvironment.isHeadless() returns true- Since:
- 1.6
- See Also:
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Window owner,
String title,
Dialog.ModalityType modalityType)
- Creates a dialog with the specified title, owner
Window and
modality.
This constructor sets the component's locale property to the value
returned by JComponent.getDefaultLocale.
- Parameters:
owner - the Window from which the dialog is displayed or
null if this dialog has no ownertitle - the String to display in the dialog's
title bar or null if the dialog has no titlemodalityType - specifies whether dialog blocks input to other
windows when shown. null value and unsupported modality
types are equivalent to MODELESS
- Throws:
HeadlessException - when
GraphicsEnvironment.isHeadless() returns true- Since:
- 1.6
- See Also:
Dialog.ModalityType,
Dialog.setModal(boolean),
Dialog.setModalityType(java.awt.Dialog.ModalityType),
GraphicsEnvironment.isHeadless(),
JComponent.getDefaultLocale()
JDialog
public JDialog(Window owner,
String title,
|