- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
,RootPaneContainer
,WindowConstants
@JavaBean(defaultProperty="JMenuBar", description="A toplevel window for creating dialog boxes.") 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, the add
, remove
, and setLayout
methods of this class are overridden, so that they delegate calls
to the corresponding methods of the ContentPane
.
For example, you can add a child component to a dialog as follows:
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 JavaBeans™
has been added to the java.beans
package.
Please see XMLEncoder
.
- Since:
- 1.2
- See Also:
JOptionPane
,JRootPane
,RootPaneContainer
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
JDialog.AccessibleJDialog
This class implements accessibility support for theJDialog
class.Nested classes/interfaces declared in class java.awt.Dialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType
Nested classes/interfaces declared in class java.awt.Window
Window.AccessibleAWTWindow, Window.Type
Nested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
Fields Modifier and Type Field Description protected AccessibleContext
accessibleContext
AccessibleContext
associated with thisJDialog
protected JRootPane
rootPane
protected boolean
rootPaneCheckingEnabled
If true then calls toadd
andsetLayout
will be forwarded to thecontentPane
.Fields declared in class java.awt.Dialog
DEFAULT_MODALITY_TYPE
Fields declared in class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Fields declared in interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
-
Constructor Summary
Constructors Constructor Description JDialog()
Creates a modeless dialog without a title and without a specifiedFrame
owner.JDialog(Dialog owner)
Creates a modeless dialog with the specifiedDialog
as its owner and an empty title.JDialog(Dialog owner, boolean modal)
Creates a dialog with an empty title and the specified modality andDialog
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 ownerDialog
.JDialog(Dialog owner, String title, boolean modal, GraphicsConfiguration gc)
Creates a dialog with the specified title, ownerDialog
, modality andGraphicsConfiguration
.JDialog(Frame owner)
Creates a modeless dialog with the specifiedFrame
as its owner and an empty title.JDialog(Frame owner, boolean modal)
Creates a dialog with an empty title and the specified modality andFrame
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, ownerFrame
and modality.JDialog(Frame owner, String title, boolean modal, GraphicsConfiguration gc)
Creates a dialog with the specified title, ownerFrame
, modality andGraphicsConfiguration
.JDialog(Window owner)
Creates a modeless dialog with the specifiedWindow
as its owner and an empty title.JDialog(Window owner, Dialog.ModalityType modalityType)
Creates a dialog with an empty title and the specified modality andWindow
as its owner.JDialog(Window owner, String title)
Creates a modeless dialog with the specified title and ownerWindow
.JDialog(Window owner, String title, Dialog.ModalityType modalityType)
Creates a dialog with the specified title, ownerWindow
and modality.JDialog(Window owner, String title, Dialog.ModalityType modalityType, GraphicsConfiguration gc)
Creates a dialog with the specified title, ownerWindow
, modality andGraphicsConfiguration
. -
Method Summary
Modifier and Type Method Description protected void
addImpl(Component comp, Object constraints, int index)
Adds the specified childComponent
.protected JRootPane
createRootPane()
Called by the constructor methods to create the defaultrootPane
.protected void
dialogInit()
Called by the constructors to init theJDialog
properly.AccessibleContext
getAccessibleContext()
Gets the AccessibleContext associated with this JDialog.Container
getContentPane()
Returns thecontentPane
object for this dialog.int
getDefaultCloseOperation()
Returns the operation which occurs when the user initiates a "close" on this dialog.Component
getGlassPane()
Returns theglassPane
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 thelayeredPane
object for this dialog.JRootPane
getRootPane()
Returns therootPane
object for this dialog.TransferHandler
getTransferHandler()
Gets thetransferHandler
property.static boolean
isDefaultLookAndFeelDecorated()
Returns true if newly createdJDialog
s should have their Window decorations provided by the current look and feel.protected boolean
isRootPaneCheckingEnabled()
Returns whether calls toadd
andsetLayout
are forwarded to thecontentPane
.protected String
paramString()
Returns a string representation of thisJDialog
.protected void
processWindowEvent(WindowEvent e)
Handles window events depending on the state of thedefaultCloseOperation
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 withintime
milliseconds.void
setContentPane(Container contentPane)
Sets thecontentPane
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 createdJDialog
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 theglassPane
property.void
setJMenuBar(JMenuBar menu)
Sets the menubar for this dialog.void
setLayeredPane(JLayeredPane layeredPane)
Sets thelayeredPane
property.void
setLayout(LayoutManager manager)
Sets theLayoutManager
.protected void
setRootPane(JRootPane root)
Sets therootPane
property.protected void
setRootPaneCheckingEnabled(boolean enabled)
Sets whether calls toadd
andsetLayout
are forwarded to thecontentPane
.void
setTransferHandler(TransferHandler newHandler)
Sets thetransferHandler
property, which is a mechanism to support transfer of data into this component.void
update(Graphics g)
Callspaint(g)
.Methods declared in class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack
Methods declared in class java.awt.Window
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, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBackground, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setOpacity, setShape, setSize, setSize, setType, toFront
Methods declared in 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, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
Methods declared in 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Field Details
-
rootPane
- See Also:
getRootPane()
,setRootPane(javax.swing.JRootPane)
-
rootPaneCheckingEnabled
protected boolean rootPaneCheckingEnabledIf true then calls toadd
andsetLayout
will be forwarded to thecontentPane
. This is initially false, but is set to true when theJDialog
is constructed. -
accessibleContext
AccessibleContext
associated with thisJDialog
-
-
Constructor Details
-
JDialog
public JDialog()Creates a modeless dialog without a title and without a specifiedFrame
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 unownedJDialog
you must use either theJDialog(Window)
orJDialog(Dialog)
constructor with an argument ofnull
.- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
,JComponent.getDefaultLocale()
-
JDialog
Creates a modeless dialog with the specifiedFrame
as its owner and an empty title. Ifowner
isnull
, 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 unownedJDialog
you must use either theJDialog(Window)
orJDialog(Dialog)
constructor with an argument ofnull
.- Parameters:
owner
- theFrame
from which the dialog is displayed- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
,JComponent.getDefaultLocale()
-
JDialog
Creates a dialog with an empty title and the specified modality andFrame
as its owner. Ifowner
isnull
, 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 unownedJDialog
you must use either theJDialog(Window)
orJDialog(Dialog)
constructor with an argument ofnull
.- Parameters:
owner
- theFrame
from which the dialog is displayedmodal
- specifies whether dialog blocks user input to other top-level windows when shown. Iftrue
, the modality type property is set toDEFAULT_MODALITY_TYPE
, otherwise the dialog is modeless.- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
,JComponent.getDefaultLocale()
-
JDialog
Creates a modeless dialog with the specified title and with the specified owner frame. Ifowner
isnull
, 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 unownedJDialog
you must use either theJDialog(Window)
orJDialog(Dialog)
constructor with an argument ofnull
.- Parameters:
owner
- theFrame
from which the dialog is displayedtitle
- theString
to display in the dialog's title bar- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
,JComponent.getDefaultLocale()
-
JDialog
Creates a dialog with the specified title, ownerFrame
and modality. Ifowner
isnull
, 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 unownedJDialog
you must use either theJDialog(Window)
orJDialog(Dialog)
constructor with an argument ofnull
.- Parameters:
owner
- theFrame
from which the dialog is displayedtitle
- theString
to display in the dialog's title barmodal
- specifies whether dialog blocks user input to other top-level windows when shown. Iftrue
, the modality type property is set toDEFAULT_MODALITY_TYPE
otherwise the dialog is modeless- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless()
returnstrue
.- 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
Creates a dialog with the specified title, ownerFrame
, modality andGraphicsConfiguration
. Ifowner
isnull
, 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 unownedJDialog
you must use either theJDialog(Window)
orJDialog(Dialog)
constructor with an argument ofnull
.- Parameters:
owner
- theFrame
from which the dialog is displayedtitle
- theString
to display in the dialog's title barmodal
- specifies whether dialog blocks user input to other top-level windows when shown. Iftrue
, the modality type property is set toDEFAULT_MODALITY_TYPE
, otherwise the dialog is modeless.gc
- theGraphicsConfiguration
of the target screen device; ifnull
, the default systemGraphicsConfiguration
is assumed- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless()
returnstrue
.- 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
Creates a modeless dialog with the specifiedDialog
as its owner and an empty title.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale
.- Parameters:
owner
- the ownerDialog
from which the dialog is displayed ornull
if this dialog has no owner- Throws:
HeadlessException
-if GraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
,JComponent.getDefaultLocale()
-
JDialog
Creates a dialog with an empty title and the specified modality andDialog
as its owner.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale
.- Parameters:
owner
- the ownerDialog
from which the dialog is displayed ornull
if this dialog has no ownermodal
- specifies whether dialog blocks user input to other top-level windows when shown. Iftrue
, the modality type property is set toDEFAULT_MODALITY_TYPE
, otherwise the dialog is modeless.- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless()
returnstrue
.- 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
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 ownerDialog
from which the dialog is displayed ornull
if this dialog has no ownertitle
- theString
to display in the dialog's title bar- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
,JComponent.getDefaultLocale()
-
JDialog
Creates a dialog with the specified title, modality and the specified ownerDialog
.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale
.- Parameters:
owner
- the ownerDialog
from which the dialog is displayed ornull
if this dialog has no ownertitle
- theString
to display in the dialog's title barmodal
- specifies whether dialog blocks user input to other top-level windows when shown. Iftrue
, the modality type property is set toDEFAULT_MODALITY_TYPE
, otherwise the dialog is modeless- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless()
returnstrue
.- 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
Creates a dialog with the specified title, ownerDialog
, modality andGraphicsConfiguration
.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 ownerDialog
from which the dialog is displayed ornull
if this dialog has no ownertitle
- theString
to display in the dialog's title barmodal
- specifies whether dialog blocks user input to other top-level windows when shown. Iftrue
, the modality type property is set toDEFAULT_MODALITY_TYPE
, otherwise the dialog is modelessgc
- theGraphicsConfiguration
of the target screen device; ifnull
, the default systemGraphicsConfiguration
is assumed- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless()
returnstrue
.- 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
Creates a modeless dialog with the specifiedWindow
as its owner and an empty title.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale
.- Parameters:
owner
- theWindow
from which the dialog is displayed ornull
if this dialog has no owner- Throws:
IllegalArgumentException
- if theowner
is not an instance ofDialog
orFrame
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen deviceHeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- Since:
- 1.6
- See Also:
GraphicsEnvironment.isHeadless()
,JComponent.getDefaultLocale()
-
JDialog
Creates a dialog with an empty title and the specified modality andWindow
as its owner.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale
.- Parameters:
owner
- theWindow
from which the dialog is displayed ornull
if this dialog has no ownermodalityType
- specifies whether dialog blocks input to other windows when shown.null
value and unsupported modality types are equivalent toMODELESS
- Throws:
IllegalArgumentException
- if theowner
is not an instance ofDialog
orFrame
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen deviceHeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
SecurityException
- if the calling thread does not have permission to create modal dialogs with the givenmodalityType
- Since:
- 1.6
- See Also:
Dialog.ModalityType
,Dialog.setModal(boolean)
,Dialog.setModalityType(java.awt.Dialog.ModalityType)
,GraphicsEnvironment.isHeadless()
,JComponent.getDefaultLocale()
-
JDialog
Creates a modeless dialog with the specified title and ownerWindow
.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale
.- Parameters:
owner
- theWindow
from which the dialog is displayed ornull
if this dialog has no ownertitle
- theString
to display in the dialog's title bar ornull
if the dialog has no title- Throws:
IllegalArgumentException
- if theowner
is not an instance ofDialog
orFrame
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen deviceHeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- Since:
- 1.6
- See Also:
GraphicsEnvironment.isHeadless()
,JComponent.getDefaultLocale()
-
JDialog
Creates a dialog with the specified title, ownerWindow
and modality.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale
.- Parameters:
owner
- theWindow
from which the dialog is displayed ornull
if this dialog has no ownertitle
- theString
to display in the dialog's title bar ornull
if the dialog has no titlemodalityType
- specifies whether dialog blocks input to other windows when shown.null
value and unsupported modality types are equivalent toMODELESS
- Throws:
IllegalArgumentException
- if theowner
is not an instance ofDialog
orFrame
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen deviceHeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
SecurityException
- if the calling thread does not have permission to create modal dialogs with the givenmodalityType
- 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, Dialog.ModalityType modalityType, GraphicsConfiguration gc)Creates a dialog with the specified title, ownerWindow
, modality andGraphicsConfiguration
.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
- theWindow
from which the dialog is displayed ornull
if this dialog has no ownertitle
- theString
to display in the dialog's title bar ornull
if the dialog has no titlemodalityType
- specifies whether dialog blocks input to other windows when shown.null
value and unsupported modality types are equivalent toMODELESS
gc
- theGraphicsConfiguration
of the target screen device; ifnull
, the default systemGraphicsConfiguration
is assumed- Throws:
IllegalArgumentException
- if theowner
is not an instance ofDialog
orFrame
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen deviceHeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
SecurityException
- if the calling thread does not have permission to create modal dialogs with the givenmodalityType
- Since:
- 1.6
- See Also:
Dialog.ModalityType
,Dialog.setModal(boolean)
,Dialog.setModalityType(java.awt.Dialog.ModalityType)
,GraphicsEnvironment.isHeadless()
,JComponent.getDefaultLocale()
-
-
Method Details
-
dialogInit
protected void dialogInit()Called by the constructors to init theJDialog
properly. -
createRootPane
Called by the constructor methods to create the defaultrootPane
.- Returns:
- a new
JRootPane
-
processWindowEvent
Handles window events depending on the state of thedefaultCloseOperation
property.- Overrides:
processWindowEvent
in classWindow
- Parameters:
e
- the window event- See Also:
setDefaultCloseOperation(int)
-
setDefaultCloseOperation
@BeanProperty(preferred=true, enumerationValues={"WindowConstants.DO_NOTHING_ON_CLOSE","WindowConstants.HIDE_ON_CLOSE","WindowConstants.DISPOSE_ON_CLOSE"}, description="The dialog\'s default close operation.") 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 inWindowConstants
): Don't do anything; require the program to handle the operation in thewindowClosing
method of a registeredWindowListener
object.HIDE_ON_CLOSE
(defined inWindowConstants
): Automatically hide the dialog after invoking any registeredWindowListener
objects.DISPOSE_ON_CLOSE
(defined inWindowConstants
): Automatically hide and dispose the dialog after invoking any registeredWindowListener
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- See Also:
Window.addWindowListener(java.awt.event.WindowListener)
,getDefaultCloseOperation()
,WindowConstants
-
getDefaultCloseOperation
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
- See Also:
setDefaultCloseOperation(int)
-
setTransferHandler
@BeanProperty(hidden=true, description="Mechanism for transfer of data into the component") public void setTransferHandler(TransferHandler newHandler)Sets thetransferHandler
property, which is a mechanism to support transfer of data into this component. Usenull
if the component does not support data transfer operations.If the system property
suppressSwingDropSupport
isfalse
(the default) and the current drop target on this component is eithernull
or not a user-set drop target, this method will change the drop target as follows: IfnewHandler
isnull
it will clear the drop target. If notnull
it will install a newDropTarget
.Note: When used with
JDialog
,TransferHandler
only provides data import capability, as the data export related methods are currently typed toJComponent
.Please see How to Use Drag and Drop and Data Transfer, a section in The Java Tutorial, for more information.
- Parameters:
newHandler
- the newTransferHandler
- Since:
- 1.6
- See Also:
TransferHandler
,getTransferHandler()
,Component.setDropTarget(java.awt.dnd.DropTarget)
-
getTransferHandler
Gets thetransferHandler
property.- Returns:
- the value of the
transferHandler
property - Since:
- 1.6
- See Also:
TransferHandler
,setTransferHandler(javax.swing.TransferHandler)
-
update
Callspaint(g)
. This method was overridden to prevent an unnecessary call to clear the background.- Overrides:
update
in classContainer
- Parameters:
g
- theGraphics
context in which to paint- See Also:
Component.update(Graphics)
-
setJMenuBar
@BeanProperty(bound=false, hidden=true, description="The menubar for accessing pulldown menus from this dialog.") public void setJMenuBar(JMenuBar menu)Sets the menubar for this dialog.- Parameters:
menu
- the menubar being placed in the dialog- See Also:
getJMenuBar()
-
getJMenuBar
Returns the menubar set on this dialog.- Returns:
- the menubar set on this dialog
- See Also:
setJMenuBar(javax.swing.JMenuBar)
-
isRootPaneCheckingEnabled
protected boolean isRootPaneCheckingEnabled()Returns whether calls toadd
andsetLayout
are forwarded to thecontentPane
.- Returns:
- true if
add
andsetLayout
are forwarded; false otherwise - See Also:
addImpl(java.awt.Component, java.lang.Object, int)
,setLayout(java.awt.LayoutManager)
,setRootPaneCheckingEnabled(boolean)
,RootPaneContainer
-
setRootPaneCheckingEnabled
@BeanProperty(hidden=true, description="Whether the add and setLayout methods are forwarded") protected void setRootPaneCheckingEnabled(boolean enabled)Sets whether calls toadd
andsetLayout
are forwarded to thecontentPane
.- Parameters:
enabled
- true ifadd
andsetLayout
are forwarded, false if they should operate directly on theJDialog
.- See Also:
addImpl(java.awt.Component, java.lang.Object, int)
,setLayout(java.awt.LayoutManager)
,isRootPaneCheckingEnabled()
,RootPaneContainer
-
addImpl
Adds the specified childComponent
. This method is overridden to conditionally forward calls to thecontentPane
. By default, children are added to thecontentPane
instead of the frame, refer toRootPaneContainer
for details.- Overrides:
addImpl
in classContainer
- Parameters:
comp
- the component to be enhancedconstraints
- the constraints to be respectedindex
- the index- Throws:
IllegalArgumentException
- ifindex
is invalidIllegalArgumentException
- if adding the container's parent to itselfIllegalArgumentException
- if adding a window to a container- See Also:
setRootPaneCheckingEnabled(boolean)
,RootPaneContainer
-
remove
Removes the specified component from the container. Ifcomp
is not therootPane
, this will forward the call to thecontentPane
. This will do nothing ifcomp
is not a child of theJDialog
orcontentPane
.- Overrides:
remove
in classContainer
- Parameters:
comp
- the component to be removed- Throws:
NullPointerException
- ifcomp
is null- See Also:
Container.add(java.awt.Component)
,RootPaneContainer
-
setLayout
Sets theLayoutManager
. Overridden to conditionally forward the call to thecontentPane
. Refer toRootPaneContainer
for more information.- Overrides:
setLayout
in classContainer
- Parameters:
manager
- theLayoutManager
- See Also:
setRootPaneCheckingEnabled(boolean)
,RootPaneContainer
-
getRootPane
@BeanProperty(bound=false, hidden=true, description="the RootPane object for this dialog.") public JRootPane getRootPane()Returns therootPane
object for this dialog.- Specified by:
getRootPane
in interfaceRootPaneContainer
- Returns:
- this components single JRootPane child.
- See Also:
setRootPane(javax.swing.JRootPane)
,RootPaneContainer.getRootPane()
-
setRootPane
Sets therootPane
property. This method is called by the constructor.- Parameters:
root
- therootPane
object for this dialog- See Also:
getRootPane()
-
getContentPane
Returns thecontentPane
object for this dialog.- Specified by:
getContentPane
in interfaceRootPaneContainer
- Returns:
- the
contentPane
property - See Also:
setContentPane(java.awt.Container)
,RootPaneContainer.getContentPane()
-
setContentPane
@BeanProperty(bound=false, hidden=true, description="The client area of the dialog where child components are normally inserted.") public void setContentPane(Container contentPane)Sets thecontentPane
property. This method is called by the constructor.Swing's painting architecture requires an opaque
JComponent
in the containment hierarchy. This is typically provided by the content pane. If you replace the content pane it is recommended you replace it with an opaqueJComponent
.- Specified by:
setContentPane
in interfaceRootPaneContainer
- Parameters:
contentPane
- thecontentPane
object for this dialog- Throws:
IllegalComponentStateException
- (a runtime exception) if the content pane parameter isnull
- See Also:
JRootPane
,getContentPane()
,RootPaneContainer.setContentPane(java.awt.Container)
-
getLayeredPane
Returns thelayeredPane
object for this dialog.- Specified by:
getLayeredPane
in interfaceRootPaneContainer
- Returns:
- the
layeredPane
property - See Also:
setLayeredPane(javax.swing.JLayeredPane)
,RootPaneContainer.getLayeredPane()
-
setLayeredPane
@BeanProperty(bound=false, hidden=true, description="The pane which holds the various dialog layers.") public void setLayeredPane(JLayeredPane layeredPane)Sets thelayeredPane
property. This method is called by the constructor.- Specified by:
setLayeredPane
in interfaceRootPaneContainer
- Parameters:
layeredPane
- the newlayeredPane
property- Throws:
IllegalComponentStateException
- (a runtime exception) if the layered pane parameter is null- See Also:
getLayeredPane()
,RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)
-
getGlassPane
Returns theglassPane
object for this dialog.- Specified by:
getGlassPane
in interfaceRootPaneContainer
- Returns:
- the
glassPane
property - See Also:
setGlassPane(java.awt.Component)
,RootPaneContainer.getGlassPane()
-
setGlassPane
@BeanProperty(bound=false, hidden=true, description="A transparent pane used for menu rendering.") public void setGlassPane(Component glassPane)Sets theglassPane
property. This method is called by the constructor.- Specified by:
setGlassPane
in interfaceRootPaneContainer
- Parameters:
glassPane
- theglassPane
object for this dialog- See Also:
getGlassPane()
,RootPaneContainer.setGlassPane(java.awt.Component)
-
getGraphics
Creates a graphics context for this component. This method will returnnull
if this component is currently not displayable.- Overrides:
getGraphics
in classComponent
- Returns:
- a graphics context for this component, or
null
if it has none - Since:
- 1.6
- See Also:
Component.paint(java.awt.Graphics)
-
repaint
public void repaint(long time, int x, int y, int width, int height)Repaints the specified rectangle of this component withintime
milliseconds. Refer toRepaintManager
for details on how the repaint is handled.- Overrides:
repaint
in classComponent
- Parameters:
time
- maximum time in milliseconds before updatex
- the x coordinatey
- the y coordinatewidth
- the widthheight
- the height- Since:
- 1.6
- See Also:
RepaintManager
-
setDefaultLookAndFeelDecorated
public static void setDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated)Provides a hint as to whether or not newly createdJDialog
s should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel. IfdefaultLookAndFeelDecorated
is true, the currentLookAndFeel
supports providing window decorations, and the current window manager supports undecorated windows, then newly createdJDialog
s will have their Window decorations provided by the currentLookAndFeel
. Otherwise, newly createdJDialog
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);
- Parameters:
defaultLookAndFeelDecorated
- A hint as to whether or not current look and feel should provide window decorations- Since:
- 1.4
- See Also:
LookAndFeel.getSupportsWindowDecorations()
-
isDefaultLookAndFeelDecorated
public static boolean isDefaultLookAndFeelDecorated()Returns true if newly createdJDialog
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.- Returns:
- true if look and feel should provide Window decorations.
- Since:
- 1.4
-
paramString
Returns a string representation of thisJDialog
. 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 benull
.- Overrides:
paramString
in classDialog
- Returns:
- a string representation of this
JDialog
.
-
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.- Specified by:
getAccessibleContext
in interfaceAccessible
- Overrides:
getAccessibleContext
in classDialog
- Returns:
- an AccessibleJDialog that serves as the AccessibleContext of this JDialog
-