public class

JDialog

extends Dialog
implements Accessible RootPaneContainer WindowConstants
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ java.awt.Window
         ↳ java.awt.Dialog
           ↳ javax.swing.JDialog
Known Direct Subclasses

Class Overview

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.

Summary

Nested Classes
class JDialog.AccessibleJDialog This class implements accessibility support for the JDialog class. 
[Expand]
Inherited Constants
From class java.awt.Component
From interface java.awt.image.ImageObserver
From interface javax.swing.WindowConstants
Fields
protected AccessibleContext accessibleContext
protected JRootPane rootPane
protected boolean rootPaneCheckingEnabled If true then calls to add and setLayout will be forwarded to the contentPane.
[Expand]
Inherited Fields
From class java.awt.Dialog
Public Constructors
JDialog()
Creates a modeless dialog without a title and without a specified Frame owner.
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(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(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.
Public Methods
AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JDialog.
Container getContentPane()
Returns the contentPane object for this dialog.
int getDefaultCloseOperation()
Returns the operation which occurs when the user initiates a "close" on this dialog.
Component getGlassPane()
Returns the glassPane object for this dialog.
Graphics getGraphics()
Creates a graphics context for this component.
JMenuBar getJMenuBar()
Returns the menubar set on this dialog.
JLayeredPane getLayeredPane()
Returns the layeredPane object for this dialog.
JRootPane getRootPane()
Returns the rootPane object for this dialog.
TransferHandler getTransferHandler()
Gets the transferHandler property.
static boolean isDefaultLookAndFeelDecorated()
Returns true if newly created JDialogs should have their Window decorations provided by the current look and feel.
void remove(Component comp)
Removes the specified component from the container.
void repaint(long time, int x, int y, int width, int height)
Repaints the specified rectangle of this component within time milliseconds.
void setContentPane(Container contentPane)
Sets the contentPane property.
void setDefaultCloseOperation(int operation)
Sets the operation that will happen by default when the user initiates a "close" on this dialog.
static void setDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated)
Provides a hint as to whether or not newly created JDialogs should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel.
void setGlassPane(Component glassPane)
Sets the glassPane property.
void setJMenuBar(JMenuBar menu)
Sets the menubar for this dialog.
void setLayeredPane(JLayeredPane layeredPane)
Sets the layeredPane property.
void setLayout(LayoutManager manager)
Sets the LayoutManager.
void setTransferHandler(TransferHandler newHandler)
Sets the transferHandler property, which is a mechanism to support transfer of data into this component.
void update(Graphics g)
Calls paint(g).
Protected Methods
void addImpl(Component comp, Object constraints, int index)
Adds the specified child Component.
JRootPane createRootPane()
Called by the constructor methods to create the default rootPane.
void dialogInit()
Called by the constructors to init the JDialog properly.
boolean isRootPaneCheckingEnabled()
Returns whether calls to add and setLayout are forwarded to the contentPane.
String paramString()
Returns a string representation of this JDialog.
void processWindowEvent(WindowEvent e)
Handles window events depending on the state of the defaultCloseOperation property.
void setRootPane(JRootPane root)
Sets the rootPane property.
void setRootPaneCheckingEnabled(boolean enabled)
Sets whether calls to add and setLayout are forwarded to the contentPane.
[Expand]
Inherited Methods
From class java.awt.Dialog
From class java.awt.Window
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface javax.accessibility.Accessible
From interface javax.swing.RootPaneContainer

Fields

protected AccessibleContext accessibleContext

protected JRootPane rootPane

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.

Public Constructors

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.

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.

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 displayed
modal 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.

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 displayed
title the String to display in the dialog's title bar
Throws
HeadlessException if GraphicsEnvironment.isHeadless() returns true.

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 displayed
title the String to display in the dialog's title bar
modal 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.

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 displayed
title the String to display in the dialog's title bar
modal 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.

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.

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 owner
modal 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.

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 owner
title the String to display in the dialog's title bar
Throws
HeadlessException if GraphicsEnvironment.isHeadless() returns true.

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 owner
title the String to display in the dialog's title bar
modal 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.

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 owner
title the String to display in the dialog's title bar
modal 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 Dialog is used.
Throws
HeadlessException if GraphicsEnvironment.isHeadless() returns true.

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

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 owner
modalityType 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

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 owner
title 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

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 owner
title the String to display in the dialog's title bar or null if the dialog has no title
modalityType 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

public JDialog (Window owner, String title, Dialog.ModalityType modalityType, GraphicsConfiguration gc)

Creates a dialog with the specified title, owner Window, 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 Window from which the dialog is displayed or null if this dialog has no owner
title the String to display in the dialog's title bar or null if the dialog has no title
modalityType specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS
gc the GraphicsConfiguration of the target screen device; if null, the GraphicsConfiguration from the owning window is used; if owner is also null, the system default GraphicsConfiguration is assumed
Throws
HeadlessException when GraphicsEnvironment.isHeadless() returns true

Public Methods

public AccessibleContext getAccessibleContext ()

Gets the AccessibleContext associated with this JDialog. For JDialogs, the AccessibleContext takes the form of an AccessibleJDialog. A new AccessibleJDialog instance is created if necessary.

Returns
  • an AccessibleJDialog that serves as the AccessibleContext of this JDialog

public Container getContentPane ()

Returns the contentPane object for this dialog.

Returns
  • the contentPane property

public int getDefaultCloseOperation ()

Returns the operation which occurs when the user initiates a "close" on this dialog.

Returns
  • an integer indicating the window-close operation

public Component getGlassPane ()

Returns the glassPane object for this dialog.

Returns
  • the glassPane property

public Graphics getGraphics ()

Creates a graphics context for this component. This method will return null if this component is currently not displayable.

Returns
  • a graphics context for this component, or null if it has none

public JMenuBar getJMenuBar ()

Returns the menubar set on this dialog.

public JLayeredPane getLayeredPane ()

Returns the layeredPane object for this dialog.

Returns
  • the layeredPane property

public JRootPane getRootPane ()

Returns the rootPane object for this dialog.

Returns
  • this components single JRootPane child.

public TransferHandler getTransferHandler ()

Gets the transferHandler property.

Returns
  • the value of the transferHandler property

public static boolean isDefaultLookAndFeelDecorated ()

Returns true if newly created JDialogs should have their Window decorations provided by the current look and feel. This is only a hint, as certain look and feels may not support this feature.

Returns
  • true if look and feel should provide Window decorations.

public void remove (Component comp)

Removes the specified component from the container. If comp is not the rootPane, this will forward the call to the contentPane. This will do nothing if comp is not a child of the JDialog or contentPane.

Parameters
comp the component to be removed
Throws
NullPointerException if comp is null

public void repaint (long time, int x, int y, int width, int height)

Repaints the specified rectangle of this component within time milliseconds. Refer to RepaintManager for details on how the repaint is handled.

Parameters
time maximum time in milliseconds before update
x the x coordinate
y the y coordinate
width the width
height the height
See Also

public void setContentPane (Container contentPane)

Sets the contentPane property. This method is called by the constructor.

Swing's painting architecture requires an opaque JComponent in the containment hiearchy. This is typically provided by the content pane. If you replace the content pane it is recommended you replace it with an opaque JComponent.

Parameters
contentPane the contentPane object for this dialog
Throws
IllegalComponentStateException (a runtime exception) if the content pane parameter is null

public void setDefaultCloseOperation (int operation)

Sets the operation that will happen by default when the user initiates a "close" on this dialog. You must specify one of the following choices:

  • DO_NOTHING_ON_CLOSE (defined in WindowConstants): Don't do anything; require the program to handle the operation in the windowClosing method of a registered WindowListener object.
  • HIDE_ON_CLOSE (defined in WindowConstants): Automatically hide the dialog after invoking any registered WindowListener objects.
  • DISPOSE_ON_CLOSE (defined in WindowConstants): Automatically hide and dispose the dialog after invoking any registered WindowListener objects.

The value is set to HIDE_ON_CLOSE by default. Changes to the value of this property cause the firing of a property change event, with property name "defaultCloseOperation".

Note: When the last displayable window within the Java virtual machine (VM) is disposed of, the VM may terminate. See AWT Threading Issues for more information.

Parameters
operation the operation which should be performed when the user closes the dialog
Throws
IllegalArgumentException if defaultCloseOperation value isn't one of the above valid values

public static void setDefaultLookAndFeelDecorated (boolean defaultLookAndFeelDecorated)

Provides a hint as to whether or not newly created JDialogs should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel. If defaultLookAndFeelDecorated is true, the current LookAndFeel supports providing window decorations, and the current window manager supports undecorated windows, then newly created JDialogs will have their Window decorations provided by the current LookAndFeel. Otherwise, newly created JDialogs will have their Window decorations provided by the current window manager.

You can get the same effect on a single JDialog by doing the following:

    JDialog dialog = new JDialog();
    dialog.setUndecorated(true);
    dialog.getRootPane().setWindowDecorationStyle(JRootPane.PLAIN_DIALOG);
 

Parameters
defaultLookAndFeelDecorated A hint as to whether or not current look and feel should provide window decorations

public void setGlassPane (Component glassPane)

Sets the glassPane property. This method is called by the constructor.

Parameters
glassPane the glassPane object for this dialog

public void setJMenuBar (JMenuBar menu)

Sets the menubar for this dialog.

Parameters
menu the menubar being placed in the dialog
See Also

public void setLayeredPane (JLayeredPane layeredPane)

Sets the layeredPane property. This method is called by the constructor.

Parameters
layeredPane the new layeredPane property
Throws
IllegalComponentStateException (a runtime exception) if the layered pane parameter is null

public void setLayout (LayoutManager manager)

Sets the LayoutManager. Overridden to conditionally forward the call to the contentPane. Refer to RootPaneContainer for more information.

Parameters
manager the LayoutManager

public void setTransferHandler (TransferHandler newHandler)

Sets the transferHandler property, which is a mechanism to support transfer of data into this component. Use null if the component does not support data transfer operations.

If the system property suppressSwingDropSupport is false (the default) and the current drop target on this component is either null or not a user-set drop target, this method will change the drop target as follows: If newHandler is null it will clear the drop target. If not null it will install a new DropTarget.

Note: When used with JDialog, TransferHandler only provides data import capability, as the data export related methods are currently typed to JComponent.

Please see How to Use Drag and Drop and Data Transfer, a section in The Java Tutorial, for more information.

Parameters
newHandler the new TransferHandler

public void update (Graphics g)

Calls paint(g). This method was overridden to prevent an unnecessary call to clear the background.

Parameters
g the Graphics context in which to paint

Protected Methods

protected void addImpl (Component comp, Object constraints, int index)

Adds the specified child Component. This method is overridden to conditionally forward calls to the contentPane. By default, children are added to the contentPane instead of the frame, refer to RootPaneContainer for details.

Parameters
comp the component to be enhanced
constraints the constraints to be respected
index the index
Throws
IllegalArgumentException if index is invalid
IllegalArgumentException if adding the container's parent to itself
IllegalArgumentException if adding a window to a container

protected JRootPane createRootPane ()

Called by the constructor methods to create the default rootPane.

protected void dialogInit ()

Called by the constructors to init the JDialog properly.

protected boolean isRootPaneCheckingEnabled ()

Returns whether calls to add and setLayout are forwarded to the contentPane.

Returns
  • true if add and setLayout are fowarded; false otherwise

protected String paramString ()

Returns a string representation of this JDialog. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Returns
  • a string representation of this JDialog.

protected void processWindowEvent (WindowEvent e)

Handles window events depending on the state of the defaultCloseOperation property.

Parameters
e the window event

protected void setRootPane (JRootPane root)

Sets the rootPane property. This method is called by the constructor.

Parameters
root the rootPane object for this dialog
See Also

protected void setRootPaneCheckingEnabled (boolean enabled)

Sets whether calls to add and setLayout are forwarded to the contentPane.

Parameters
enabled true if add and setLayout are forwarded, false if they should operate directly on the JDialog.