- All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,Accessible,RootPaneContainer,WindowConstants
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classThis class implements accessibility support for theJDialogclass.Nested classes/interfaces declared in class java.awt.Dialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityTypeNested classes/interfaces declared in class java.awt.Window
Window.AccessibleAWTWindow, Window.TypeNested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected AccessibleContextAccessibleContextassociated with thisJDialogprotected JRootPaneprotected booleanIf true then calls toaddandsetLayoutwill be forwarded to thecontentPane.Fields declared in class java.awt.Dialog
DEFAULT_MODALITY_TYPEFields declared in class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields declared in interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE -
Constructor Summary
ConstructorsConstructorDescriptionJDialog()Creates a modeless dialog without a title and without a specifiedFrameowner.Creates a modeless dialog with the specifiedDialogas its owner and an empty title.Creates a dialog with an empty title and the specified modality andDialogas its owner.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 ownerDialog.JDialog(Dialog owner, String title, boolean modal, GraphicsConfiguration gc) Creates a dialog with the specified title, ownerDialog, modality andGraphicsConfiguration.Creates a modeless dialog with the specifiedFrameas its owner and an empty title.Creates a dialog with an empty title and the specified modality andFrameas its owner.Creates a modeless dialog with the specified title and with the specified owner frame.Creates a dialog with the specified title, ownerFrameand modality.JDialog(Frame owner, String title, boolean modal, GraphicsConfiguration gc) Creates a dialog with the specified title, ownerFrame, modality andGraphicsConfiguration.Creates a modeless dialog with the specifiedWindowas its owner and an empty title.JDialog(Window owner, Dialog.ModalityType modalityType) Creates a dialog with an empty title and the specified modality andWindowas its owner.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, ownerWindowand 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 TypeMethodDescriptionprotected voidAdds the specified childComponent.protected JRootPaneCalled by the constructor methods to create the defaultrootPane.protected voidCalled by the constructors to init theJDialogproperly.Gets the AccessibleContext associated with this JDialog.Returns thecontentPaneobject for this dialog.intReturns the operation which occurs when the user initiates a "close" on this dialog.Returns theglassPaneobject for this dialog.Creates a graphics context for this component.Returns the menubar set on this dialog.Returns thelayeredPaneobject for this dialog.Returns therootPaneobject for this dialog.Gets thetransferHandlerproperty.static booleanReturns true if newly createdJDialogs should have their Window decorations provided by the current look and feel.protected booleanReturns whether calls toaddandsetLayoutare forwarded to thecontentPane.protected StringReturns a string representation of thisJDialog.protected voidHandles window events depending on the state of thedefaultCloseOperationproperty.voidRemoves the specified component from the container.voidrepaint(long time, int x, int y, int width, int height) Repaints the specified rectangle of this component withintimemilliseconds.voidsetContentPane(Container contentPane) Sets thecontentPaneproperty.voidsetDefaultCloseOperation(int operation) Sets the operation that will happen by default when the user initiates a "close" on this dialog.static voidsetDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated) Provides a hint as to whether or not newly createdJDialogs should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel.voidsetGlassPane(Component glassPane) Sets theglassPaneproperty.voidsetJMenuBar(JMenuBar menu) Sets the menubar for this dialog.voidsetLayeredPane(JLayeredPane layeredPane) Sets thelayeredPaneproperty.voidsetLayout(LayoutManager manager) Sets theLayoutManager.protected voidsetRootPane(JRootPane root) Sets therootPaneproperty.protected voidsetRootPaneCheckingEnabled(boolean enabled) Sets whether calls toaddandsetLayoutare forwarded to thecontentPane.voidsetTransferHandler(TransferHandler newHandler) Sets thetransferHandlerproperty, which is a mechanism to support transfer of data into this component.voidCallspaint(g).Methods declared in class java.awt.Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBackMethods 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, toFrontMethods 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, validateTreeMethods 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
-
rootPaneCheckingEnabled
protected boolean rootPaneCheckingEnabledIf true then calls toaddandsetLayoutwill be forwarded to thecontentPane. This is initially false, but is set to true when theJDialogis constructed. -
accessibleContext
AccessibleContextassociated with thisJDialog
-
-
Constructor Details
-
JDialog
public JDialog()Creates a modeless dialog without a title and without a specifiedFrameowner. 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 unownedJDialogyou must use either theJDialog(Window)orJDialog(Dialog)constructor with an argument ofnull.- Throws:
HeadlessException- ifGraphicsEnvironment.isHeadless()returnstrue.- See Also:
-
JDialog
Creates a modeless dialog with the specifiedFrameas its owner and an empty title. Ifownerisnull, 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 unownedJDialogyou must use either theJDialog(Window)orJDialog(Dialog)constructor with an argument ofnull.- Parameters:
owner- theFramefrom which the dialog is displayed- Throws:
HeadlessException- ifGraphicsEnvironment.isHeadless()returnstrue.- See Also:
-
JDialog
Creates a dialog with an empty title and the specified modality andFrameas its owner. Ifownerisnull, 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 unownedJDialogyou must use either theJDialog(Window)orJDialog(Dialog)constructor with an argument ofnull.- Parameters:
owner- theFramefrom 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:
-
JDialog
Creates a modeless dialog with the specified title and with the specified owner frame. Ifownerisnull, 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 unownedJDialogyou must use either theJDialog(Window)orJDialog(Dialog)constructor with an argument ofnull.- Parameters:
owner- theFramefrom which the dialog is displayedtitle- theStringto display in the dialog's title bar- Throws:
HeadlessException- ifGraphicsEnvironment.isHeadless()returnstrue.- See Also:
-
JDialog
Creates a dialog with the specified title, ownerFrameand modality. Ifownerisnull, 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 unownedJDialogyou must use either theJDialog(Window)orJDialog(Dialog)constructor with an argument ofnull.- Parameters:
owner- theFramefrom which the dialog is displayedtitle- theStringto 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_TYPEotherwise the dialog is modeless- Throws:
HeadlessException- ifGraphicsEnvironment.isHeadless()returnstrue.- See Also:
-
JDialog
Creates a dialog with the specified title, ownerFrame, modality andGraphicsConfiguration. Ifownerisnull, 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 unownedJDialogyou must use either theJDialog(Window)orJDialog(Dialog)constructor with an argument ofnull.- Parameters:
owner- theFramefrom which the dialog is displayedtitle- theStringto 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- theGraphicsConfigurationof the target screen device; ifnull, the default systemGraphicsConfigurationis assumed- Throws:
HeadlessException- ifGraphicsEnvironment.isHeadless()returnstrue.- Since:
- 1.4
- See Also:
-
JDialog
Creates a modeless dialog with the specifiedDialogas its owner and an empty title.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale.- Parameters:
owner- the ownerDialogfrom which the dialog is displayed ornullif this dialog has no owner- Throws:
HeadlessException-if GraphicsEnvironment.isHeadless()returnstrue.- See Also:
-
JDialog
Creates a dialog with an empty title and the specified modality andDialogas its owner.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale.- Parameters:
owner- the ownerDialogfrom which the dialog is displayed ornullif 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:
-
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 ownerDialogfrom which the dialog is displayed ornullif this dialog has no ownertitle- theStringto display in the dialog's title bar- Throws:
HeadlessException- ifGraphicsEnvironment.isHeadless()returnstrue.- See Also:
-
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 ownerDialogfrom which the dialog is displayed ornullif this dialog has no ownertitle- theStringto 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:
-
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 ownerDialogfrom which the dialog is displayed ornullif this dialog has no ownertitle- theStringto 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- theGraphicsConfigurationof the target screen device; ifnull, the default systemGraphicsConfigurationis assumed- Throws:
HeadlessException- ifGraphicsEnvironment.isHeadless()returnstrue.- Since:
- 1.4
- See Also:
-
JDialog
Creates a modeless dialog with the specifiedWindowas its owner and an empty title.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale.- Parameters:
owner- theWindowfrom which the dialog is displayed ornullif this dialog has no owner- Throws:
IllegalArgumentException- if theowneris not an instance ofDialogorFrameIllegalArgumentException- if theowner'sGraphicsConfigurationis not from a screen deviceHeadlessException- whenGraphicsEnvironment.isHeadless()returnstrue- Since:
- 1.6
- See Also:
-
JDialog
Creates a dialog with an empty title and the specified modality andWindowas its owner.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale.- Parameters:
owner- theWindowfrom which the dialog is displayed ornullif this dialog has no ownermodalityType- specifies whether dialog blocks input to other windows when shown.nullvalue and unsupported modality types are equivalent toMODELESS- Throws:
IllegalArgumentException- if theowneris not an instance ofDialogorFrameIllegalArgumentException- if theowner'sGraphicsConfigurationis not from a screen deviceHeadlessException- whenGraphicsEnvironment.isHeadless()returnstrueSecurityException- if the calling thread does not have permission to create modal dialogs with the givenmodalityType- Since:
- 1.6
- See Also:
-
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- theWindowfrom which the dialog is displayed ornullif this dialog has no ownertitle- theStringto display in the dialog's title bar ornullif the dialog has no title- Throws:
IllegalArgumentException- if theowneris not an instance ofDialogorFrameIllegalArgumentException- if theowner'sGraphicsConfigurationis not from a screen deviceHeadlessException- whenGraphicsEnvironment.isHeadless()returnstrue- Since:
- 1.6
- See Also:
-
JDialog
Creates a dialog with the specified title, ownerWindowand modality.This constructor sets the component's locale property to the value returned by
JComponent.getDefaultLocale.- Parameters:
owner- theWindowfrom which the dialog is displayed ornullif this dialog has no ownertitle- theStringto display in the dialog's title bar ornullif the dialog has no titlemodalityType- specifies whether dialog blocks input to other windows when shown.nullvalue and unsupported modality types are equivalent toMODELESS- Throws:
IllegalArgumentException- if theowneris not an instance ofDialogorFrameIllegalArgumentException- if theowner'sGraphicsConfigurationis not from a screen deviceHeadlessException- whenGraphicsEnvironment.isHeadless()returnstrueSecurityException- if the calling thread does not have permission to create modal dialogs with the givenmodalityType- Since:
- 1.6
- See Also:
-
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- theWindowfrom which the dialog is displayed ornullif this dialog has no ownertitle- theStringto display in the dialog's title bar ornullif the dialog has no titlemodalityType- specifies whether dialog blocks input to other windows when shown.nullvalue and unsupported modality types are equivalent toMODELESSgc- theGraphicsConfigurationof the target screen device; ifnull, the default systemGraphicsConfigurationis assumed- Throws:
IllegalArgumentException- if theowneris not an instance ofDialogorFrameIllegalArgumentException- if theowner'sGraphicsConfigurationis not from a screen deviceHeadlessException- whenGraphicsEnvironment.isHeadless()returnstrueSecurityException- if the calling thread does not have permission to create modal dialogs with the givenmodalityType- Since:
- 1.6
- See Also:
-
-
Method Details
-
dialogInit
protected void dialogInit()Called by the constructors to init theJDialogproperly. -
createRootPane
Called by the constructor methods to create the defaultrootPane.- Returns:
- a new
JRootPane
-
processWindowEvent
Handles window events depending on the state of thedefaultCloseOperationproperty.- Overrides:
processWindowEventin classWindow- Parameters:
e- the window event- See Also:
-
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 thewindowClosingmethod of a registeredWindowListenerobject.HIDE_ON_CLOSE(defined inWindowConstants): Automatically hide the dialog after invoking any registeredWindowListenerobjects.DISPOSE_ON_CLOSE(defined inWindowConstants): Automatically hide and dispose the dialog after invoking any registeredWindowListenerobjects.
The value is set to
HIDE_ON_CLOSEby 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:
-
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:
-
setTransferHandler
@BeanProperty(hidden=true, description="Mechanism for transfer of data into the component") public void setTransferHandler(TransferHandler newHandler) Sets thetransferHandlerproperty, which is a mechanism to support transfer of data into this component. Usenullif the component does not support data transfer operations.If the system property
suppressSwingDropSupportisfalse(the default) and the current drop target on this component is eithernullor not a user-set drop target, this method will change the drop target as follows: IfnewHandlerisnullit will clear the drop target. If notnullit will install a newDropTarget.Note: When used with
JDialog,TransferHandleronly 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:
-
getTransferHandler
Gets thetransferHandlerproperty.- Returns:
- the value of the
transferHandlerproperty - Since:
- 1.6
- See Also:
-
update
Callspaint(g). This method was overridden to prevent an unnecessary call to clear the background. -
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
Returns the menubar set on this dialog.- Returns:
- the menubar set on this dialog
- See Also:
-
isRootPaneCheckingEnabled
protected boolean isRootPaneCheckingEnabled()Returns whether calls toaddandsetLayoutare forwarded to thecontentPane.- Returns:
- true if
addandsetLayoutare forwarded; false otherwise - See Also:
-
setRootPaneCheckingEnabled
@BeanProperty(hidden=true, description="Whether the add and setLayout methods are forwarded") protected void setRootPaneCheckingEnabled(boolean enabled) Sets whether calls toaddandsetLayoutare forwarded to thecontentPane.- Parameters:
enabled- true ifaddandsetLayoutare forwarded, false if they should operate directly on theJDialog.- See Also:
-
addImpl
Adds the specified childComponent. This method is overridden to conditionally forward calls to thecontentPane. By default, children are added to thecontentPaneinstead of the frame, refer toRootPaneContainerfor details.- Overrides:
addImplin classContainer- Parameters:
comp- the component to be enhancedconstraints- the constraints to be respectedindex- the index- Throws:
IllegalArgumentException- ifindexis invalidIllegalArgumentException- if adding the container's parent to itselfIllegalArgumentException- if adding a window to a container- See Also:
-
remove
Removes the specified component from the container. Ifcompis not therootPane, this will forward the call to thecontentPane. This will do nothing ifcompis not a child of theJDialogorcontentPane.- Overrides:
removein classContainer- Parameters:
comp- the component to be removed- Throws:
NullPointerException- ifcompis null- See Also:
-
setLayout
Sets theLayoutManager. Overridden to conditionally forward the call to thecontentPane. Refer toRootPaneContainerfor more information. -
getRootPane
@BeanProperty(bound=false, hidden=true, description="the RootPane object for this dialog.") public JRootPane getRootPane()Returns therootPaneobject for this dialog.- Specified by:
getRootPanein interfaceRootPaneContainer- Returns:
- this components single JRootPane child.
- See Also:
-
setRootPane
Sets therootPaneproperty. This method is called by the constructor.- Parameters:
root- therootPaneobject for this dialog- See Also:
-
getContentPane
Returns thecontentPaneobject for this dialog.- Specified by:
getContentPanein interfaceRootPaneContainer- Returns:
- the
contentPaneproperty - See Also:
-
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 thecontentPaneproperty. This method is called by the constructor.Swing's painting architecture requires an opaque
JComponentin 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:
setContentPanein interfaceRootPaneContainer- Parameters:
contentPane- thecontentPaneobject for this dialog- Throws:
IllegalComponentStateException- (a runtime exception) if the content pane parameter isnull- See Also:
-
getLayeredPane
Returns thelayeredPaneobject for this dialog.- Specified by:
getLayeredPanein interfaceRootPaneContainer- Returns:
- the
layeredPaneproperty - See Also:
-
setLayeredPane
@BeanProperty(bound=false, hidden=true, description="The pane which holds the various dialog layers.") public void setLayeredPane(JLayeredPane layeredPane) Sets thelayeredPaneproperty. This method is called by the constructor.- Specified by:
setLayeredPanein interfaceRootPaneContainer- Parameters:
layeredPane- the newlayeredPaneproperty- Throws:
IllegalComponentStateException- (a runtime exception) if the layered pane parameter is null- See Also:
-
getGlassPane
Returns theglassPaneobject for this dialog.- Specified by:
getGlassPanein interfaceRootPaneContainer- Returns:
- the
glassPaneproperty - See Also:
-
setGlassPane
@BeanProperty(bound=false, hidden=true, description="A transparent pane used for menu rendering.") public void setGlassPane(Component glassPane) Sets theglassPaneproperty. This method is called by the constructor.- Specified by:
setGlassPanein interfaceRootPaneContainer- Parameters:
glassPane- theglassPaneobject for this dialog- See Also:
-
getGraphics
Creates a graphics context for this component. This method will returnnullif this component is currently not displayable.- Overrides:
getGraphicsin classComponent- Returns:
- a graphics context for this component, or
nullif it has none - Since:
- 1.6
- See Also:
-
repaint
public void repaint(long time, int x, int y, int width, int height) Repaints the specified rectangle of this component withintimemilliseconds. Refer toRepaintManagerfor details on how the repaint is handled. -
setDefaultLookAndFeelDecorated
public static void setDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated) Provides a hint as to whether or not newly createdJDialogs should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel. IfdefaultLookAndFeelDecoratedis true, the currentLookAndFeelsupports providing window decorations, and the current window manager supports undecorated windows, then newly createdJDialogs will have their Window decorations provided by the currentLookAndFeel. Otherwise, newly createdJDialogs 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:
-
isDefaultLookAndFeelDecorated
public static boolean isDefaultLookAndFeelDecorated()Returns true if newly createdJDialogs 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:
paramStringin 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:
getAccessibleContextin interfaceAccessible- Overrides:
getAccessibleContextin classDialog- Returns:
- an AccessibleJDialog that serves as the AccessibleContext of this JDialog
-