java.lang.Object | |||||
↳ | java.awt.Component | ||||
↳ | java.awt.Container | ||||
↳ | java.awt.Window | ||||
↳ | java.awt.Dialog | ||||
↳ | javax.swing.JDialog |
![]() |
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
.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
JDialog.AccessibleJDialog | This class implements accessibility support for the
JDialog class. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
accessibleContext | |||||||||||
rootPane | |||||||||||
rootPaneCheckingEnabled | If true then calls to add and setLayout
will be forwarded to the contentPane . |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a modeless dialog without a title and without a specified
Frame owner. | |||||||||||
Creates a modeless dialog without a title with the
specified
Frame as its owner. | |||||||||||
Creates a dialog with the specified owner
Frame , modality
and an empty title. | |||||||||||
Creates a modeless dialog with the specified title and
with the specified owner frame.
| |||||||||||
Creates a dialog with the specified title, owner
Frame
and modality. | |||||||||||
Creates a dialog with the specified title,
owner
Frame , modality and GraphicsConfiguration . | |||||||||||
Creates a modeless dialog without a title with the
specified
Dialog as its owner. | |||||||||||
Creates a dialog with the specified owner
Dialog and modality. | |||||||||||
Creates a modeless dialog with the specified title and
with the specified owner dialog.
| |||||||||||
Creates a dialog with the specified title, modality
and the specified owner
Dialog . | |||||||||||
Creates a dialog with the specified title, owner
Dialog ,
modality and GraphicsConfiguration . | |||||||||||
Creates a modeless dialog with the specified owner
Window and
an empty title. | |||||||||||
Creates a dialog with the specified owner
Window , modality
and an empty title. | |||||||||||
Creates a modeless dialog with the specified title and owner
Window . | |||||||||||
Creates a dialog with the specified title, owner
Window and
modality. | |||||||||||
Creates a dialog with the specified title, owner
Window ,
modality and GraphicsConfiguration . |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Gets the AccessibleContext associated with this JDialog.
| |||||||||||
Returns the
contentPane object for this dialog. | |||||||||||
Returns the operation which occurs when the user
initiates a "close" on this dialog.
| |||||||||||
Returns the
glassPane object for this dialog. | |||||||||||
Creates a graphics context for this component.
| |||||||||||
Returns the menubar set on this dialog.
| |||||||||||
Returns the
layeredPane object for this dialog. | |||||||||||
Returns the
rootPane object for this dialog. | |||||||||||
Gets the
transferHandler property. | |||||||||||
Returns true if newly created
JDialog s should have their
Window decorations provided by the current look and feel. | |||||||||||
Removes the specified component from the container.
| |||||||||||
Repaints the specified rectangle of this component within
time milliseconds. | |||||||||||
Sets the
contentPane property. | |||||||||||
Sets the operation that will happen by default when
the user initiates a "close" on this dialog.
| |||||||||||
Provides a hint as to whether or not newly created
JDialog s
should have their Window decorations (such as borders, widgets to
close the window, title...) provided by the current look
and feel. | |||||||||||
Sets the
glassPane property. | |||||||||||
Sets the menubar for this dialog.
| |||||||||||
Sets the
layeredPane property. | |||||||||||
Sets the
LayoutManager . | |||||||||||
Sets the
transferHandler property, which is a mechanism to
support transfer of data into this component. | |||||||||||
Calls
paint(g) . |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds the specified child
Component . | |||||||||||
Called by the constructor methods to create the default
rootPane . | |||||||||||
Called by the constructors to init the
JDialog properly. | |||||||||||
Returns whether calls to
add and
setLayout are forwarded to the contentPane . | |||||||||||
Returns a string representation of this
JDialog . | |||||||||||
Handles window events depending on the state of the
defaultCloseOperation property. | |||||||||||
Sets the
rootPane property. | |||||||||||
Sets whether calls to
add and
setLayout are forwarded to the contentPane . |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
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.
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
.
HeadlessException | if GraphicsEnvironment.isHeadless()
returns true . |
---|
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
.
owner | the Frame from which the dialog is displayed |
---|
HeadlessException | if GraphicsEnvironment.isHeadless()
returns true . |
---|
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
.
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. |
HeadlessException | if GraphicsEnvironment.isHeadless()
returns true . |
---|
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
.
owner | the Frame from which the dialog is displayed |
---|---|
title | the String to display in the dialog's
title bar |
HeadlessException | if GraphicsEnvironment.isHeadless()
returns true . |
---|
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
.
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 |
HeadlessException | if GraphicsEnvironment.isHeadless()
returns true . |
---|
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
.
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. |
HeadlessException | if GraphicsEnvironment.isHeadless()
returns true . |
---|
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
.
owner | the owner Dialog from which the dialog is displayed
or null if this dialog has no owner |
---|
HeadlessException | if GraphicsEnvironment.isHeadless()
returns true . |
---|
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
.
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. |
HeadlessException | if GraphicsEnvironment.isHeadless()
returns true . |
---|
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
.
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 |
HeadlessException | if GraphicsEnvironment.isHeadless()
returns true . |
---|
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
.
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 |
HeadlessException | if GraphicsEnvironment.isHeadless()
returns true . |
---|
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
.
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. |
HeadlessException | if GraphicsEnvironment.isHeadless()
returns true . |
---|
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
.
owner | the Window from which the dialog is displayed or
null if this dialog has no owner |
---|
HeadlessException | when
GraphicsEnvironment.isHeadless() returns true |
---|
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
.
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 |
HeadlessException | when
GraphicsEnvironment.isHeadless() returns true |
---|
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
.
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 |
HeadlessException | when
GraphicsEnvironment.isHeadless() returns true |
---|
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
.
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 |
HeadlessException | when
GraphicsEnvironment.isHeadless() returns true |
---|
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
.
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 |
HeadlessException | when
GraphicsEnvironment.isHeadless() returns true |
---|
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 the contentPane
object for this dialog.
contentPane
propertyReturns the operation which occurs when the user initiates a "close" on this dialog.
Returns the glassPane
object for this dialog.
glassPane
propertyCreates a graphics context for this component. This method will
return null
if this component is currently not
displayable.
null
if it has noneReturns the layeredPane
object for this dialog.
layeredPane
propertyReturns the rootPane
object for this dialog.
Gets the transferHandler
property.
transferHandler
propertyReturns true if newly created JDialog
s 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.
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
.
comp | the component to be removed |
---|
NullPointerException | if comp is null |
---|
Repaints the specified rectangle of this component within
time
milliseconds. Refer to RepaintManager
for details on how the repaint is handled.
time | maximum time in milliseconds before update |
---|---|
x | the x coordinate |
y | the y coordinate |
width | the width |
height | the height |
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
.
contentPane | the contentPane object for this dialog |
---|
IllegalComponentStateException | (a runtime
exception) if the content pane parameter is null |
---|
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.
operation | the operation which should be performed when the user closes the dialog |
---|
IllegalArgumentException | if defaultCloseOperation value isn't one of the above valid values |
---|
Provides a hint as to whether or not newly created JDialog
s
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 JDialog
s will have their
Window decorations provided by the current LookAndFeel
.
Otherwise, newly created JDialog
s 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);
defaultLookAndFeelDecorated | A hint as to whether or not current look and feel should provide window decorations |
---|
Sets the glassPane
property.
This method is called by the constructor.
glassPane | the glassPane object for this dialog |
---|
Sets the menubar for this dialog.
menu | the menubar being placed in the dialog |
---|
Sets the layeredPane
property.
This method is called by the constructor.
layeredPane | the new layeredPane property |
---|
IllegalComponentStateException | (a runtime exception) if the layered pane parameter is null |
---|
Sets the LayoutManager
.
Overridden to conditionally forward the call to the
contentPane
.
Refer to RootPaneContainer
for
more information.
manager | the LayoutManager |
---|
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.
newHandler | the new TransferHandler |
---|
Calls paint(g)
. This method was overridden to
prevent an unnecessary call to clear the background.
g | the Graphics context in which to paint
|
---|
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.
comp | the component to be enhanced |
---|---|
constraints | the constraints to be respected |
index | the index |
IllegalArgumentException | if index is invalid |
---|---|
IllegalArgumentException | if adding the container's parent to itself |
IllegalArgumentException | if adding a window to a container |
Called by the constructor methods to create the default
rootPane
.
Called by the constructors to init the JDialog
properly.
Returns whether calls to add
and
setLayout
are forwarded to the contentPane
.
add
and setLayout
are fowarded; false otherwiseReturns 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
.
JDialog
.
Handles window events depending on the state of the
defaultCloseOperation
property.
e | the window event |
---|
Sets the rootPane
property.
This method is called by the constructor.
root | the rootPane object for this dialog |
---|
Sets whether calls to add
and
setLayout
are forwarded to the contentPane
.
enabled | true if add and setLayout
are forwarded, false if they should operate directly on the
JDialog . |
---|