java.awt
Class Dialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
Direct Known Subclasses:
FileDialog, JDialog

public class Dialog
extends Window

Dialog provides a top-level window normally used to receive user input in applications.

A dialog always has another top-level window as owner and is only visible if this owner is visible to the user. The default layout of dialogs is the BorderLayout. Dialogs can be modal (blocks user input to other components) or non-modal (user input in other components are allowed).

See Also:
Serialized Form

Nested Class Summary
protected  class Dialog.AccessibleAWTDialog
          Accessibility support for Dialog.
static class Dialog.ModalExclusionType
           
static class Dialog.ModalityType
           
 
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
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
Dialog(Dialog owner)
          Initializes a new instance of Dialog with the specified, parent, that is resizable.
Dialog(Dialog owner, String title)
          Initializes a new instance of Dialog with the specified, parent and title, that is resizable.
Dialog(Dialog owner, String title, boolean modal)
          Initializes a new instance of Dialog with the specified, parent, title and modality, that is resizable.
Dialog(Dialog parent, String title, boolean modal, GraphicsConfiguration gc)
          Initializes a new instance of Dialog with the specified, parent, title, modality and GraphicsConfiguration, that is resizable.
Dialog(Frame parent)
          Initializes a new instance of Dialog with the specified parent, that is resizable and not modal, and which has no title.
Dialog(Frame parent, boolean modal)
          Initializes a new instance of Dialog with the specified parent and modality, that is resizable and which has no title.
Dialog(Frame parent, String title)
          Initializes a new instance of Dialog with the specified parent, that is resizable and not modal, and which has the specified title.
Dialog(Frame parent, String title, boolean modal)
          Initializes a new instance of Dialog with the specified, parent, title, and modality, that is resizable.
Dialog(Frame parent, String title, boolean modal, GraphicsConfiguration gc)
          Initializes a new instance of Dialog with the specified, parent, title, modality and GraphicsConfiguration, that is resizable.
 
Method Summary
 void addNotify()
          Creates this object's native peer.
 void dispose()
          Disposes the Dialog and then causes show() to return if it is currently blocked.
 AccessibleContext getAccessibleContext()
          Gets the AccessibleContext associated with this Dialog.
 String getTitle()
          Returns the title of this dialog box.
 void hide()
          Deprecated. Use Component.setVisible(boolean) instead.
 boolean isModal()
          Tests whether or not this dialog box is modal.
 boolean isResizable()
          Tests whether or not this dialog box is resizable.
 boolean isUndecorated()
          Returns whether this frame is undecorated or not.
protected  String paramString()
          Returns a debugging string for this component.
 void setModal(boolean modal)
          Changes the modality of this dialog box.
 void setResizable(boolean resizable)
          Changes the resizability of this dialog box.
 void setTitle(String title)
          Sets the title of this dialog box to the specified string.
 void setUndecorated(boolean undecorated)
          Disables or enables decorations for this frame.
 void show()
          Deprecated. Use Component.setVisible(boolean) instead.
 
Methods inherited from class java.awt.Window
addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getGraphicsConfiguration, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Dialog

public Dialog(Frame parent)
Initializes a new instance of Dialog with the specified parent, that is resizable and not modal, and which has no title.

Parameters:
parent - The parent frame of this dialog box.
Throws:
IllegalArgumentException - If the owner's GraphicsConfiguration is not from a screen device, or if owner is null. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.

Dialog

public Dialog(Frame parent,
              boolean modal)
Initializes a new instance of Dialog with the specified parent and modality, that is resizable and which has no title.

Parameters:
parent - The parent frame of this dialog box.
modal - true if this dialog box is modal, false otherwise.
Throws:
IllegalArgumentException - If the owner's GraphicsConfiguration is not from a screen device, or if owner is null. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.

Dialog

public Dialog(Frame parent,
              String title)
Initializes a new instance of Dialog with the specified parent, that is resizable and not modal, and which has the specified title.

Parameters:
parent - The parent frame of this dialog box.
title - The title string for this dialog box.
Throws:
IllegalArgumentException - If the owner's GraphicsConfiguration is not from a screen device, or if owner is null. This exceptionnis always thrown when GraphicsEnvironment.isHeadless() returns true.

Dialog

public Dialog(Frame parent,
              String title,
              boolean modal)
Initializes a new instance of Dialog with the specified, parent, title, and modality, that is resizable.

Parameters:
parent - The parent frame of this dialog box.
title - The title string for this dialog box.
modal - true if this dialog box is modal, false otherwise.
Throws:
IllegalArgumentException - If owner is null or GraphicsEnvironment.isHeadless() returns true.

Dialog

public Dialog(Frame parent,
              String title,
              boolean modal,
              GraphicsConfiguration gc)
Initializes a new instance of Dialog with the specified, parent, title, modality and GraphicsConfiguration, that is resizable.

Parameters:
parent - The parent frame of this dialog box.
title - The title string for this dialog box.
modal - true if this dialog box is modal, false otherwise.
gc - The GraphicsConfiguration object to use. If null the GraphicsConfiguration of the target frame is used.
Throws:
IllegalArgumentException - If owner is null, the GraphicsConfiguration is not a screen device or GraphicsEnvironment.isHeadless() returns true.
Since:
1.4

Dialog

public Dialog(Dialog owner)
Initializes a new instance of Dialog with the specified, parent, that is resizable.

Parameters:
owner - The parent frame of this dialog box.
Throws:
IllegalArgumentException - If parent is null. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.
Since:
1.2

Dialog

public Dialog(Dialog owner,
              String title)
Initializes a new instance of Dialog with the specified, parent and title, that is resizable.

Parameters:
owner - The parent frame of this dialog box.
title - The title string for this dialog box.
Throws:
IllegalArgumentException - If parent is null. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.
Since:
1.2

Dialog

public Dialog(Dialog owner,
              String title,
              boolean modal)
Initializes a new instance of Dialog with the specified, parent, title and modality, that is resizable.

Parameters:
owner - The parent frame of this dialog box.
title - The title string for this dialog box.
modal - true if this dialog box is modal, false otherwise.
Throws:
IllegalArgumentException - If parent is null. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true.
Since:
1.2

Dialog

public Dialog(Dialog parent,
              String title,
              boolean modal,
              GraphicsConfiguration gc)
Initializes a new instance of Dialog with the specified, parent, title, modality and GraphicsConfiguration, that is resizable.

Parameters:
parent - The parent frame of this dialog box.
title - The title string for this dialog box.
modal - true if this dialog box is modal, false otherwise.
gc - The GraphicsConfiguration object to use. If null the GraphicsConfiguration of the target frame is used.
Throws:
IllegalArgumentException - If parent is null, the GraphicsConfiguration is not a screen device or GraphicsEnvironment.isHeadless() returns true.
Since:
1.4
Method Detail

getTitle

public String getTitle()
Returns the title of this dialog box.

Returns:
The title of this dialog box.

setTitle

public void setTitle(String title)
Sets the title of this dialog box to the specified string.

Parameters:
title - the new title. If null an empty title will be set.

isModal

public boolean isModal()
Tests whether or not this dialog box is modal.

Returns:
true if this dialog box is modal, false otherwise.

setModal

public void setModal(boolean modal)
Changes the modality of this dialog box. This can only be done before the peer is created.

Parameters:
modal - true to make this dialog box modal, false to make it non-modal.

isResizable

public boolean isResizable()
Tests whether or not this dialog box is resizable.

Returns:
true if this dialog is resizable, false otherwise.

setResizable

public void setResizable(boolean resizable)
Changes the resizability of this dialog box.

Parameters:
resizable - true to make this dialog resizable, false to make it non-resizable.

addNotify

public void addNotify()
Creates this object's native peer.

Overrides:
addNotify in class Window
See Also:
Component.isDisplayable(), Component.removeNotify()

show

public void show()
Deprecated. Use Component.setVisible(boolean) instead.

Makes this dialog visible and brings it to the front. If the dialog is modal and is not already visible, this call will not return until the dialog is hidden by someone calling hide or dispose. If this is the event dispatching thread we must ensure that another event thread runs while the one which invoked this method is blocked.

Overrides:
show in class Window

hide

public void hide()
Deprecated. Use Component.setVisible(boolean) instead.

Hides the Dialog and then causes show() to return if it is currently blocked.

Overrides:
hide in class Window

dispose

public void dispose()
Disposes the Dialog and then causes show() to return if it is currently blocked.

Overrides:
dispose in class Window

paramString

protected String paramString()
Returns a debugging string for this component.

Overrides:
paramString in class Container
Returns:
A debugging string for this component.

isUndecorated

public boolean isUndecorated()
Returns whether this frame is undecorated or not.

Returns:
true if this dialog is undecorated, false otherwise.
Since:
1.4

setUndecorated

public void setUndecorated(boolean undecorated)
Disables or enables decorations for this frame. This method can only be called while the frame is not displayable.

Parameters:
undecorated - true to disable dialog decorations, false otherwise.
Throws:
IllegalComponentStateException - If this frame is displayable.
Since:
1.4

getAccessibleContext

public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this Dialog. The context is created, if necessary.

Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in class Window
Returns:
the associated context