Module java.desktop
Package javax.swing

Class JDialog

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants
    @JavaBean(defaultProperty="JMenuBar",
          description="A toplevel window for creating dialog boxes.")
public class JDialog
extends Dialog
implements WindowConstants, Accessible, RootPaneContainer
    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 JOptionPane to create a variety of standard dialogs. For information about creating dialogs, see The Java Tutorial section How to Make Dialogs.

    The JDialog component contains a JRootPane as its only child. The contentPane should be the parent of any children of the JDialog. As a convenience, the add, remove, and setLayout methods of this class are overridden, so that they delegate calls to the corresponding methods of the ContentPane. For example, you can add a child component to a dialog as follows: 

           dialog.add(child);
    And the child will be added to the contentPane. The contentPane is always non-null. Attempting to set it to null generates an exception. The default contentPane has a BorderLayout manager set on it. Refer to RootPaneContainer for details on adding, removing and setting the LayoutManager of a JDialog.

    Please see the JRootPane documentation for a complete description of the contentPane, glassPane, and layeredPane components.

    In a multi-screen environment, you can create a JDialog on a different screen device than its owner. See Frame for more information.

    Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

    Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

    Since:
    1.2
    See Also:
    JOptionPane, JRootPane, RootPaneContainer, Serialized Form

    • Constructor Detail

      • JDialog

        public JDialog()
        Creates a modeless dialog without a title and without a specified Frame owner. A shared, hidden frame will be set as the owner of the dialog.

        This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

        NOTE: This constructor does not allow you to create an unowned JDialog. To create an unowned JDialog you must use either the JDialog(Window) or JDialog(Dialog) constructor with an argument of null.

        Throws:
        HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
        See Also:
        GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

      • JDialog

        public JDialog​(Frame owner)
        Creates a modeless dialog with the specified Frame as its owner and an empty title. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

        This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

        NOTE: This constructor does not allow you to create an unowned JDialog. To create an unowned JDialog you must use either the JDialog(Window) or JDialog(Dialog) constructor with an argument of null.

        Parameters:
        owner - the Frame from which the dialog is displayed
        Throws:
        HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
        See Also:
        GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

      • JDialog

        public JDialog​(Frame owner,
               boolean modal)
        Creates a dialog with an empty title and the specified modality and Frame as its owner. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

        This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

        NOTE: This constructor does not allow you to create an unowned JDialog. To create an unowned JDialog you must use either the JDialog(Window) or JDialog(Dialog) constructor with an argument of null.

        Parameters:
        owner - the Frame from which the dialog is displayed
        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.
        Throws:
        HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
        See Also:
        GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

      • JDialog

        public JDialog​(Frame owner,
               String title)
        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 owner of the dialog.

        This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

        NOTE: This constructor does not allow you to create an unowned JDialog. To create an unowned JDialog you must use either the JDialog(Window) or JDialog(Dialog) constructor with an argument of null.

        Parameters:
        owner - the Frame from which the dialog is displayed
        title - the String to display in the dialog's title bar
        Throws:
        HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
        See Also:
        GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

      • JDialog

        public JDialog​(Frame owner,
               String title,
               boolean modal)
        Creates a dialog with the specified title, owner Frame and modality. If owner is null, a shared, hidden frame will be set as the owner of this dialog.

        This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

        NOTE: Any popup components (JComboBox, JPopupMenu, JMenuBar) created within a modal dialog will be forced to be lightweight.

        NOTE: This constructor does not allow you to create an unowned JDialog. To create an unowned JDialog you must use either the JDialog(Window) or JDialog(Dialog) constructor with an argument of null.

        Parameters:
        owner - the Frame from which the dialog is displayed
        title - the String to display in the dialog's title bar
        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
        Throws:
        HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
        See Also:
        Dialog.ModalityType, Dialog.ModalityType.MODELESS, Dialog.DEFAULT_MODALITY_TYPE, Dialog.setModal(boolean), Dialog.setModalityType(java.awt.Dialog.ModalityType), GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

      • JDialog

        public JDialog​(Frame owner,
               String title,
               boolean modal,
               GraphicsConfiguration gc)
        Creates a dialog with the specified title, owner Frame, modality and GraphicsConfiguration. If owner is null, a shared, hidden frame will be set as the owner of this dialog.

        This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

        NOTE: Any popup components (JComboBox, JPopupMenu, JMenuBar) created within a modal dialog will be forced to be lightweight.

        NOTE: This constructor does not allow you to create an unowned JDialog. To create an unowned JDialog you must use either the JDialog(Window) or JDialog(Dialog) constructor with an argument of null.

        Parameters:
        owner - the Frame from which the dialog is displayed
        title - the String to display in the dialog's title bar
        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.
        gc - the GraphicsConfiguration of the target screen device; if null, the default system GraphicsConfiguration is assumed
        Throws:
        HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
        Since:
        1.4
        See Also:
        Dialog.ModalityType, Dialog.ModalityType.MODELESS, Dialog.DEFAULT_MODALITY_TYPE, Dialog.setModal(boolean), Dialog.setModalityType(java.awt.Dialog.ModalityType), GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

      • JDialog

        public JDialog​(Dialog owner)
        Creates a modeless dialog with the specified Dialog as its owner and an empty title.

        This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

        Parameters:
        owner - the owner Dialog from which the dialog is displayed or null if this dialog has no owner
        Throws:
        HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
        See Also:
        GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

      • JDialog

        public JDialog​(Dialog owner,
               String title)
        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 owner Dialog from which the dialog is displayed or null if this dialog has no owner
        title - the String to display in the dialog's title bar
        Throws:
        HeadlessException - if GraphicsEnvironment.isHeadless() returns true.
        See Also:
        GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

      • JDialog

        public JDialog​(Window owner,
               String title)
        Creates a modeless dialog with the specified title and owner Window.

        This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

        Parameters:
        owner - the Window from which the dialog is displayed or null if this dialog has no owner
        title - the String to display in the dialog's title bar or null if the dialog has no title
        Throws:
        IllegalArgumentException - if the owner is not an instance of Dialog or Frame
        IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
        HeadlessException - when GraphicsEnvironment.isHeadless() returns true
        Since:
        1.6
        See Also:
        GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

    • Method Detail

      • dialogInit

        protected void dialogInit()
        Called by the constructors to init the JDialog properly.

      • createRootPane

        protected JRootPane createRootPane()
        Called by the constructor methods to create the default rootPane.
        Returns:
        a new JRootPane

      • 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 in WindowConstants): Don't do anything; require the program to handle the operation in the windowClosing method of a registered WindowListener object.
        • HIDE_ON_CLOSE (defined in WindowConstants): Automatically hide the dialog after invoking any registered WindowListener objects.
        • DISPOSE_ON_CLOSE (defined in WindowConstants): Automatically hide and dispose the dialog after invoking any registered WindowListener objects.

        The value is set to HIDE_ON_CLOSE by default. Changes to the value of this property cause the firing of a property change event, with property name "defaultCloseOperation".

        Note: When the last displayable window within the Java virtual machine (VM) is disposed of, the VM may terminate. See AWT Threading Issues for more information.

        Parameters:
        operation - the operation which should be performed when the user closes the dialog
        Throws:
        IllegalArgumentException - if defaultCloseOperation value isn't one of the above valid values
        See Also:
        Window.addWindowListener(java.awt.event.WindowListener), getDefaultCloseOperation(), WindowConstants

      • getDefaultCloseOperation

        public int getDefaultCloseOperation()
        Returns the operation which occurs when the user initiates a "close" on this dialog.
        Returns:
        an integer indicating the window-close operation
        See Also:
        setDefaultCloseOperation(int)

      • setTransferHandler

        @BeanProperty(hidden=true,
              description="Mechanism for transfer of data into the component")
public void setTransferHandler​(TransferHandler newHandler)
        Sets the transferHandler property, which is a mechanism to support transfer of data into this component. Use null if the component does not support data transfer operations.

        If the system property suppressSwingDropSupport is false (the default) and the current drop target on this component is either null or not a user-set drop target, this method will change the drop target as follows: If newHandler is null it will clear the drop target. If not null it will install a new DropTarget.

        Note: When used with JDialog, TransferHandler only provides data import capability, as the data export related methods are currently typed to JComponent.

        Please see How to Use Drag and Drop and Data Transfer, a section in The Java Tutorial, for more information.

        Parameters:
        newHandler - the new TransferHandler
        Since:
        1.6
        See Also:
        TransferHandler, getTransferHandler(), Component.setDropTarget(java.awt.dnd.DropTarget)

      • update

        public void update​(Graphics g)
        Calls paint(g). This method was overridden to prevent an unnecessary call to clear the background.
        Overrides:
        update in class Container
        Parameters:
        g - the Graphics context in which to paint
        See Also:
        Component.update(Graphics)

      • setJMenuBar

        @BeanProperty(bound=false,
              hidden=true,
              description="The menubar for accessing pulldown menus from this dialog.")
public void setJMenuBar​(JMenuBar menu)
        Sets the menubar for this dialog.
        Parameters:
        menu - the menubar being placed in the dialog
        See Also:
        getJMenuBar()

      • setRootPane

        protected void setRootPane​(JRootPane root)
        Sets the rootPane property. This method is called by the constructor.
        Parameters:
        root - the rootPane object for this dialog
        See Also:
        getRootPane()

      • repaint

        public void repaint​(long time,
                    int x,
                    int y,
                    int width,
                    int height)
        Repaints the specified rectangle of this component within time milliseconds. Refer to RepaintManager for details on how the repaint is handled.
        Overrides:
        repaint in class Component
        Parameters:
        time - maximum time in milliseconds before update
        x - the x coordinate
        y - the y coordinate
        width - the width
        height - the height
        Since:
        1.6
        See Also:
        RepaintManager

      • setDefaultLookAndFeelDecorated

        public static void setDefaultLookAndFeelDecorated​(boolean defaultLookAndFeelDecorated)
        Provides a hint as to whether or not newly created JDialogs should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel. If defaultLookAndFeelDecorated is true, the current LookAndFeel supports providing window decorations, and the current window manager supports undecorated windows, then newly created JDialogs will have their Window decorations provided by the current LookAndFeel. Otherwise, newly created JDialogs will have their Window decorations provided by the current window manager.

        You can get the same effect on a single JDialog by doing the following: 

            JDialog dialog = new JDialog();
    dialog.setUndecorated(true);
    dialog.getRootPane().setWindowDecorationStyle(JRootPane.PLAIN_DIALOG);

        Parameters:
        defaultLookAndFeelDecorated - A hint as to whether or not current look and feel should provide window decorations
        Since:
        1.4
        See Also:
        LookAndFeel.getSupportsWindowDecorations()

      • isDefaultLookAndFeelDecorated

        public static boolean isDefaultLookAndFeelDecorated()
        Returns true if newly created JDialogs 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

        protected String paramString()
        Returns a string representation of this 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.
        Overrides:
        paramString in class Dialog
        Returns:
        a string representation of this JDialog.

      • getAccessibleContext

        public AccessibleContext getAccessibleContext()
        Gets the AccessibleContext associated with this JDialog. For JDialogs, the AccessibleContext takes the form of an AccessibleJDialog. A new AccessibleJDialog instance is created if necessary.
        Specified by:
        getAccessibleContext in interface Accessible
        Overrides:
        getAccessibleContext in class Dialog
        Returns:
        an AccessibleJDialog that serves as the AccessibleContext of this JDialog