JDialog.java

/*
 * Copyright (c) 1997, 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation. Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
packagejavax.swing;

importjava.awt.*;
importjava.awt.event.*;
importjava.beans.JavaBean;
importjava.beans.BeanProperty;
importjavax.accessibility.*;

/**
 * The main class for creating a dialog window. You can use this class
 * to create a custom dialog, or invoke the many class methods
 * in {@link JOptionPane} to create a variety of standard dialogs.
 * For information about creating dialogs, see
 * <em>The Java Tutorial</em> section
 * <a
 href="https://docs.oracle.com/javase/tutorial/uiswing/components/dialog.html">How
 * to Make Dialogs</a>.
 *
 * <p>
 *
 * The {@code JDialog} component contains a {@code JRootPane}
 * as its only child.
 * The {@code contentPane} should be the parent of any children of the
 * {@code JDialog}.
 * As a convenience, the {@code add}, {@code remove}, and {@code setLayout}
 * methods of this class are overridden, so that they delegate calls
 * to the corresponding methods of the {@code ContentPane}.
 * For example, you can add a child component to a dialog as follows:
 * <pre>
 * dialog.add(child);
 * </pre>
 * And the child will be added to the contentPane.
 * The {@code contentPane} is always non-{@code null}.
 * Attempting to set it to {@code null} generates an exception.
 * The default {@code contentPane} has a {@code BorderLayout}
 * manager set on it.
 * Refer to {@link javax.swing.RootPaneContainer}
 * for details on adding, removing and setting the {@code LayoutManager}
 * of a {@code JDialog}.
 * <p>
 * Please see the {@code JRootPane} documentation for a complete
 * description of the {@code contentPane}, {@code glassPane},
 * and {@code layeredPane} components.
 * <p>
 * In a multi-screen environment, you can create a {@code JDialog}
 * on a different screen device than its owner. See {@link java.awt.Frame} for
 * more information.
 * <p>
 * <strong>Warning:</strong> Swing is not thread safe. For more
 * information see <a
 * href="package-summary.html#threading">Swing's Threading
 * Policy</a>.
 * <p>
 * <strong>Warning:</strong>
 * 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 {@code java.beans} package.
 * Please see {@link java.beans.XMLEncoder}.
 *
 * @see JOptionPane
 * @see JRootPane
 * @see javax.swing.RootPaneContainer
 *
 * @author David Kloba
 * @author James Gosling
 * @author Scott Violet
 * @since 1.2
 */
@JavaBean(defaultProperty = "JMenuBar", description = "A toplevel window for creating dialog boxes.")
@SwingContainer(delegate = "getContentPane")
@SuppressWarnings({"serial"}) // Same-version serialization only
publicclassJDialogextendsDialogimplementsWindowConstants,
Accessible,
RootPaneContainer,
TransferHandler.HasGetTransferHandler
{
/**
 * Key into the AppContext, used to check if should provide decorations
 * by default.
 */
privatestaticfinalObjectdefaultLookAndFeelDecoratedKey =
newStringBuffer("JDialog.defaultLookAndFeelDecorated");

privateintdefaultCloseOperation = HIDE_ON_CLOSE;

/**
 * The <code>JRootPane</code> instance that manages the
 * <code>contentPane</code>.
 *
 * @see #getRootPane
 * @see #setRootPane
 */
protectedJRootPanerootPane;

/**
 * If true then calls to {@code add} and {@code setLayout}
 * will be forwarded to the {@code contentPane}. This is initially
 * false, but is set to true when the {@code JDialog} is constructed.
 *
 * @see #isRootPaneCheckingEnabled
 * @see #setRootPaneCheckingEnabled
 * @see javax.swing.RootPaneContainer
 */
protectedbooleanrootPaneCheckingEnabled = false;

/**
 * The {@code TransferHandler} for this dialog.
 */
privateTransferHandlertransferHandler;

/**
 * Creates a modeless dialog without a title and without a specified
 * {@code Frame} owner. A shared, hidden frame will be
 * set as the owner of the dialog.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 * <p>
 * NOTE: This constructor does not allow you to create an unowned
 * {@code JDialog}. To create an unowned {@code JDialog}
 * you must use either the {@code JDialog(Window)} or
 * {@code JDialog(Dialog)} constructor with an argument of
 * {@code null}.
 *
 * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()}
 * returns {@code true}.
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 */
publicJDialog() {
this((Frame)null, false);
 }

/**
 * Creates a modeless dialog with the specified {@code Frame}
 * as its owner and an empty title. If {@code owner}
 * is {@code null}, a shared, hidden frame will be set as the
 * owner of the dialog.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 * <p>
 * NOTE: This constructor does not allow you to create an unowned
 * {@code JDialog}. To create an unowned {@code JDialog}
 * you must use either the {@code JDialog(Window)} or
 * {@code JDialog(Dialog)} constructor with an argument of
 * {@code null}.
 *
 * @param owner the {@code Frame} from which the dialog is displayed
 * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()}
 * returns {@code true}.
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 */
publicJDialog(Frameowner) {
this(owner, false);
 }

/**
 * Creates a dialog with an empty title and the specified modality and
 * {@code Frame} as its owner. If {@code owner} is {@code null},
 * a shared, hidden frame will be set as the owner of the dialog.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 * <p>
 * NOTE: This constructor does not allow you to create an unowned
 * {@code JDialog}. To create an unowned {@code JDialog}
 * you must use either the {@code JDialog(Window)} or
 * {@code JDialog(Dialog)} constructor with an argument of
 * {@code null}.
 *
 * @param owner the {@code Frame} from which the dialog is displayed
 * @param modal specifies whether dialog blocks user input to other top-level
 * windows when shown. If {@code true}, the modality type property is set to
 * {@code DEFAULT_MODALITY_TYPE}, otherwise the dialog is modeless.
 * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()}
 * returns {@code true}.
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 */
publicJDialog(Frameowner, booleanmodal) {
this(owner, "", modal);
 }

/**
 * Creates a modeless dialog with the specified title and
 * with the specified owner frame. If {@code owner}
 * is {@code null}, a shared, hidden frame will be set as the
 * owner of the dialog.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 * <p>
 * NOTE: This constructor does not allow you to create an unowned
 * {@code JDialog}. To create an unowned {@code JDialog}
 * you must use either the {@code JDialog(Window)} or
 * {@code JDialog(Dialog)} constructor with an argument of
 * {@code null}.
 *
 * @param owner the {@code Frame} from which the dialog is displayed
 * @param title the {@code String} to display in the dialog's
 * title bar
 * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()}
 * returns {@code true}.
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 */
publicJDialog(Frameowner, Stringtitle) {
this(owner, title, false);
 }

/**
 * Creates a dialog with the specified title, owner {@code Frame}
 * and modality. If {@code owner} is {@code null},
 * a shared, hidden frame will be set as the owner of this dialog.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 * <p>
 * NOTE: Any popup components ({@code JComboBox},
 * {@code JPopupMenu}, {@code JMenuBar})
 * created within a modal dialog will be forced to be lightweight.
 * <p>
 * NOTE: This constructor does not allow you to create an unowned
 * {@code JDialog}. To create an unowned {@code JDialog}
 * you must use either the {@code JDialog(Window)} or
 * {@code JDialog(Dialog)} constructor with an argument of
 * {@code null}.
 *
 * @param owner the {@code Frame} from which the dialog is displayed
 * @param title the {@code String} to display in the dialog's
 * title bar
 * @param modal specifies whether dialog blocks user input to other top-level
 * windows when shown. If {@code true}, the modality type property is set to
 * {@code DEFAULT_MODALITY_TYPE} otherwise the dialog is modeless
 * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()}
 * returns {@code true}.
 *
 * @see java.awt.Dialog.ModalityType
 * @see java.awt.Dialog.ModalityType#MODELESS
 * @see java.awt.Dialog#DEFAULT_MODALITY_TYPE
 * @see java.awt.Dialog#setModal
 * @see java.awt.Dialog#setModalityType
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 */
publicJDialog(Frameowner, Stringtitle, booleanmodal) {
super(owner == null? SwingUtilities.getSharedOwnerFrame() : owner,
title, modal);
if (owner == null) {
WindowListenerownerShutdownListener =
SwingUtilities.getSharedOwnerFrameShutdownListener();
addWindowListener(ownerShutdownListener);
 }
dialogInit();
 }

/**
 * Creates a dialog with the specified title,
 * owner {@code Frame}, modality and {@code GraphicsConfiguration}.
 * If {@code owner} is {@code null},
 * a shared, hidden frame will be set as the owner of this dialog.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 * <p>
 * NOTE: Any popup components ({@code JComboBox},
 * {@code JPopupMenu}, {@code JMenuBar})
 * created within a modal dialog will be forced to be lightweight.
 * <p>
 * NOTE: This constructor does not allow you to create an unowned
 * {@code JDialog}. To create an unowned {@code JDialog}
 * you must use either the {@code JDialog(Window)} or
 * {@code JDialog(Dialog)} constructor with an argument of
 * {@code null}.
 *
 * @param owner the {@code Frame} from which the dialog is displayed
 * @param title the {@code String} to display in the dialog's
 * title bar
 * @param modal specifies whether dialog blocks user input to other top-level
 * windows when shown. If {@code true}, the modality type property is set to
 * {@code DEFAULT_MODALITY_TYPE}, otherwise the dialog is modeless.
 * @param gc the {@code GraphicsConfiguration} of the target screen device;
 * if {@code null}, the default system {@code GraphicsConfiguration}
 * is assumed
 * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()}
 * returns {@code true}.
 * @see java.awt.Dialog.ModalityType
 * @see java.awt.Dialog.ModalityType#MODELESS
 * @see java.awt.Dialog#DEFAULT_MODALITY_TYPE
 * @see java.awt.Dialog#setModal
 * @see java.awt.Dialog#setModalityType
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 * @since 1.4
 */
publicJDialog(Frameowner, Stringtitle, booleanmodal,
GraphicsConfigurationgc) {
super(owner == null? SwingUtilities.getSharedOwnerFrame() : owner,
title, modal, gc);
if (owner == null) {
WindowListenerownerShutdownListener =
SwingUtilities.getSharedOwnerFrameShutdownListener();
addWindowListener(ownerShutdownListener);
 }
dialogInit();
 }

/**
 * Creates a modeless dialog with the specified {@code Dialog}
 * as its owner and an empty title.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 *
 * @param owner the owner {@code Dialog} from which the dialog is displayed
 * or {@code null} if this dialog has no owner
 * @throws HeadlessException {@code if GraphicsEnvironment.isHeadless()}
 * returns {@code true}.
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 */
publicJDialog(Dialogowner) {
this(owner, false);
 }

/**
 * Creates a dialog with an empty title and the specified modality and
 * {@code Dialog} as its owner.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 *
 * @param owner the owner {@code Dialog} from which the dialog is displayed
 * or {@code null} if this dialog has no owner
 * @param modal specifies whether dialog blocks user input to other top-level
 * windows when shown. If {@code true}, the modality type property is set to
 * {@code DEFAULT_MODALITY_TYPE}, otherwise the dialog is modeless.
 * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()}
 * returns {@code true}.
 * @see java.awt.Dialog.ModalityType
 * @see java.awt.Dialog.ModalityType#MODELESS
 * @see java.awt.Dialog#DEFAULT_MODALITY_TYPE
 * @see java.awt.Dialog#setModal
 * @see java.awt.Dialog#setModalityType
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 */
publicJDialog(Dialogowner, booleanmodal) {
this(owner, "", modal);
 }

/**
 * Creates a modeless dialog with the specified title and
 * with the specified owner dialog.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 *
 * @param owner the owner {@code Dialog} from which the dialog is displayed
 * or {@code null} if this dialog has no owner
 * @param title the {@code String} to display in the dialog's
 * title bar
 * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()}
 * returns {@code true}.
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 */
publicJDialog(Dialogowner, Stringtitle) {
this(owner, title, false);
 }

/**
 * Creates a dialog with the specified title, modality
 * and the specified owner {@code Dialog}.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 *
 * @param owner the owner {@code Dialog} from which the dialog is displayed
 * or {@code null} if this dialog has no owner
 * @param title the {@code String} to display in the dialog's
 * title bar
 * @param modal specifies whether dialog blocks user input to other top-level
 * windows when shown. If {@code true}, the modality type property is set to
 * {@code DEFAULT_MODALITY_TYPE}, otherwise the dialog is modeless
 * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()}
 * returns {@code true}.
 * @see java.awt.Dialog.ModalityType
 * @see java.awt.Dialog.ModalityType#MODELESS
 * @see java.awt.Dialog#DEFAULT_MODALITY_TYPE
 * @see java.awt.Dialog#setModal
 * @see java.awt.Dialog#setModalityType
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 */
publicJDialog(Dialogowner, Stringtitle, booleanmodal) {
super(owner, title, modal);
dialogInit();
 }

/**
 * Creates a dialog with the specified title, owner {@code Dialog},
 * modality and {@code GraphicsConfiguration}.
 *
 * <p>
 * NOTE: Any popup components ({@code JComboBox},
 * {@code JPopupMenu}, {@code JMenuBar})
 * created within a modal dialog will be forced to be lightweight.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 *
 * @param owner the owner {@code Dialog} from which the dialog is displayed
 * or {@code null} if this dialog has no owner
 * @param title the {@code String} to display in the dialog's
 * title bar
 * @param modal specifies whether dialog blocks user input to other top-level
 * windows when shown. If {@code true}, the modality type property is set to
 * {@code DEFAULT_MODALITY_TYPE}, otherwise the dialog is modeless
 * @param gc the {@code GraphicsConfiguration} of the target screen device;
 * if {@code null}, the default system {@code GraphicsConfiguration}
 * is assumed
 * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()}
 * returns {@code true}.
 * @see java.awt.Dialog.ModalityType
 * @see java.awt.Dialog.ModalityType#MODELESS
 * @see java.awt.Dialog#DEFAULT_MODALITY_TYPE
 * @see java.awt.Dialog#setModal
 * @see java.awt.Dialog#setModalityType
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 * @since 1.4
 */
publicJDialog(Dialogowner, Stringtitle, booleanmodal,
GraphicsConfigurationgc) {
super(owner, title, modal, gc);
dialogInit();
 }

/**
 * Creates a modeless dialog with the specified {@code Window}
 * as its owner and an empty title.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 *
 * @param owner the {@code Window} from which the dialog is displayed or
 * {@code null} if this dialog has no owner
 *
 * @throws IllegalArgumentException
 * if the {@code owner} is not an instance of {@link java.awt.Dialog Dialog}
 * or {@link java.awt.Frame Frame}
 * @throws IllegalArgumentException
 * if the {@code owner}'s {@code GraphicsConfiguration} is not from a screen device
 * @throws HeadlessException
 * when {@code GraphicsEnvironment.isHeadless()} returns {@code true}
 *
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 *
 * @since 1.6
 */
publicJDialog(Windowowner) {
this(owner, Dialog.ModalityType.MODELESS);
 }

/**
 * Creates a dialog with an empty title and the specified modality and
 * {@code Window} as its owner.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 *
 * @param owner the {@code Window} from which the dialog is displayed or
 * {@code null} if this dialog has no owner
 * @param modalityType specifies whether dialog blocks input to other
 * windows when shown. {@code null} value and unsupported modality
 * types are equivalent to {@code MODELESS}
 *
 * @throws IllegalArgumentException
 * if the {@code owner} is not an instance of {@link java.awt.Dialog Dialog}
 * or {@link java.awt.Frame Frame}
 * @throws IllegalArgumentException
 * if the {@code owner}'s {@code GraphicsConfiguration} is not from a screen device
 * @throws HeadlessException
 * when {@code GraphicsEnvironment.isHeadless()} returns {@code true}
 *
 * @see java.awt.Dialog.ModalityType
 * @see java.awt.Dialog#setModal
 * @see java.awt.Dialog#setModalityType
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 *
 * @since 1.6
 */
publicJDialog(Windowowner, ModalityTypemodalityType) {
this(owner, "", modalityType);
 }

/**
 * Creates a modeless dialog with the specified title and owner
 * {@code Window}.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 *
 * @param owner the {@code Window} from which the dialog is displayed or
 * {@code null} if this dialog has no owner
 * @param title the {@code String} to display in the dialog's
 * title bar or {@code null} if the dialog has no title
 *
 * @throws IllegalArgumentException
 * if the {@code owner} is not an instance of {@link java.awt.Dialog Dialog}
 * or {@link java.awt.Frame Frame}
 * @throws IllegalArgumentException
 * if the {@code owner}'s {@code GraphicsConfiguration} is not from a screen device
 * @throws HeadlessException
 * when {@code GraphicsEnvironment.isHeadless()} returns {@code true}
 *
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 *
 * @since 1.6
 */
publicJDialog(Windowowner, Stringtitle) {
this(owner, title, Dialog.ModalityType.MODELESS);
 }

/**
 * Creates a dialog with the specified title, owner {@code Window} and
 * modality.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 *
 * @param owner the {@code Window} from which the dialog is displayed or
 * {@code null} if this dialog has no owner
 * @param title the {@code String} to display in the dialog's
 * title bar or {@code null} if the dialog has no title
 * @param modalityType specifies whether dialog blocks input to other
 * windows when shown. {@code null} value and unsupported modality
 * types are equivalent to {@code MODELESS}
 *
 * @throws IllegalArgumentException
 * if the {@code owner} is not an instance of {@link java.awt.Dialog Dialog}
 * or {@link java.awt.Frame Frame}
 * @throws IllegalArgumentException
 * if the {@code owner}'s {@code GraphicsConfiguration} is not from a screen device
 * @throws HeadlessException
 * when {@code GraphicsEnvironment.isHeadless()} returns {@code true}
 *
 * @see java.awt.Dialog.ModalityType
 * @see java.awt.Dialog#setModal
 * @see java.awt.Dialog#setModalityType
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 *
 * @since 1.6
 */
publicJDialog(Windowowner, Stringtitle, Dialog.ModalityTypemodalityType) {
super(owner, title, modalityType);
dialogInit();
 }

/**
 * Creates a dialog with the specified title, owner {@code Window},
 * modality and {@code GraphicsConfiguration}.
 * <p>
 * NOTE: Any popup components ({@code JComboBox},
 * {@code JPopupMenu}, {@code JMenuBar})
 * created within a modal dialog will be forced to be lightweight.
 * <p>
 * This constructor sets the component's locale property to the value
 * returned by {@code JComponent.getDefaultLocale}.
 *
 * @param owner the {@code Window} from which the dialog is displayed or
 * {@code null} if this dialog has no owner
 * @param title the {@code String} to display in the dialog's
 * title bar or {@code null} if the dialog has no title
 * @param modalityType specifies whether dialog blocks input to other
 * windows when shown. {@code null} value and unsupported modality
 * types are equivalent to {@code MODELESS}
 * @param gc the {@code GraphicsConfiguration} of the target screen device;
 * if {@code null}, the default system {@code GraphicsConfiguration}
 * is assumed
 * @throws IllegalArgumentException
 * if the {@code owner} is not an instance of {@link java.awt.Dialog Dialog}
 * or {@link java.awt.Frame Frame}
 * @throws IllegalArgumentException
 * if the {@code owner}'s {@code GraphicsConfiguration} is not from a screen device
 * @throws HeadlessException
 * when {@code GraphicsEnvironment.isHeadless()} returns {@code true}
 *
 * @see java.awt.Dialog.ModalityType
 * @see java.awt.Dialog#setModal
 * @see java.awt.Dialog#setModalityType
 * @see java.awt.GraphicsEnvironment#isHeadless
 * @see JComponent#getDefaultLocale
 *
 * @since 1.6
 */
publicJDialog(Windowowner, Stringtitle, Dialog.ModalityTypemodalityType,
GraphicsConfigurationgc) {
super(owner, title, modalityType, gc);
dialogInit();
 }

/**
 * Called by the constructors to init the {@code JDialog} properly.
 */
protectedvoiddialogInit() {
enableEvents(AWTEvent.KEY_EVENT_MASK | AWTEvent.WINDOW_EVENT_MASK);
setLocale( JComponent.getDefaultLocale() );
setRootPane(createRootPane());
setBackground(UIManager.getColor("control"));
setRootPaneCheckingEnabled(true);
if (JDialog.isDefaultLookAndFeelDecorated()) {
booleansupportsWindowDecorations =
UIManager.getLookAndFeel().getSupportsWindowDecorations();
if (supportsWindowDecorations) {
setUndecorated(true);
getRootPane().setWindowDecorationStyle(JRootPane.PLAIN_DIALOG);
 }
 }
sun.awt.SunToolkit.checkAndSetPolicy(this);
 }

/**
 * Called by the constructor methods to create the default
 * {@code rootPane}.
 *
 * @return a new {@code JRootPane}
 */
protectedJRootPanecreateRootPane() {
JRootPanerp = newJRootPane();
// NOTE: this uses setOpaque vs LookAndFeel.installProperty as there
// is NO reason for the RootPane not to be opaque. For painting to
// work the contentPane must be opaque, therefore the RootPane can
// also be opaque.
rp.setOpaque(true);
returnrp;
 }

/**
 * Handles window events depending on the state of the
 * {@code defaultCloseOperation} property.
 *
 * @see #setDefaultCloseOperation
 */
protectedvoidprocessWindowEvent(WindowEvente) {
super.processWindowEvent(e);

if (e.getID() == WindowEvent.WINDOW_CLOSING) {
switch(defaultCloseOperation) {
caseHIDE_ON_CLOSE:
setVisible(false);
break;
caseDISPOSE_ON_CLOSE:
dispose();
break;
caseDO_NOTHING_ON_CLOSE:
default:
break;
 }
 }
 }


/**
 * 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:
 * <br><br>
 * <ul>
 * <li>{@code DO_NOTHING_ON_CLOSE}
 * (defined in {@code WindowConstants}):
 * Don't do anything; require the
 * program to handle the operation in the {@code windowClosing}
 * method of a registered {@code WindowListener} object.
 *
 * <li>{@code HIDE_ON_CLOSE}
 * (defined in {@code WindowConstants}):
 * Automatically hide the dialog after
 * invoking any registered {@code WindowListener}
 * objects.
 *
 * <li>{@code DISPOSE_ON_CLOSE}
 * (defined in {@code WindowConstants}):
 * Automatically hide and dispose the
 * dialog after invoking any registered {@code WindowListener}
 * objects.
 * </ul>
 * <p>
 * The value is set to {@code HIDE_ON_CLOSE} by default. Changes
 * to the value of this property cause the firing of a property
 * change event, with property name "defaultCloseOperation".
 * <p>
 * <b>Note</b>: When the last displayable window within the
 * Java virtual machine (VM) is disposed of, the VM may
 * terminate. See <a href="../../java/awt/doc-files/AWTThreadIssues.html">
 * AWT Threading Issues</a> for more information.
 *
 * @param 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 #addWindowListener
 * @see #getDefaultCloseOperation
 * @see WindowConstants
 */
@BeanProperty(preferred = true, enumerationValues = {
"WindowConstants.DO_NOTHING_ON_CLOSE",
"WindowConstants.HIDE_ON_CLOSE",
"WindowConstants.DISPOSE_ON_CLOSE"}, description
 = "The dialog's default close operation.")
publicvoidsetDefaultCloseOperation(intoperation) {
if (operation != DO_NOTHING_ON_CLOSE &&
operation != HIDE_ON_CLOSE &&
operation != DISPOSE_ON_CLOSE) {
thrownewIllegalArgumentException("defaultCloseOperation must be one of: DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE, or DISPOSE_ON_CLOSE");
 }

intoldValue = this.defaultCloseOperation;
this.defaultCloseOperation = operation;
firePropertyChange("defaultCloseOperation", oldValue, operation);
 }

/**
 * Returns the operation which occurs when the user
 * initiates a "close" on this dialog.
 *
 * @return an integer indicating the window-close operation
 * @see #setDefaultCloseOperation
 */
publicintgetDefaultCloseOperation() {
returndefaultCloseOperation;
 }

/**
 * Sets the {@code transferHandler} property, which is a mechanism to
 * support transfer of data into this component. Use {@code null}
 * if the component does not support data transfer operations.
 * <p>
 * If the system property {@code suppressSwingDropSupport} is {@code false}
 * (the default) and the current drop target on this component is either
 * {@code null} or not a user-set drop target, this method will change the
 * drop target as follows: If {@code newHandler} is {@code null} it will
 * clear the drop target. If not {@code null} it will install a new
 * {@code DropTarget}.
 * <p>
 * Note: When used with {@code JDialog}, {@code TransferHandler} only
 * provides data import capability, as the data export related methods
 * are currently typed to {@code JComponent}.
 * <p>
 * Please see
 * <a href="https://docs.oracle.com/javase/tutorial/uiswing/dnd/index.html">
 * How to Use Drag and Drop and Data Transfer</a>, a section in
 * <em>The Java Tutorial</em>, for more information.
 *
 * @param newHandler the new {@code TransferHandler}
 *
 * @see TransferHandler
 * @see #getTransferHandler
 * @see java.awt.Component#setDropTarget
 * @since 1.6
 */
@BeanProperty(hidden = true, description
 = "Mechanism for transfer of data into the component")
publicvoidsetTransferHandler(TransferHandlernewHandler) {
TransferHandleroldHandler = transferHandler;
transferHandler = newHandler;
SwingUtilities.installSwingDropTargetAsNecessary(this, transferHandler);
firePropertyChange("transferHandler", oldHandler, newHandler);
 }

/**
 * Gets the {@code transferHandler} property.
 *
 * @return the value of the {@code transferHandler} property
 *
 * @see TransferHandler
 * @see #setTransferHandler
 * @since 1.6
 */
publicTransferHandlergetTransferHandler() {
returntransferHandler;
 }

/**
 * Calls {@code paint(g)}. This method was overridden to
 * prevent an unnecessary call to clear the background.
 *
 * @param g the {@code Graphics} context in which to paint
 */
publicvoidupdate(Graphicsg) {
paint(g);
 }

/**
 * Sets the menubar for this dialog.
 *
 * @param menu the menubar being placed in the dialog
 *
 * @see #getJMenuBar
 */
@BeanProperty(bound = false, hidden = true, description
 = "The menubar for accessing pulldown menus from this dialog.")
publicvoidsetJMenuBar(finalJMenuBarmenu) {
getRootPane().setJMenuBar(menu);
 }

/**
 * Returns the menubar set on this dialog.
 *
 * @return the menubar set on this dialog
 * @see #setJMenuBar
 */
publicJMenuBargetJMenuBar() {
returngetRootPane().getJMenuBar();
 }

/**
 * Returns whether calls to {@code add} and
 * {@code setLayout} are forwarded to the {@code contentPane}.
 *
 * @return true if {@code add} and {@code setLayout}
 * are forwarded; false otherwise
 *
 * @see #addImpl
 * @see #setLayout
 * @see #setRootPaneCheckingEnabled
 * @see javax.swing.RootPaneContainer
 */
protectedbooleanisRootPaneCheckingEnabled() {
returnrootPaneCheckingEnabled;
 }


/**
 * Sets whether calls to {@code add} and
 * {@code setLayout} are forwarded to the {@code contentPane}.
 *
 * @param enabled true if {@code add} and {@code setLayout}
 * are forwarded, false if they should operate directly on the
 * {@code JDialog}.
 *
 * @see #addImpl
 * @see #setLayout
 * @see #isRootPaneCheckingEnabled
 * @see javax.swing.RootPaneContainer
 */
@BeanProperty(hidden = true, description
 = "Whether the add and setLayout methods are forwarded")
protectedvoidsetRootPaneCheckingEnabled(booleanenabled) {
rootPaneCheckingEnabled = enabled;
 }

/**
 * Adds the specified child {@code Component}.
 * This method is overridden to conditionally forward calls to the
 * {@code contentPane}.
 * By default, children are added to the {@code contentPane} instead
 * of the frame, refer to {@link javax.swing.RootPaneContainer} for
 * details.
 *
 * @param comp the component to be enhanced
 * @param constraints the constraints to be respected
 * @param index the index
 * @throws IllegalArgumentException if {@code index} is invalid
 * @throws IllegalArgumentException if adding the container's parent
 * to itself
 * @throws IllegalArgumentException if adding a window to a container
 *
 * @see #setRootPaneCheckingEnabled
 * @see javax.swing.RootPaneContainer
 */
protectedvoidaddImpl(Componentcomp, Objectconstraints, intindex)
 {
if(isRootPaneCheckingEnabled()) {
getContentPane().add(comp, constraints, index);
 }
else {
super.addImpl(comp, constraints, index);
 }
 }

/**
 * Removes the specified component from the container. If
 * {@code comp} is not the {@code rootPane}, this will forward
 * the call to the {@code contentPane}. This will do nothing if
 * {@code comp} is not a child of the {@code JDialog} or
 * {@code contentPane}.
 *
 * @param comp the component to be removed
 * @throws NullPointerException if {@code comp} is null
 * @see #add
 * @see javax.swing.RootPaneContainer
 */
publicvoidremove(Componentcomp) {
if (comp == rootPane) {
super.remove(comp);
 } else {
getContentPane().remove(comp);
 }
 }


/**
 * Sets the {@code LayoutManager}.
 * Overridden to conditionally forward the call to the
 * {@code contentPane}.
 * Refer to {@link javax.swing.RootPaneContainer} for
 * more information.
 *
 * @param manager the {@code LayoutManager}
 * @see #setRootPaneCheckingEnabled
 * @see javax.swing.RootPaneContainer
 */
publicvoidsetLayout(LayoutManagermanager) {
if(isRootPaneCheckingEnabled()) {
getContentPane().setLayout(manager);
 }
else {
super.setLayout(manager);
 }
 }


/**
 * Returns the {@code rootPane} object for this dialog.
 *
 * @see #setRootPane
 * @see RootPaneContainer#getRootPane
 */
@BeanProperty(bound = false, hidden = true, description
 = "the RootPane object for this dialog.")
publicJRootPanegetRootPane() {
returnrootPane;
 }


/**
 * Sets the {@code rootPane} property.
 * This method is called by the constructor.
 *
 * @param root the {@code rootPane} object for this dialog
 *
 * @see #getRootPane
 */
protectedvoidsetRootPane(JRootPaneroot) {
if(rootPane != null) {
remove(rootPane);
 }
rootPane = root;
if(rootPane != null) {
booleancheckingEnabled = isRootPaneCheckingEnabled();
try {
setRootPaneCheckingEnabled(false);
add(rootPane, BorderLayout.CENTER);
 }
finally {
setRootPaneCheckingEnabled(checkingEnabled);
 }
 }
 }


/**
 * Returns the {@code contentPane} object for this dialog.
 *
 * @return the {@code contentPane} property