public class JDialog extends Dialog implements WindowConstants, Accessible, RootPaneContainer
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
.
JOptionPane
,
JRootPane
,
RootPaneContainer
Modifier and Type | Class and Description |
---|---|
protected class |
JDialog.AccessibleJDialog
This class implements accessibility support for the
JDialog class. |
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
Window.AccessibleAWTWindow, Window.Type
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Modifier and Type | Field and Description |
---|---|
protected AccessibleContext |
accessibleContext |
protected JRootPane |
rootPane |
protected boolean |
rootPaneCheckingEnabled
If true then calls to
add and setLayout
will be forwarded to the contentPane . |
DEFAULT_MODALITY_TYPE
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor and Description |
---|
JDialog()
Creates a modeless dialog without a title and without a specified
Frame owner. |
JDialog(Dialog owner)
Creates a modeless dialog with the specified
Dialog
as its owner and an empty title. |
JDialog(Dialog owner,
boolean modal)
Creates a dialog with an empty title and the specified modality and
Dialog as its owner. |
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 with the specified
Frame
as its owner and an empty title. |
JDialog(Frame owner,
boolean modal)
Creates a dialog with an empty title and the specified modality and
Frame as its owner. |
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
Window
as its owner and an empty title. |
JDialog(Window owner,
Dialog.ModalityType modalityType)
Creates a dialog with an empty title and the specified modality and
Window as its owner. |
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 . |
Modifier and Type | Method and Description |
---|---|
protected void |
addImpl(Component comp,
Object constraints,
int index)
Adds the specified child
Component . |
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. |
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
JDialog s should have their
Window decorations provided by the current look and feel. |
protected boolean |
isRootPaneCheckingEnabled()
Returns whether calls to
add and
setLayout are forwarded to the contentPane . |
protected String |
paramString()
Returns a string representation of this
JDialog . |
protected void |
processWindowEvent(WindowEvent e)
Handles window events depending on the state of the
defaultCloseOperation property. |
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
JDialog s
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 . |
protected void |
setRootPane(JRootPane root)
Sets the
rootPane property. |
protected void |
setRootPaneCheckingEnabled(boolean enabled)
Sets whether calls to
add and
setLayout are forwarded to the contentPane . |
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) . |
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront
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, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, 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, 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, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
protected JRootPane rootPane
protected boolean rootPaneCheckingEnabled
add
and setLayout
will be forwarded to the contentPane
. This is initially
false, but is set to true when the JDialog
is constructed.protected AccessibleContext accessibleContext
public JDialog()
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
.GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Frame owner)
Frame
as its owner 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 displayedHeadlessException
- if GraphicsEnvironment.isHeadless()
returns true
.GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Frame owner, boolean modal)
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 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.HeadlessException
- if GraphicsEnvironment.isHeadless()
returns true
.GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Frame owner, String title)
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 displayedtitle
- the String
to display in the dialog's
title barHeadlessException
- if GraphicsEnvironment.isHeadless()
returns true
.GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Frame owner, String title, boolean modal)
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 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 modelessHeadlessException
- if GraphicsEnvironment.isHeadless()
returns true
.Dialog.ModalityType
,
Dialog.ModalityType.MODELESS
,
Dialog.DEFAULT_MODALITY_TYPE
,
Dialog.setModal(boolean)
,
Dialog.setModalityType(java.awt.Dialog.ModalityType)
,
GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Frame owner, String title, boolean modal, GraphicsConfiguration gc)
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 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 null
, the default system GraphicsConfiguration
is assumedHeadlessException
- if GraphicsEnvironment.isHeadless()
returns true
.Dialog.ModalityType
,
Dialog.ModalityType.MODELESS
,
Dialog.DEFAULT_MODALITY_TYPE
,
Dialog.setModal(boolean)
,
Dialog.setModalityType(java.awt.Dialog.ModalityType)
,
GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Dialog owner)
Dialog
as its owner and an empty title.
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 ownerHeadlessException
- if GraphicsEnvironment.isHeadless()
returns true
.GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Dialog owner, boolean modal)
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 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.HeadlessException
- if GraphicsEnvironment.isHeadless()
returns true
.Dialog.ModalityType
,
Dialog.ModalityType.MODELESS
,
Dialog.DEFAULT_MODALITY_TYPE
,
Dialog.setModal(boolean)
,
Dialog.setModalityType(java.awt.Dialog.ModalityType)
,
GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Dialog owner, String title)
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 ownertitle
- the String
to display in the dialog's
title barHeadlessException
- if GraphicsEnvironment.isHeadless()
returns true
.GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Dialog owner, String title, boolean modal)
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 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 modelessHeadlessException
- if GraphicsEnvironment.isHeadless()
returns true
.Dialog.ModalityType
,
Dialog.ModalityType.MODELESS
,
Dialog.DEFAULT_MODALITY_TYPE
,
Dialog.setModal(boolean)
,
Dialog.setModalityType(java.awt.Dialog.ModalityType)
,
GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Dialog owner, String title, boolean modal, GraphicsConfiguration gc)
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 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 null
, the default system GraphicsConfiguration
is assumedHeadlessException
- if GraphicsEnvironment.isHeadless()
returns true
.Dialog.ModalityType
,
Dialog.ModalityType.MODELESS
,
Dialog.DEFAULT_MODALITY_TYPE
,
Dialog.setModal(boolean)
,
Dialog.setModalityType(java.awt.Dialog.ModalityType)
,
GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Window owner)
Window
as its owner 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 ownerIllegalArgumentException
- if the owner
is not an instance of Dialog
or Frame
IllegalArgumentException
- if the owner
's GraphicsConfiguration
is not from a screen deviceHeadlessException
- when GraphicsEnvironment.isHeadless()
returns true
GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Window owner, Dialog.ModalityType modalityType)
Window
as its owner.
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 ownermodalityType
- specifies whether dialog blocks input to other
windows when shown. null
value and unsupported modality
types are equivalent to MODELESS
IllegalArgumentException
- if the owner
is not an instance of Dialog
or Frame
IllegalArgumentException
- if the owner
's GraphicsConfiguration
is not from a screen deviceHeadlessException
- when GraphicsEnvironment.isHeadless()
returns true
SecurityException
- if the calling thread does not have permission to create modal dialogs
with the given modalityType
Dialog.ModalityType
,
Dialog.setModal(boolean)
,
Dialog.setModalityType(java.awt.Dialog.ModalityType)
,
GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Window owner, String title)
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 ownertitle
- the String
to display in the dialog's
title bar or null
if the dialog has no titleIllegalArgumentException
- if the owner
is not an instance of Dialog
or Frame
IllegalArgumentException
- if the owner
's GraphicsConfiguration
is not from a screen deviceHeadlessException
- when GraphicsEnvironment.isHeadless()
returns true
GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Window owner, String title, Dialog.ModalityType modalityType)
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 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
IllegalArgumentException
- if the owner
is not an instance of Dialog
or Frame
IllegalArgumentException
- if the owner
's GraphicsConfiguration
is not from a screen deviceHeadlessException
- when GraphicsEnvironment.isHeadless()
returns true
SecurityException
- if the calling thread does not have permission to create modal dialogs
with the given modalityType
Dialog.ModalityType
,
Dialog.setModal(boolean)
,
Dialog.setModalityType(java.awt.Dialog.ModalityType)
,
GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
public JDialog(Window owner, String title, Dialog.ModalityType modalityType, GraphicsConfiguration gc)
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 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
gc
- the GraphicsConfiguration
of the target screen device;
if null
, the default system GraphicsConfiguration
is assumedIllegalArgumentException
- if the owner
is not an instance of Dialog
or Frame
IllegalArgumentException
- if the owner
's GraphicsConfiguration
is not from a screen deviceHeadlessException
- when GraphicsEnvironment.isHeadless()
returns true
SecurityException
- if the calling thread does not have permission to create modal dialogs
with the given modalityType
Dialog.ModalityType
,
Dialog.setModal(boolean)
,
Dialog.setModalityType(java.awt.Dialog.ModalityType)
,
GraphicsEnvironment.isHeadless()
,
JComponent.getDefaultLocale()
protected void dialogInit()
JDialog
properly.protected JRootPane createRootPane()
rootPane
.protected void processWindowEvent(WindowEvent e)
defaultCloseOperation
property.processWindowEvent
in class Window
e
- the window eventsetDefaultCloseOperation(int)
public void setDefaultCloseOperation(int operation)
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 dialogIllegalArgumentException
- if defaultCloseOperation value
isn't one of the above valid valuesWindow.addWindowListener(java.awt.event.WindowListener)
,
getDefaultCloseOperation()
,
WindowConstants
public int getDefaultCloseOperation()
setDefaultCloseOperation(int)
public void setTransferHandler(TransferHandler newHandler)
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
TransferHandler
,
getTransferHandler()
,
Component.setDropTarget(java.awt.dnd.DropTarget)
public TransferHandler getTransferHandler()
transferHandler
property.transferHandler
propertyTransferHandler
,
setTransferHandler(javax.swing.TransferHandler)
public void update(Graphics g)
paint(g)
. This method was overridden to
prevent an unnecessary call to clear the background.update
in class Container
g
- the Graphics
context in which to paintComponent.update(Graphics)
public void setJMenuBar(JMenuBar menu)
menu
- the menubar being placed in the dialoggetJMenuBar()
public JMenuBar getJMenuBar()
setJMenuBar(javax.swing.JMenuBar)
protected boolean isRootPaneCheckingEnabled()
add
and
setLayout
are forwarded to the contentPane
.add
and setLayout
are fowarded; false otherwiseaddImpl(java.awt.Component, java.lang.Object, int)
,
setLayout(java.awt.LayoutManager)
,
setRootPaneCheckingEnabled(boolean)
,
RootPaneContainer
protected void setRootPaneCheckingEnabled(boolean enabled)
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
.addImpl(java.awt.Component, java.lang.Object, int)
,
setLayout(java.awt.LayoutManager)
,
isRootPaneCheckingEnabled()
,
RootPaneContainer
protected void addImpl(Component comp, Object constraints, int index)
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.addImpl
in class Container
comp
- the component to be enhancedconstraints
- the constraints to be respectedindex
- the indexIllegalArgumentException
- if index
is invalidIllegalArgumentException
- if adding the container's parent
to itselfIllegalArgumentException
- if adding a window to a containersetRootPaneCheckingEnabled(boolean)
,
RootPaneContainer
public void remove(Component comp)
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
.remove
in class Container
comp
- the component to be removedNullPointerException
- if comp
is nullContainer.add(java.awt.Component)
,
RootPaneContainer
public void setLayout(LayoutManager manager)
LayoutManager
.
Overridden to conditionally forward the call to the
contentPane
.
Refer to RootPaneContainer
for
more information.setLayout
in class Container
manager
- the LayoutManager
setRootPaneCheckingEnabled(boolean)
,
RootPaneContainer
public JRootPane getRootPane()
rootPane
object for this dialog.getRootPane
in interface RootPaneContainer
setRootPane(javax.swing.JRootPane)
,
RootPaneContainer.getRootPane()
protected void setRootPane(JRootPane root)
rootPane
property.
This method is called by the constructor.root
- the rootPane
object for this dialoggetRootPane()
public Container getContentPane()
contentPane
object for this dialog.getContentPane
in interface RootPaneContainer
contentPane
propertysetContentPane(java.awt.Container)
,
RootPaneContainer.getContentPane()
public void setContentPane(Container contentPane)
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
.
setContentPane
in interface RootPaneContainer
contentPane
- the contentPane
object for this dialogIllegalComponentStateException
- (a runtime
exception) if the content pane parameter is null
JRootPane
,
getContentPane()
,
RootPaneContainer.setContentPane(java.awt.Container)
public JLayeredPane getLayeredPane()
layeredPane
object for this dialog.getLayeredPane
in interface RootPaneContainer
layeredPane
propertysetLayeredPane(javax.swing.JLayeredPane)
,
RootPaneContainer.getLayeredPane()
public void setLayeredPane(JLayeredPane layeredPane)
layeredPane
property.
This method is called by the constructor.setLayeredPane
in interface RootPaneContainer
layeredPane
- the new layeredPane
propertyIllegalComponentStateException
- (a runtime
exception) if the layered pane parameter is nullgetLayeredPane()
,
RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)
public Component getGlassPane()
glassPane
object for this dialog.getGlassPane
in interface RootPaneContainer
glassPane
propertysetGlassPane(java.awt.Component)
,
RootPaneContainer.getGlassPane()
public void setGlassPane(Component glassPane)
glassPane
property.
This method is called by the constructor.setGlassPane
in interface RootPaneContainer
glassPane
- the glassPane
object for this dialoggetGlassPane()
,
RootPaneContainer.setGlassPane(java.awt.Component)
public Graphics getGraphics()
null
if this component is currently not
displayable.getGraphics
in class Component
null
if it has noneComponent.paint(java.awt.Graphics)
public void repaint(long time, int x, int y, int width, int height)
time
milliseconds. Refer to RepaintManager
for details on how the repaint is handled.repaint
in class Component
time
- maximum time in milliseconds before updatex
- the x coordinatey
- the y coordinatewidth
- the widthheight
- the heightRepaintManager
public static void setDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated)
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 decorationsLookAndFeel.getSupportsWindowDecorations()
public static boolean isDefaultLookAndFeelDecorated()
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.protected String paramString()
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
.paramString
in class Dialog
JDialog
.public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class Dialog
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.