API java : Dialog

java.awt
Class Dialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

FileDialog, JDialog

public class Dialog
extends Window

A Dialog is a top-level window with a title and a border that is typically used to take some form of input from the user. The size of the dialog includes any area designated for the border. The dimensions of the border area can be obtained using the getInsets method, however, since these dimensions are platform-dependent, a valid insets value cannot be obtained until the dialog is made displayable by either calling pack or show. Since the border area is included in the overall size of the dialog, the border effectively obscures a portion of the dialog, constraining the area available for rendering and/or displaying subcomponents to the rectangle which has an upper-left corner location of (insets.left, insets.top), and has a size of width - (insets.left + insets.right) by height - (insets.top + insets.bottom).

The default layout for a dialog is BorderLayout.

A dialog may have its native decorations (i.e. Frame & Titlebar) turned off with setUndecorated. This can only be done while the dialog is not displayable.

A dialog must have either a frame or another dialog defined as its owner when it's constructed. When the owner window of a visible dialog is minimized, the dialog will automatically be hidden from the user. When the owner window is subsequently restored, the dialog is made visible to the user again.

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

A dialog can be either modeless (the default) or modal. A modal dialog is one which blocks input to all other toplevel windows in the application, except for any windows created with the dialog as their owner.

Dialogs are capable of generating the following WindowEvents: WindowOpened, WindowClosing, WindowClosed, WindowActivated, WindowDeactivated, WindowGainedFocus, WindowLostFocus.

Since:

JDK1.0

See Also:

WindowEvent, Window.addWindowListener(java.awt.event.WindowListener), Serialized Form

Nested Class Summary
protected  class	Dialog.AccessibleAWTDialog           This class implements accessibility support for the Dialog class.

 

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)           Constructs an initially invisible, non-modal Dialog with an empty title and the specified owner dialog.
Dialog(Dialog owner, String title)           Constructs an initially invisible, non-modal Dialog with the specified owner dialog and title.
Dialog(Dialog owner, String title, boolean modal)           Constructs an initially invisible Dialog with the specified owner dialog, title, and modality.
Dialog(Dialog owner, String title, boolean modal, GraphicsConfiguration gc)           Constructs an initially invisible Dialog with the specified owner dialog, title, modality, and GraphicsConfiguration.
Dialog(Frame owner)           Constructs an initially invisible, non-modal Dialog with an empty title and the specified owner frame.
Dialog(Frame owner, boolean modal)           Constructs an initially invisible Dialog with an empty title, the specified owner frame and modality.
Dialog(Frame owner, String title)           Constructs an initially invisible, non-modal Dialog with the specified owner frame and title.
Dialog(Frame owner, String title, boolean modal)           Constructs an initially invisible Dialog with the specified owner frame, title, and modality.
Dialog(Frame owner, String title, boolean modal, GraphicsConfiguration gc)           Constructs an initially invisible Dialog with the specified owner frame, title, modality, and GraphicsConfiguration.

 

Method Summary
void	addNotify()           Makes this Dialog displayable by connecting it to a native screen resource.
AccessibleContext	getAccessibleContext()           Gets the AccessibleContext associated with this Dialog.
String	getTitle()           Gets the title of the dialog.
void	hide()           Deprecated. As of JDK version 1.5, replaced by Component.setVisible(boolean).
boolean	isModal()           Indicates whether the dialog is modal.
boolean	isResizable()           Indicates whether this dialog is resizable by the user.
boolean	isUndecorated()           Indicates whether this dialog is undecorated.
protected  String	paramString()           Returns a string representing the state of this dialog.
void	setModal(boolean b)           Specifies whether this dialog should be modal.
void	setResizable(boolean resizable)           Sets whether this dialog is resizable by the user.
void	setTitle(String title)           Sets the title of the Dialog.
void	setUndecorated(boolean undecorated)           Disables or enables decorations for this dialog.
void	show()           Deprecated. As of JDK version 1.5, replaced by Component.setVisible(boolean).

 

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, 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, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, toFront

 

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, 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, transferFocusBackward, 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, 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, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

 

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

Dialog

public Dialog(Frame owner)

Constructs an initially invisible, non-modal Dialog with an empty title and the specified owner frame.

Parameters:

owner - the owner of the dialog

Throws:

IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device

IllegalArgumentException - if owner is null; this exception is always thrown when GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless(), Component.setSize(int, int), Component.setVisible(boolean)

Dialog

public Dialog(Frame owner,
              boolean modal)

Constructs an initially invisible Dialog with an empty title, the specified owner frame and modality.

Parameters:

owner - the owner of the dialog

modal - if true, dialog blocks input to other app windows when shown

Throws:

IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device

IllegalArgumentException - if owner is null; this exception is always thrown when GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless()

Dialog

public Dialog(Frame owner,
              String title)

Constructs an initially invisible, non-modal Dialog with the specified owner frame and title.

Parameters:

owner - the owner of the dialog

title - the title of the dialog; a null value will be accepted without causing a NullPointerException to be thrown

Throws:

IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device

IllegalArgumentException - if owner is null; this exception is always thrown when GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless(), Component.setSize(int, int), Component.setVisible(boolean)

Dialog

public Dialog(Frame owner,
              String title,
              boolean modal)

Constructs an initially invisible Dialog with the specified owner frame, title, and modality.

Parameters:

owner - the owner of the dialog

title - the title of the dialog; a null value will be accepted without causing a NullPointerException to be thrown

modal - if true, dialog blocks input to other app windows when shown

Throws:

IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device

IllegalArgumentException - if owner is null. This exception is always thrown when GraphicsEnvironment.isHeadless returns true

See Also:

GraphicsEnvironment.isHeadless(), Component.setSize(int, int), Component.setVisible(boolean)

Dialog

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

Constructs an initially invisible Dialog with the specified owner frame, title, modality, and GraphicsConfiguration.

Parameters:

owner - the owner of the dialog

title - the title of the dialog. A null value will be accepted without causing a NullPointerException to be thrown.

modal - if true, dialog blocks input to other app windows when shown

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

Throws:

IllegalArgumentException - if owner is null. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true

Since:

1.4

See Also:

GraphicsEnvironment.isHeadless(), Component.setSize(int, int), Component.setVisible(boolean)

Dialog

public Dialog(Dialog owner)

Constructs an initially invisible, non-modal Dialog with an empty title and the specified owner dialog.

Parameters:

owner - the owner of the dialog

Throws:

IllegalArgumentException - if owner is null. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true

Since:

1.2

See Also:

GraphicsEnvironment.isHeadless()

Dialog

public Dialog(Dialog owner,
              String title)

Constructs an initially invisible, non-modal Dialog with the specified owner dialog and title.

Parameters:

owner - the owner of the dialog

title - the title of the dialog. A null value will be accepted without causing a NullPointerException to be thrown.

Throws:

IllegalArgumentException - if owner is null. This exception is always thrown when GraphicsEnvironment.isHeadless() returns true

Since:

1.2

See Also:

GraphicsEnvironment.isHeadless()

Dialog

public Dialog(Dialog owner,
              String title,
              boolean modal)

Constructs an initially invisible Dialog with the specified owner dialog, title, and modality.

Parameters:

owner - the owner of the dialog

title - the title of the dialog; a null value will be accepted without causing a NullPointerException to be thrown

modal - if true, dialog blocks input to other app windows when shown

Throws:

IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device

IllegalArgumentException - if owner is null; this exception is always thrown when GraphicsEnvironment.isHeadless returns true

Since:

1.2

See Also:

GraphicsEnvironment.isHeadless()

Dialog

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

Constructs an initially invisible Dialog with the specified owner dialog, title, modality, and GraphicsConfiguration.

Parameters:

owner - the owner of the dialog

title - the title of the dialog; a null value will be accepted without causing a NullPointerException to be thrown

modal - if true, dialog blocks input to other app windows when shown

gc - the GraphicsConfiguration of the target screen device; if gc is null, the same GraphicsConfiguration as the owning Dialog is used

Throws:

IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device

IllegalArgumentException - if owner is null; this exception is always thrown when GraphicsEnvironment.isHeadless returns true

Since:

1.4

See Also:

GraphicsEnvironment.isHeadless(), Component.setSize(int, int), Component.setVisible(boolean)

addNotify

public void addNotify()

Makes this Dialog displayable by connecting it to a native screen resource. Making a dialog displayable will cause any of its children to be made displayable. This method is called internally by the toolkit and should not be called directly by programs.

Overrides:

addNotify in class Window

See Also:

Component.isDisplayable(), Container.removeNotify()

isModal

public boolean isModal()

Indicates whether the dialog is modal. When a modal Dialog is made visible, user input will be blocked to the other windows in the application, except for any windows created with this dialog as their owner.

Returns:

true if this dialog window is modal; false otherwise.

See Also:

setModal(boolean)

setModal

public void setModal(boolean b)

Specifies whether this dialog should be modal.

Since:

JDK1.1

See Also:

isModal()

getTitle

public String getTitle()

Gets the title of the dialog. The title is displayed in the dialog's border.

Returns:

the title of this dialog window. The title may be null.

See Also:

setTitle(java.lang.String)

setTitle

public void setTitle(String title)

Sets the title of the Dialog.

Parameters:

title - the title displayed in the dialog's border; a null value results in an empty title

See Also:

getTitle()

show

@Deprecated
public void show()

Deprecated. As of JDK version 1.5, replaced by Component.setVisible(boolean).

Overrides:

show in class Window

hide

@Deprecated
public void hide()

Deprecated. As of JDK version 1.5, replaced by Component.setVisible(boolean).

Overrides:

hide in class Window

isResizable

public boolean isResizable()

Indicates whether this dialog is resizable by the user.

Returns:

true if the user can resize the dialog; false otherwise.

See Also:

setResizable(boolean)

setResizable

public void setResizable(boolean resizable)

Sets whether this dialog is resizable by the user.

Parameters:

resizable - true if the user can resize this dialog; false otherwise.

See Also:

isResizable()

setUndecorated

public void setUndecorated(boolean undecorated)

Disables or enables decorations for this dialog. This method can only be called while the dialog is not displayable.

Parameters:

undecorated - true if no dialog decorations are to be enabled; false if dialog decorations are to be enabled.

Throws:

IllegalComponentStateException - if the dialog is displayable.

Since:

1.4

See Also:

isUndecorated(), Component.isDisplayable()

isUndecorated

public boolean isUndecorated()

Indicates whether this dialog is undecorated. By default, all dialogs are initially decorated.

Returns:

true if dialog is undecorated; false otherwise.

Since:

1.4

See Also:

setUndecorated(boolean)

paramString

protected String paramString()

Returns a string representing the state of this dialog. 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 Container

Returns:

the parameter string of this dialog window.

getAccessibleContext

public AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this Dialog. For dialogs, the AccessibleContext takes the form of an AccessibleAWTDialog. A new AccessibleAWTDialog instance is created if necessary.

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class Window

Returns:

an AccessibleAWTDialog that serves as the AccessibleContext of this Dialog