JDialog (Java 2 Platform SE 5.0) (original) (raw)

javax.swing

Class JDialog

java.lang.Object extended by java.awt.Component extended by java.awt.Container extended by java.awt.Window extended by java.awt.Dialog extended by javax.swing.JDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

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_ sectionHow to Make Dialogs.

The JDialog component contains a JRootPane as its only child. The contentPane should be the parent of any children of theJDialog. As a conveniance add and its variants, remove andsetLayout have been overridden to forward to thecontentPane 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 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: 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 JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

See Also:

JOptionPane, JRootPane, RootPaneContainer

Nested Class Summary
protected class JDialog.AccessibleJDialog This class implements accessibility support for the JDialog class.
Nested classes/interfaces inherited from class java.awt.Dialog
Dialog.AccessibleAWTDialog
Nested classes/interfaces inherited from class java.awt.Window
Window.AccessibleAWTWindow
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
Field Summary
protected AccessibleContext accessibleContext
protected JRootPane rootPane
protected boolean rootPaneCheckingEnabled If true then calls to add and setLayout will be forwarded to the contentPane.
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor Summary
JDialog() Creates a non-modal dialog without a title and without a specifiedFrame owner.
JDialog(Dialog owner) Creates a non-modal dialog without a title with the specified Dialog as its owner.
[JDialog](../../javax/swing/JDialog.html#JDialog%28java.awt.Dialog, boolean%29)(Dialog owner, boolean modal) Creates a modal or non-modal dialog without a title and with the specified owner dialog.
[JDialog](../../javax/swing/JDialog.html#JDialog%28java.awt.Dialog, java.lang.String%29)(Dialog owner,String title) Creates a non-modal dialog with the specified title and with the specified owner dialog.
[JDialog](../../javax/swing/JDialog.html#JDialog%28java.awt.Dialog, java.lang.String, boolean%29)(Dialog owner,String title, boolean modal) Creates a modal or non-modal dialog with the specified title and the specified owner frame.
[JDialog](../../javax/swing/JDialog.html#JDialog%28java.awt.Dialog, java.lang.String, boolean, java.awt.GraphicsConfiguration%29)(Dialog owner,String title, boolean modal,GraphicsConfiguration gc) Creates a modal or non-modal dialog with the specified title, owner Dialog, and GraphicsConfiguration.
JDialog(Frame owner) Creates a non-modal dialog without a title with the specified Frame as its owner.
[JDialog](../../javax/swing/JDialog.html#JDialog%28java.awt.Frame, boolean%29)(Frame owner, boolean modal) Creates a modal or non-modal dialog without a title and with the specified owner Frame.
[JDialog](../../javax/swing/JDialog.html#JDialog%28java.awt.Frame, java.lang.String%29)(Frame owner,String title) Creates a non-modal dialog with the specified title and with the specified owner frame.
[JDialog](../../javax/swing/JDialog.html#JDialog%28java.awt.Frame, java.lang.String, boolean%29)(Frame owner,String title, boolean modal) Creates a modal or non-modal dialog with the specified title and the specified owner Frame.
[JDialog](../../javax/swing/JDialog.html#JDialog%28java.awt.Frame, java.lang.String, boolean, java.awt.GraphicsConfiguration%29)(Frame owner,String title, boolean modal,GraphicsConfiguration gc) Creates a modal or non-modal dialog with the specified title, owner Frame, and GraphicsConfiguration.
Method Summary
protected void [addImpl](../../javax/swing/JDialog.html#addImpl%28java.awt.Component, java.lang.Object, int%29)(Component comp,Object constraints, int index) Adds the specified child Component.
protected JRootPane createRootPane() Called by the constructor methods to create the defaultrootPane.
protected void dialogInit() Called by the constructors to init the JDialog properly.
AccessibleContext getAccessibleContext() Gets the AccessibleContext associated with this JDialog.
Container getContentPane() Returns the contentPane object for this dialog.
int getDefaultCloseOperation() Returns the operation which occurs when the user initiates a "close" on this dialog.
Component getGlassPane() Returns the glassPane object for this dialog.
JMenuBar getJMenuBar() Returns the menubar set on this dialog.
JLayeredPane getLayeredPane() Returns the layeredPane object for this dialog.
JRootPane getRootPane() Returns the rootPane object for this dialog.
static boolean isDefaultLookAndFeelDecorated() Returns true if newly created JDialogs should have their Window decorations provided by the current look and feel.
protected boolean isRootPaneCheckingEnabled() Returns whether calls to add and setLayout are forwarded to the contentPane.
protected String paramString() Returns a string representation of this JDialog.
protected void processWindowEvent(WindowEvent e) Handles window events depending on the state of thedefaultCloseOperation property.
void remove(Component comp) Removes the specified component from the container.
void setContentPane(Container contentPane) Sets the contentPane property.
void setDefaultCloseOperation(int operation) Sets the operation which will happen by default when the user initiates a "close" on this dialog.
static void setDefaultLookAndFeelDecorated(boolean defaultLookAndFeelDecorated) Provides a hint as to whether or not newly created JDialogs should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel.
void setGlassPane(Component glassPane) Sets the glassPane property.
void setJMenuBar(JMenuBar menu) Sets the menubar for this dialog.
void setLayeredPane(JLayeredPane layeredPane) Sets the layeredPane property.
void setLayout(LayoutManager manager) Sets the LayoutManager.
protected void setRootPane(JRootPane root) Sets the rootPane property.
protected void setRootPaneCheckingEnabled(boolean enabled) Sets whether calls to add and setLayout are forwarded to the contentPane.
void update(Graphics g) Calls paint(g).
Methods inherited from class java.awt.Dialog
addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
Methods inherited from class java.awt.Window
addPropertyChangeListener, [addPropertyChangeListener](../../java/awt/Window.html#addPropertyChangeListener%28java.lang.String, java.beans.PropertyChangeListener%29), addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, [createBufferStrategy](../../java/awt/Window.html#createBufferStrategy%28int, java.awt.BufferCapabilities%29), dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, [setBounds](../../java/awt/Window.html#setBounds%28int, int, int, int%29), setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, toFront
Methods inherited from class java.awt.Container
add, [add](../../java/awt/Container.html#add%28java.awt.Component, int%29), [add](../../java/awt/Container.html#add%28java.awt.Component, java.lang.Object%29), [add](../../java/awt/Container.html#add%28java.awt.Component, java.lang.Object, int%29), [add](../../java/awt/Container.html#add%28java.lang.String, java.awt.Component%29), addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, [findComponentAt](../../java/awt/Container.html#findComponentAt%28int, int%29), findComponentAt, getAlignmentX, getAlignmentY, getComponent, [getComponentAt](../../java/awt/Container.html#getComponentAt%28int, int%29), getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, [list](../../java/awt/Container.html#list%28java.io.PrintStream, int%29), [list](../../java/awt/Container.html#list%28java.io.PrintWriter, int%29), [locate](../../java/awt/Container.html#locate%28int, int%29), minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, [setComponentZOrder](../../java/awt/Container.html#setComponentZOrder%28java.awt.Component, int%29), [setFocusTraversalKeys](../../java/awt/Container.html#setFocusTraversalKeys%28int, java.util.Set%29), setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree
Methods inherited from class java.awt.Component
[action](../../java/awt/Component.html#action%28java.awt.Event, java.lang.Object%29), add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, [checkImage](../../java/awt/Component.html#checkImage%28java.awt.Image, java.awt.image.ImageObserver%29), [checkImage](../../java/awt/Component.html#checkImage%28java.awt.Image, int, int, java.awt.image.ImageObserver%29), [coalesceEvents](../../java/awt/Component.html#coalesceEvents%28java.awt.AWTEvent, java.awt.AWTEvent%29), [contains](../../java/awt/Component.html#contains%28int, int%29), contains, createImage, [createImage](../../java/awt/Component.html#createImage%28int, int%29), [createVolatileImage](../../java/awt/Component.html#createVolatileImage%28int, int%29), [createVolatileImage](../../java/awt/Component.html#createVolatileImage%28int, int, java.awt.ImageCapabilities%29), disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, boolean, boolean%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, byte, byte%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, char, char%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, double, double%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, float, float%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, int, int%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, long, long%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, java.lang.Object, java.lang.Object%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, short, short%29), getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, [gotFocus](../../java/awt/Component.html#gotFocus%28java.awt.Event, java.lang.Object%29), handleEvent, hasFocus, [imageUpdate](../../java/awt/Component.html#imageUpdate%28java.awt.Image, int, int, int, int, int%29), [inside](../../java/awt/Component.html#inside%28int, int%29), isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, [keyDown](../../java/awt/Component.html#keyDown%28java.awt.Event, int%29), [keyUp](../../java/awt/Component.html#keyUp%28java.awt.Event, int%29), list, list, list, location, [lostFocus](../../java/awt/Component.html#lostFocus%28java.awt.Event, java.lang.Object%29), [mouseDown](../../java/awt/Component.html#mouseDown%28java.awt.Event, int, int%29), [mouseDrag](../../java/awt/Component.html#mouseDrag%28java.awt.Event, int, int%29), [mouseEnter](../../java/awt/Component.html#mouseEnter%28java.awt.Event, int, int%29), [mouseExit](../../java/awt/Component.html#mouseExit%28java.awt.Event, int, int%29), [mouseMove](../../java/awt/Component.html#mouseMove%28java.awt.Event, int, int%29), [mouseUp](../../java/awt/Component.html#mouseUp%28java.awt.Event, int, int%29), [move](../../java/awt/Component.html#move%28int, int%29), nextFocus, paintAll, [prepareImage](../../java/awt/Component.html#prepareImage%28java.awt.Image, java.awt.image.ImageObserver%29), [prepareImage](../../java/awt/Component.html#prepareImage%28java.awt.Image, int, int, java.awt.image.ImageObserver%29), printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, [removePropertyChangeListener](../../java/awt/Component.html#removePropertyChangeListener%28java.lang.String, java.beans.PropertyChangeListener%29), repaint, [repaint](../../java/awt/Component.html#repaint%28int, int, int, int%29), repaint, [repaint](../../java/awt/Component.html#repaint%28long, int, int, int, int%29), requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, [reshape](../../java/awt/Component.html#reshape%28int, int, int, int%29), resize, [resize](../../java/awt/Component.html#resize%28int, int%29), setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, [setLocation](../../java/awt/Component.html#setLocation%28int, int%29), setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, [setSize](../../java/awt/Component.html#setSize%28int, int%29), setVisible, show, size, toString, transferFocus, transferFocusUpCycle
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)
Field Detail

rootPane

protected JRootPane rootPane

See Also:

getRootPane(), setRootPane(javax.swing.JRootPane)

rootPaneCheckingEnabled

protected boolean rootPaneCheckingEnabled

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.

See Also:

isRootPaneCheckingEnabled(), setRootPaneCheckingEnabled(boolean), RootPaneContainer

accessibleContext

protected AccessibleContext accessibleContext

Constructor Detail

JDialog

public JDialog() throws HeadlessException

Creates a non-modal dialog without a title and without a specifiedFrame owner. A shared, hidden frame will be set as the owner of the dialog.

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

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JDialog

public JDialog(Frame owner) throws HeadlessException

Creates a non-modal dialog without a title with the specified 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.

Parameters:

owner - the Frame from which the dialog is displayed

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JDialog

public JDialog(Frame owner, boolean modal) throws HeadlessException

Creates a modal or non-modal dialog without a 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.

Parameters:

owner - the Frame from which the dialog is displayed

modal - true for a modal dialog, false for one that allows others windows to be active at the same time

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JDialog

public JDialog(Frame owner, String title) throws HeadlessException

Creates a non-modal 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.

Parameters:

owner - the Frame from which the dialog is displayed

title - the String to display in the dialog's title bar

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JDialog

public JDialog(Frame owner, String title, boolean modal) throws HeadlessException

Creates a modal or non-modal dialog with the specified title and the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of this dialog. All constructors defer to this one.

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

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

Parameters:

owner - the Frame from which the dialog is displayed

title - the String to display in the dialog's title bar

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JDialog

public JDialog(Frame owner, String title, boolean modal, GraphicsConfiguration gc)

Creates a modal or non-modal dialog with the specified title, owner Frame, and GraphicsConfiguration.

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

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

Parameters:

owner - the Frame from which the dialog is displayed

title - the String to display in the dialog's title bar

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

gc - the GraphicsConfiguration of the target screen device. If gc is null, the sameGraphicsConfiguration as the owning Frame is used.

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

Since:

1.4

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JDialog

public JDialog(Dialog owner) throws HeadlessException

Creates a non-modal dialog without a title with the specified Dialog as its owner.

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

Parameters:

owner - the non-null Dialog from which the dialog is displayed

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JDialog

public JDialog(Dialog owner, boolean modal) throws HeadlessException

Creates a modal or non-modal dialog without a 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 non-null Dialog from which the dialog is displayed

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JDialog

public JDialog(Dialog owner, String title) throws HeadlessException

Creates a non-modal 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 non-null Dialog from which the dialog is displayed

title - the String to display in the dialog's title bar

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JDialog

public JDialog(Dialog owner, String title, boolean modal) throws HeadlessException

Creates a modal or non-modal dialog with the specified title and the specified owner frame.

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

Parameters:

owner - the non-null Dialog from which the dialog is displayed

title - the String to display in the dialog's title bar

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

JDialog

public JDialog(Dialog owner, String title, boolean modal, GraphicsConfiguration gc) throws HeadlessException

Creates a modal or non-modal dialog with the specified title, owner Dialog, and GraphicsConfiguration.

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

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

Parameters:

owner - the Dialog from which the dialog is displayed

title - the String to display in the dialog's title bar

modal - true for a modal dialog, false for one that allows other windows to be active at the same time

gc - the GraphicsConfiguration of the target screen device. If gc is null, the sameGraphicsConfiguration as the owning Dialog is used.

Throws:

[HeadlessException](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless()

Since:

1.4

See Also:

GraphicsEnvironment.isHeadless(), returns true.

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 defaultrootPane.

processWindowEvent

protected void processWindowEvent(WindowEvent e)

Handles window events depending on the state of thedefaultCloseOperation property.

Overrides:

[processWindowEvent](../../java/awt/Window.html#processWindowEvent%28java.awt.event.WindowEvent%29) in class [Window](../../java/awt/Window.html "class in java.awt")

Parameters:

e - the window event

See Also:

setDefaultCloseOperation(int)

setDefaultCloseOperation

public void setDefaultCloseOperation(int operation)

Sets the operation which will happen by default when the user initiates a "close" on this dialog. The possible choices are:

The value is set to HIDE_ON_CLOSE by default.

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.

See Also:

Window.addWindowListener(java.awt.event.WindowListener), getDefaultCloseOperation()

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)

update

public void update(Graphics g)

Calls paint(g). This method was overridden to prevent an unnecessary call to clear the background.

Overrides:

[update](../../java/awt/Container.html#update%28java.awt.Graphics%29) in class [Container](../../java/awt/Container.html "class in java.awt")

Parameters:

g - the Graphics context in which to paint

See Also:

Component.update(Graphics)

setJMenuBar

public void setJMenuBar(JMenuBar menu)

Sets the menubar for this dialog.

Parameters:

menu - the menubar being placed in the dialog

See Also:

getJMenuBar()

getJMenuBar

public JMenuBar getJMenuBar()

Returns the menubar set on this dialog.

See Also:

setJMenuBar(javax.swing.JMenuBar)

isRootPaneCheckingEnabled

protected boolean isRootPaneCheckingEnabled()

Returns whether calls to add and setLayout are forwarded to the contentPane.

Returns:

true if add and setLayout are fowarded; false otherwise

See Also:

[addImpl(java.awt.Component, java.lang.Object, int)](../../javax/swing/JDialog.html#addImpl%28java.awt.Component, java.lang.Object, int%29), setLayout(java.awt.LayoutManager), setRootPaneCheckingEnabled(boolean), RootPaneContainer

setRootPaneCheckingEnabled

protected void setRootPaneCheckingEnabled(boolean enabled)

Sets whether calls to add and setLayout are forwarded to the contentPane.

Parameters:

enabled - true if add and setLayout are forwarded, false if they should operate directly on theJDialog.

See Also:

[addImpl(java.awt.Component, java.lang.Object, int)](../../javax/swing/JDialog.html#addImpl%28java.awt.Component, java.lang.Object, int%29), setLayout(java.awt.LayoutManager), isRootPaneCheckingEnabled(), RootPaneContainer

addImpl

protected void addImpl(Component comp, Object constraints, int index)

Adds the specified child Component. This method is overridden to conditionally forwad calls to thecontentPane. By default, children are added to the contentPane instead of the frame, refer to RootPaneContainer for details.

Overrides:

[addImpl](../../java/awt/Container.html#addImpl%28java.awt.Component, java.lang.Object, int%29) in class [Container](../../java/awt/Container.html "class in java.awt")

Parameters:

comp - the component to be enhanced

constraints - the constraints to be respected

index - the index

Throws:

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if index is invalid

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if adding the container's parent to itself

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if adding a window to a container

See Also:

setRootPaneCheckingEnabled(boolean), RootPaneContainer

remove

public void remove(Component comp)

Removes the specified component from the container. Ifcomp is not the rootPane, this will forward the call to the contentPane. This will do nothing ifcomp is not a child of the JDialog orcontentPane.

Overrides:

[remove](../../java/awt/Container.html#remove%28java.awt.Component%29) in class [Container](../../java/awt/Container.html "class in java.awt")

Parameters:

comp - the component to be removed

Throws:

[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang") - if comp is null

See Also:

Container.add(java.awt.Component), RootPaneContainer

setLayout

public void setLayout(LayoutManager manager)

Sets the LayoutManager. Overridden to conditionally forward the call to thecontentPane. Refer to RootPaneContainer for more information.

Overrides:

[setLayout](../../java/awt/Container.html#setLayout%28java.awt.LayoutManager%29) in class [Container](../../java/awt/Container.html "class in java.awt")

Parameters:

manager - the LayoutManager

See Also:

setRootPaneCheckingEnabled(boolean), RootPaneContainer

getRootPane

public JRootPane getRootPane()

Returns the rootPane object for this dialog.

Specified by:

[getRootPane](../../javax/swing/RootPaneContainer.html#getRootPane%28%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")

Returns:

this components single JRootPane child.

See Also:

setRootPane(javax.swing.JRootPane), RootPaneContainer.getRootPane()

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()

getContentPane

public Container getContentPane()

Returns the contentPane object for this dialog.

Specified by:

[getContentPane](../../javax/swing/RootPaneContainer.html#getContentPane%28%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")

Returns:

the contentPane property

See Also:

setContentPane(java.awt.Container), RootPaneContainer.getContentPane()

setContentPane

public void setContentPane(Container contentPane)

Sets the contentPane property. This method is called by the constructor.

Swing's painting architecture requires an opaque 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.

Specified by:

[setContentPane](../../javax/swing/RootPaneContainer.html#setContentPane%28java.awt.Container%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")

Parameters:

contentPane - the contentPane object for this dialog

Throws:

[IllegalComponentStateException](../../java/awt/IllegalComponentStateException.html "class in java.awt") - (a runtime exception) if the content pane parameter is null

See Also:

JRootPane, getContentPane(), RootPaneContainer.setContentPane(java.awt.Container)

getLayeredPane

public JLayeredPane getLayeredPane()

Returns the layeredPane object for this dialog.

Specified by:

[getLayeredPane](../../javax/swing/RootPaneContainer.html#getLayeredPane%28%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")

Returns:

the layeredPane property

See Also:

setLayeredPane(javax.swing.JLayeredPane), RootPaneContainer.getLayeredPane()

setLayeredPane

public void setLayeredPane(JLayeredPane layeredPane)

Sets the layeredPane property. This method is called by the constructor.

Specified by:

[setLayeredPane](../../javax/swing/RootPaneContainer.html#setLayeredPane%28javax.swing.JLayeredPane%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")

Parameters:

layeredPane - the new layeredPane property

Throws:

[IllegalComponentStateException](../../java/awt/IllegalComponentStateException.html "class in java.awt") - (a runtime exception) if the layered pane parameter is null

See Also:

getLayeredPane(), RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)

getGlassPane

public Component getGlassPane()

Returns the glassPane object for this dialog.

Specified by:

[getGlassPane](../../javax/swing/RootPaneContainer.html#getGlassPane%28%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")

Returns:

the glassPane property

See Also:

setGlassPane(java.awt.Component), RootPaneContainer.getGlassPane()

setGlassPane

public void setGlassPane(Component glassPane)

Sets the glassPane property. This method is called by the constructor.

Specified by:

[setGlassPane](../../javax/swing/RootPaneContainer.html#setGlassPane%28java.awt.Component%29) in interface [RootPaneContainer](../../javax/swing/RootPaneContainer.html "interface in javax.swing")

Parameters:

glassPane - the glassPane object for this dialog

See Also:

getGlassPane(), RootPaneContainer.setGlassPane(java.awt.Component)

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](../../java/awt/Dialog.html#paramString%28%29) in class [Dialog](../../java/awt/Dialog.html "class in java.awt")

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](../../javax/accessibility/Accessible.html#getAccessibleContext%28%29) in interface [Accessible](../../javax/accessibility/Accessible.html "interface in javax.accessibility")

Overrides:

[getAccessibleContext](../../java/awt/Dialog.html#getAccessibleContext%28%29) in class [Dialog](../../java/awt/Dialog.html "class in java.awt")

Returns:

an AccessibleJDialog that serves as the AccessibleContext of this JDialog

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.