From 62180d1385a661f756df8a0890b770cac19ae37d Mon Sep 17 00:00:00 2001 From: Sergey Malenkov Date: Tue, 14 Sep 2010 21:22:12 +0400 Subject: [PATCH] 6635395: javax.swing.JDialog constructors should specify IAE throwing if invalid owners passed Reviewed-by: alexp --- .../share/classes/javax/swing/JDialog.java | 566 ++++++++++-------- 1 file changed, 300 insertions(+), 266 deletions(-) diff --git a/jdk/src/share/classes/javax/swing/JDialog.java b/jdk/src/share/classes/javax/swing/JDialog.java index 06e036d8942..1c8edf354ac 100644 --- a/jdk/src/share/classes/javax/swing/JDialog.java +++ b/jdk/src/share/classes/javax/swing/JDialog.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1997, 2008, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1997, 2010, 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 @@ -26,12 +26,7 @@ package javax.swing; import java.awt.*; import java.awt.event.*; -import java.beans.PropertyChangeListener; -import java.util.Locale; -import java.util.Vector; -import java.io.Serializable; import javax.accessibility.*; -import java.applet.Applet; /** * The main class for creating a dialog window. You can use this class @@ -45,30 +40,30 @@ import java.applet.Applet; * *

* - * The JDialog component contains a JRootPane + * The {@code JDialog} component contains a {@code JRootPane} * as its only child. - * The contentPane should be the parent of any children of the - * JDialog. - * As a convenience add and its variants, remove and - * setLayout have been overridden to forward to the - * contentPane as necessary. This means you can write: + * The {@code contentPane} should be the parent of any children of the + * {@code JDialog}. + * As a convenience {@code add} and its variants, {@code remove} and + * {@code setLayout} have been overridden to forward to the + * {@code contentPane} as necessary. This means you can write: * 

  *       dialog.add(child);
  *
* And the child will be added to the contentPane. - * The contentPane is always non-null. - * Attempting to set it to null generates an exception. - * The default contentPane has a BorderLayout + * 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 LayoutManager - * of a JDialog. + * for details on adding, removing and setting the {@code LayoutManager} + * of a {@code JDialog}. *

- * Please see the JRootPane documentation for a complete - * description of the contentPane, glassPane, - * and layeredPane components. + * Please see the {@code JRootPane} documentation for a complete + * description of the {@code contentPane}, {@code glassPane}, + * and {@code layeredPane} components. *

- * In a multi-screen environment, you can create a JDialog + * 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. *

@@ -83,7 +78,7 @@ import java.applet.Applet; * appropriate for short term storage or RMI between applications running * the same version of Swing. As of 1.4, support for long term storage * of all JavaBeansTM - * has been added to the java.beans package. + * has been added to the {@code java.beans} package. * Please see {@link java.beans.XMLEncoder}. * * @see JOptionPane @@ -120,9 +115,9 @@ public class JDialog extends Dialog implements WindowConstants, protected JRootPane rootPane; /** - * If true then calls to add and setLayout - * will be forwarded to the contentPane. This is initially - * false, but is set to true when the JDialog is constructed. + * 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 @@ -131,26 +126,26 @@ public class JDialog extends Dialog implements WindowConstants, protected boolean rootPaneCheckingEnabled = false; /** - * The TransferHandler for this dialog. + * The {@code TransferHandler} for this dialog. */ private TransferHandler transferHandler; /** * Creates a modeless dialog without a title and without a specified - * Frame owner. A shared, hidden frame will be + * {@code Frame} owner. A shared, hidden frame will be * set as the owner of the dialog. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. *

* NOTE: This constructor does not allow you to create an unowned - * JDialog. To create an unowned JDialog - * you must use either the JDialog(Window) or - * JDialog(Dialog) constructor with an argument of - * null. + * {@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}. * - * @exception HeadlessException if GraphicsEnvironment.isHeadless() - * returns true. + * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()} + * returns {@code true}. * @see java.awt.GraphicsEnvironment#isHeadless * @see JComponent#getDefaultLocale */ @@ -160,22 +155,22 @@ public class JDialog extends Dialog implements WindowConstants, /** * Creates a modeless dialog without a title with the - * specified Frame as its owner. If owner - * is null, a shared, hidden frame will be set as the + * specified {@code Frame} as its owner. If {@code owner} + * is {@code null}, a shared, hidden frame will be set as the * owner of the dialog. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. *

* NOTE: This constructor does not allow you to create an unowned - * JDialog. To create an unowned JDialog - * you must use either the JDialog(Window) or - * JDialog(Dialog) constructor with an argument of - * null. + * {@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 Frame from which the dialog is displayed - * @exception HeadlessException if GraphicsEnvironment.isHeadless() - * returns true. + * @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 */ @@ -184,25 +179,25 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Creates a dialog with the specified owner Frame, modality - * and an empty title. If owner is null, + * Creates a dialog with the specified owner {@code Frame}, modality + * and an empty title. If {@code owner} is {@code null}, * a shared, hidden frame will be set as the owner of the dialog. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. *

* NOTE: This constructor does not allow you to create an unowned - * JDialog. To create an unowned JDialog - * you must use either the JDialog(Window) or - * JDialog(Dialog) constructor with an argument of - * null. + * {@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 Frame from which the dialog is displayed + * @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 true, the modality type property is set to - * DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless. - * @exception HeadlessException if GraphicsEnvironment.isHeadless() - * returns true. + * 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 */ @@ -212,24 +207,24 @@ public class JDialog extends Dialog implements WindowConstants, /** * Creates a modeless dialog with the specified title and - * with the specified owner frame. If owner - * is null, a shared, hidden frame will be set as the + * with the specified owner frame. If {@code owner} + * is {@code null}, a shared, hidden frame will be set as the * owner of the dialog. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. *

* NOTE: This constructor does not allow you to create an unowned - * JDialog. To create an unowned JDialog - * you must use either the JDialog(Window) or - * JDialog(Dialog) constructor with an argument of - * null. + * {@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 Frame from which the dialog is displayed - * @param title the String to display in the dialog's + * @param owner the {@code Frame} from which the dialog is displayed + * @param title the {@code String} to display in the dialog's * title bar - * @exception HeadlessException if GraphicsEnvironment.isHeadless() - * returns true. + * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()} + * returns {@code true}. * @see java.awt.GraphicsEnvironment#isHeadless * @see JComponent#getDefaultLocale */ @@ -238,31 +233,31 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Creates a dialog with the specified title, owner Frame - * and modality. If owner is null, + * 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. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. *

- * NOTE: Any popup components (JComboBox, - * JPopupMenu, JMenuBar) + * NOTE: Any popup components ({@code JComboBox}, + * {@code JPopupMenu}, {@code JMenuBar}) * created within a modal dialog will be forced to be lightweight. *

* NOTE: This constructor does not allow you to create an unowned - * JDialog. To create an unowned JDialog - * you must use either the JDialog(Window) or - * JDialog(Dialog) constructor with an argument of - * null. + * {@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 Frame from which the dialog is displayed - * @param title the String to display in the dialog's + * @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 true, the modality type property is set to - * DEFAULT_MODALITY_TYPE otherwise the dialog is modeless - * @exception HeadlessException if GraphicsEnvironment.isHeadless() - * returns true. + * 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 @@ -285,35 +280,35 @@ public class JDialog extends Dialog implements WindowConstants, /** * Creates a dialog with the specified title, - * owner Frame, modality and GraphicsConfiguration. - * If owner is null, + * 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. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. *

- * NOTE: Any popup components (JComboBox, - * JPopupMenu, JMenuBar) + * NOTE: Any popup components ({@code JComboBox}, + * {@code JPopupMenu}, {@code JMenuBar}) * created within a modal dialog will be forced to be lightweight. *

* NOTE: This constructor does not allow you to create an unowned - * JDialog. To create an unowned JDialog - * you must use either the JDialog(Window) or - * JDialog(Dialog) constructor with an argument of - * null. + * {@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 Frame from which the dialog is displayed - * @param title the String to display in the dialog's + * @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 true, the modality type property is set to - * DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless. - * @param gc the GraphicsConfiguration - * of the target screen device. If gc is - * null, the same - * GraphicsConfiguration as the owning Frame is used. - * @exception HeadlessException if GraphicsEnvironment.isHeadless() - * returns true. + * 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 gc} is + * {@code null}, the same + * {@code GraphicsConfiguration} as the owning Frame is used. + * @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 @@ -337,15 +332,15 @@ public class JDialog extends Dialog implements WindowConstants, /** * Creates a modeless dialog without a title with the - * specified Dialog as its owner. + * specified {@code Dialog} as its owner. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. * - * @param owner the owner Dialog from which the dialog is displayed - * or null if this dialog has no owner - * @exception HeadlessException if GraphicsEnvironment.isHeadless() - * returns true. + * @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 */ @@ -354,18 +349,18 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Creates a dialog with the specified owner Dialog and modality. + * Creates a dialog with the specified owner {@code Dialog} and modality. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. * - * @param owner the owner Dialog from which the dialog is displayed - * or null if this dialog has no owner + * @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 true, the modality type property is set to - * DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless. - * @exception HeadlessException if GraphicsEnvironment.isHeadless() - * returns true. + * 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 @@ -383,14 +378,14 @@ public class JDialog extends Dialog implements WindowConstants, * with the specified owner dialog. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. * - * @param owner the owner Dialog from which the dialog is displayed - * or null if this dialog has no owner - * @param title the String to display in the dialog's + * @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 - * @exception HeadlessException if GraphicsEnvironment.isHeadless() - * returns true. + * @throws HeadlessException if {@code GraphicsEnvironment.isHeadless()} + * returns {@code true}. * @see java.awt.GraphicsEnvironment#isHeadless * @see JComponent#getDefaultLocale */ @@ -400,20 +395,20 @@ public class JDialog extends Dialog implements WindowConstants, /** * Creates a dialog with the specified title, modality - * and the specified owner Dialog. + * and the specified owner {@code Dialog}. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. * - * @param owner the owner Dialog from which the dialog is displayed - * or null if this dialog has no owner - * @param title the String to display in the dialog's + * @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 true, the modality type property is set to - * DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless - * @exception HeadlessException if GraphicsEnvironment.isHeadless() - * returns true. + * 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 @@ -428,30 +423,30 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Creates a dialog with the specified title, owner Dialog, - * modality and GraphicsConfiguration. + * Creates a dialog with the specified title, owner {@code Dialog}, + * modality and {@code GraphicsConfiguration}. * *

- * NOTE: Any popup components (JComboBox, - * JPopupMenu, JMenuBar) + * NOTE: Any popup components ({@code JComboBox}, + * {@code JPopupMenu}, {@code 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. + * returned by {@code JComponent.getDefaultLocale}. * - * @param owner the owner Dialog from which the dialog is displayed - * or null if this dialog has no owner - * @param title the String to display in the dialog's + * @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 true, the modality type property is set to - * DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless - * @param gc the GraphicsConfiguration - * of the target screen device. If gc is - * null, the same - * GraphicsConfiguration as the owning Dialog is used. - * @exception HeadlessException if GraphicsEnvironment.isHeadless() - * returns true. + * 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 gc} is + * {@code null}, the same + * {@code GraphicsConfiguration} as the owning Dialog is used. + * @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 @@ -468,16 +463,22 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Creates a modeless dialog with the specified owner Window and + * Creates a modeless dialog with the specified owner {@code Window} and * an empty title. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. * - * @param owner the Window from which the dialog is displayed or - * null if this dialog has no owner - * @exception HeadlessException when - * GraphicsEnvironment.isHeadless() returns true + * @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 @@ -489,19 +490,28 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Creates a dialog with the specified owner Window, modality + * Creates a dialog with the specified owner {@code Window}, modality * and an empty title. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. * - * @param owner the Window from which the dialog is displayed or - * null if this dialog has no owner + * @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. null value and unsupported modality - * types are equivalent to MODELESS - * @exception HeadlessException when - * GraphicsEnvironment.isHeadless() returns true + * 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} + * @throws SecurityException + * if the calling thread does not have permission to create modal dialogs + * with the given {@code modalityType} * * @see java.awt.Dialog.ModalityType * @see java.awt.Dialog#setModal @@ -517,17 +527,23 @@ public class JDialog extends Dialog implements WindowConstants, /** * Creates a modeless dialog with the specified title and owner - * Window. + * {@code Window}. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. * - * @param owner the Window from which the dialog is displayed or - * null if this dialog has no owner - * @param title the String to display in the dialog's - * title bar or null if the dialog has no title - * @exception java.awt.HeadlessException when - * GraphicsEnvironment.isHeadless() returns true + * @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 @@ -539,21 +555,30 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Creates a dialog with the specified title, owner Window and + * Creates a dialog with the specified title, owner {@code Window} and * modality. *

* This constructor sets the component's locale property to the value - * returned by JComponent.getDefaultLocale. + * returned by {@code JComponent.getDefaultLocale}. * - * @param owner the Window from which the dialog is displayed or - * null if this dialog has no owner - * @param title the String to display in the dialog's - * title bar or null if the dialog has no title + * @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. null value and unsupported modality - * types are equivalent to MODELESS - * @exception java.awt.HeadlessException when - * GraphicsEnvironment.isHeadless() returns true + * 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} + * @throws SecurityException + * if the calling thread does not have permission to create modal dialogs + * with the given {@code modalityType} * * @see java.awt.Dialog.ModalityType * @see java.awt.Dialog#setModal @@ -569,29 +594,38 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Creates a dialog with the specified title, owner Window, - * modality and GraphicsConfiguration. + * Creates a dialog with the specified title, owner {@code Window}, + * modality and {@code GraphicsConfiguration}. *

- * NOTE: Any popup components (JComboBox, - * JPopupMenu, JMenuBar) + * NOTE: Any popup components ({@code JComboBox}, + * {@code JPopupMenu}, {@code 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. + * returned by {@code JComponent.getDefaultLocale}. * - * @param owner the Window from which the dialog is displayed or - * null if this dialog has no owner - * @param title the String to display in the dialog's - * title bar or null if the dialog has no title + * @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. null value and unsupported modality - * types are equivalent to MODELESS - * @param gc the GraphicsConfiguration of the target screen device; - * if null, the GraphicsConfiguration from the owning - * window is used; if owner is also null, the - * system default GraphicsConfiguration is assumed - * @exception java.awt.HeadlessException when - * GraphicsEnvironment.isHeadless() returns true + * 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 {@code GraphicsConfiguration} from the owning + * window is used; if {@code owner} is also {@code null}, the + * system default {@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} + * @throws SecurityException + * if the calling thread does not have permission to create modal dialogs + * with the given {@code modalityType} * * @see java.awt.Dialog.ModalityType * @see java.awt.Dialog#setModal @@ -608,7 +642,7 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Called by the constructors to init the JDialog properly. + * Called by the constructors to init the {@code JDialog} properly. */ protected void dialogInit() { enableEvents(AWTEvent.KEY_EVENT_MASK | AWTEvent.WINDOW_EVENT_MASK); @@ -628,7 +662,7 @@ public class JDialog extends Dialog implements WindowConstants, /** * Called by the constructor methods to create the default - * rootPane. + * {@code rootPane}. */ protected JRootPane createRootPane() { JRootPane rp = new JRootPane(); @@ -642,7 +676,7 @@ public class JDialog extends Dialog implements WindowConstants, /** * Handles window events depending on the state of the - * defaultCloseOperation property. + * {@code defaultCloseOperation} property. * * @see #setDefaultCloseOperation */ @@ -671,26 +705,26 @@ public class JDialog extends Dialog implements WindowConstants, * You must specify one of the following choices: *

*

*

- * The value is set to HIDE_ON_CLOSE by default. Changes + * 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". *

@@ -779,9 +813,9 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Gets the transferHandler property. + * Gets the {@code transferHandler} property. * - * @return the value of the transferHandler property + * @return the value of the {@code transferHandler} property * * @see TransferHandler * @see #setTransferHandler @@ -792,10 +826,10 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Calls paint(g). This method was overridden to + * Calls {@code paint(g)}. This method was overridden to * prevent an unnecessary call to clear the background. * - * @param g the Graphics context in which to paint + * @param g the {@code Graphics} context in which to paint */ public void update(Graphics g) { paint(g); @@ -827,10 +861,10 @@ public class JDialog extends Dialog implements WindowConstants, /** - * Returns whether calls to add and - * setLayout are forwarded to the contentPane. + * Returns whether calls to {@code add} and + * {@code setLayout} are forwarded to the {@code contentPane}. * - * @return true if add and setLayout + * @return true if {@code add} and {@code setLayout} * are fowarded; false otherwise * * @see #addImpl @@ -844,12 +878,12 @@ public class JDialog extends Dialog implements WindowConstants, /** - * Sets whether calls to add and - * setLayout are forwarded to the contentPane. + * Sets whether calls to {@code add} and + * {@code setLayout} are forwarded to the {@code contentPane}. * - * @param enabled true if add and setLayout + * @param enabled true if {@code add} and {@code setLayout} * are forwarded, false if they should operate directly on the - * JDialog. + * {@code JDialog}. * * @see #addImpl * @see #setLayout @@ -864,20 +898,20 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Adds the specified child Component. + * Adds the specified child {@code Component}. * This method is overridden to conditionally forward calls to the - * contentPane. - * By default, children are added to the contentPane instead + * {@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 - * @exception IllegalArgumentException if index is invalid - * @exception IllegalArgumentException if adding the container's parent + * @throws IllegalArgumentException if {@code index} is invalid + * @throws IllegalArgumentException if adding the container's parent * to itself - * @exception IllegalArgumentException if adding a window to a container + * @throws IllegalArgumentException if adding a window to a container * * @see #setRootPaneCheckingEnabled * @see javax.swing.RootPaneContainer @@ -894,13 +928,13 @@ public class JDialog extends Dialog implements WindowConstants, /** * Removes the specified component from the container. If - * comp is not the rootPane, this will forward - * the call to the contentPane. This will do nothing if - * comp is not a child of the JDialog or - * contentPane. + * {@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 comp is null + * @throws NullPointerException if {@code comp} is null * @see #add * @see javax.swing.RootPaneContainer */ @@ -914,13 +948,13 @@ public class JDialog extends Dialog implements WindowConstants, /** - * Sets the LayoutManager. + * Sets the {@code LayoutManager}. * Overridden to conditionally forward the call to the - * contentPane. + * {@code contentPane}. * Refer to {@link javax.swing.RootPaneContainer} for * more information. * - * @param manager the LayoutManager + * @param manager the {@code LayoutManager} * @see #setRootPaneCheckingEnabled * @see javax.swing.RootPaneContainer */ @@ -935,7 +969,7 @@ public class JDialog extends Dialog implements WindowConstants, /** - * Returns the rootPane object for this dialog. + * Returns the {@code rootPane} object for this dialog. * * @see #setRootPane * @see RootPaneContainer#getRootPane @@ -946,10 +980,10 @@ public class JDialog extends Dialog implements WindowConstants, /** - * Sets the rootPane property. + * Sets the {@code rootPane} property. * This method is called by the constructor. * - * @param root the rootPane object for this dialog + * @param root the {@code rootPane} object for this dialog * * @see #getRootPane * @@ -976,9 +1010,9 @@ public class JDialog extends Dialog implements WindowConstants, /** - * Returns the contentPane object for this dialog. + * Returns the {@code contentPane} object for this dialog. * - * @return the contentPane property + * @return the {@code contentPane} property * * @see #setContentPane * @see RootPaneContainer#getContentPane @@ -989,19 +1023,19 @@ public class JDialog extends Dialog implements WindowConstants, /** - * Sets the contentPane property. + * Sets the {@code contentPane} property. * This method is called by the constructor. *

- * Swing's painting architecture requires an opaque JComponent + * Swing's painting architecture requires an opaque {@code JComponent} * in the containment hiearchy. This is typically provided by the * content pane. If you replace the content pane it is recommended you - * replace it with an opaque JComponent. + * replace it with an opaque {@code JComponent}. * @see JRootPane * - * @param contentPane the contentPane object for this dialog + * @param contentPane the {@code contentPane} object for this dialog * - * @exception java.awt.IllegalComponentStateException (a runtime - * exception) if the content pane parameter is null + * @throws java.awt.IllegalComponentStateException (a runtime + * exception) if the content pane parameter is {@code null} * @see #getContentPane * @see RootPaneContainer#setContentPane * @@ -1015,9 +1049,9 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Returns the layeredPane object for this dialog. + * Returns the {@code layeredPane} object for this dialog. * - * @return the layeredPane property + * @return the {@code layeredPane} property * * @see #setLayeredPane * @see RootPaneContainer#getLayeredPane @@ -1027,12 +1061,12 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Sets the layeredPane property. + * Sets the {@code layeredPane} property. * This method is called by the constructor. * - * @param layeredPane the new layeredPane property + * @param layeredPane the new {@code layeredPane} property * - * @exception java.awt.IllegalComponentStateException (a runtime + * @throws java.awt.IllegalComponentStateException (a runtime * exception) if the layered pane parameter is null * @see #getLayeredPane * @see RootPaneContainer#setLayeredPane @@ -1046,9 +1080,9 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Returns the glassPane object for this dialog. + * Returns the {@code glassPane} object for this dialog. * - * @return the glassPane property + * @return the {@code glassPane} property * * @see #setGlassPane * @see RootPaneContainer#getGlassPane @@ -1058,10 +1092,10 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Sets the glassPane property. + * Sets the {@code glassPane} property. * This method is called by the constructor. * - * @param glassPane the glassPane object for this dialog + * @param glassPane the {@code glassPane} object for this dialog * @see #getGlassPane * @see RootPaneContainer#setGlassPane * @@ -1085,7 +1119,7 @@ public class JDialog extends Dialog implements WindowConstants, /** * Repaints the specified rectangle of this component within - * time milliseconds. Refer to RepaintManager + * {@code time} milliseconds. Refer to {@code RepaintManager} * for details on how the repaint is handled. * * @param time maximum time in milliseconds before update @@ -1107,15 +1141,15 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Provides a hint as to whether or not newly created JDialogs + * Provides a hint as to whether or not newly created {@code JDialog}s * should have their Window decorations (such as borders, widgets to * close the window, title...) provided by the current look - * and feel. If defaultLookAndFeelDecorated is true, - * the current LookAndFeel supports providing window + * and feel. If {@code defaultLookAndFeelDecorated} is true, + * the current {@code LookAndFeel} supports providing window * decorations, and the current window manager supports undecorated - * windows, then newly created JDialogs will have their - * Window decorations provided by the current LookAndFeel. - * Otherwise, newly created JDialogs will have their + * windows, then newly created {@code JDialog}s will have their + * Window decorations provided by the current {@code LookAndFeel}. + * Otherwise, newly created {@code JDialog}s will have their * Window decorations provided by the current window manager. *

* You can get the same effect on a single JDialog by doing the following: @@ -1139,7 +1173,7 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Returns true if newly created JDialogs should have their + * Returns true if newly created {@code JDialog}s should have their * Window decorations provided by the current look and feel. This is only * a hint, as certain look and feels may not support this feature. * @@ -1156,14 +1190,14 @@ public class JDialog extends Dialog implements WindowConstants, } /** - * Returns a string representation of this JDialog. + * Returns a string representation of this {@code JDialog}. * This method * is intended to be used only for debugging purposes, and the * content and format of the returned string may vary between * implementations. The returned string may be empty but may not - * be null. + * be {@code null}. * - * @return a string representation of this JDialog. + * @return a string representation of this {@code JDialog}. */ protected String paramString() { String defaultCloseOperationString; @@ -1210,7 +1244,7 @@ public class JDialog extends Dialog implements WindowConstants, /** * This class implements accessibility support for the - * JDialog class. It provides an implementation of the + * {@code JDialog} class. It provides an implementation of the * Java Accessibility API appropriate to dialog user-interface * elements. */