Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.awt

Class Dialog

Implemented Interfaces:
Accessible, ImageObserver, MenuContainer, Serializable
Known Direct 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.
class
Dialog.ModalExclusionType
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

addNotify, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, extends EventListener> T[] getListeners, getAccessibleContext, getBufferStrategy, getFocusCycleRootAncestor, getFocusOwner, getFocusableWindowState, getGraphicsConfiguration, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusCycleRoot, isFocusableWindow, isFocused, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setCursor, setFocusCycleRoot, setFocusableWindowState, setLocationRelativeTo, toBack, toFront, void hide, void show

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, extends EventListener> T[] getListeners, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponentZOrder, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, 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, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFocusable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFocusable, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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

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

Method Details

addNotify

public void addNotify()
Creates this object's native peer.
Overrides:
addNotify in interface Window

dispose

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

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 interface Window
Returns:
the associated context

getTitle

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

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 interface Component

isModal

public boolean isModal()
Tests whether or not this dialog box is modal.
Returns:
true if this dialog box is modal, false otherwise.

isResizable

public boolean isResizable()
Tests whether or not this dialog box is resizable.
Returns:
true if this dialog is resizable, false otherwise.

isUndecorated

public boolean isUndecorated()
Returns whether this frame is undecorated or not.
Returns:
true if this dialog is undecorated, false otherwise.
Since:
1.4

paramString

protected String paramString()
Returns a debugging string for this component.
Overrides:
paramString in interface Container
Returns:
A debugging string for this component.

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.

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.

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.

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

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 interface Component
Dialog.java -- An AWT dialog box Copyright (C) 1999, 2000, 2001, 2002, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About