Dialog (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.awt
class Dialog

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

All Implemented Interfaces:: MenuContainer, ImageObserver, 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 {@link Component#isDisplayable() displayable}.

A dialog may have another window 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 {@link java.awt.Frame} for more information.

A dialog can be either modeless (the default) or modal. A modal dialog is one which blocks input to some other top-level windows in the application, except for any windows created with the dialog as their owner. See AWT Modality specification for details.

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

Nested Class Summary
`protected class`	`Dialog.AccessibleAWTDialog` This class implements accessibility support for the `Dialog` class.
`static enum`	`Dialog.ModalExclusionType` Any top-level window can be marked not to be blocked by modal dialogs.
`static enum`	`Dialog.ModalityType` Modal dialogs block all input to some top-level windows.

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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy`

Field Summary
`static Dialog.ModalityType`	`DEFAULT_MODALITY_TYPE` Default modality type for modal dialogs.

Fields inherited from class java.awt.Component
`BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT`

Constructor Summary
`Dialog(Dialog owner)` Constructs an initially invisible, modeless `Dialog` with the specified owner `Dialog` and an empty title.
`Dialog(Dialog owner, String title)` Constructs an initially invisible, modeless `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, modeless `Dialog` with the specified owner `Frame` and an empty title.
`Dialog(Frame owner, boolean modal)` Constructs an initially invisible `Dialog` with the specified owner `Frame` and modality and an empty title.
`Dialog(Frame owner, String title)` Constructs an initially invisible, modeless `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`.
`Dialog(Window owner)` Constructs an initially invisible, modeless `Dialog` with the specified owner `Window` and an empty title.
`Dialog(Window owner, Dialog.ModalityType modalityType)` Constructs an initially invisible `Dialog` with the specified owner `Window` and modality and an empty title.
`Dialog(Window owner, String title)` Constructs an initially invisible, modeless `Dialog` with the specified owner `Window` and title.
`Dialog(Window owner, String title, Dialog.ModalityType modalityType)` Constructs an initially invisible `Dialog` with the specified owner `Window`, title and modality.
`Dialog(Window owner, String title, Dialog.ModalityType modalityType, GraphicsConfiguration gc)` Constructs an initially invisible `Dialog` with the specified owner `Window`, 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.
`Dialog.ModalityType`	`getModalityType()` Returns the modality type of this dialog.
`String`	`getTitle()` Gets the title of the dialog.
`void`	`hide()` Hides the Dialog and then causes to return if it is currently blocked.
`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 modal)` Specifies whether this dialog should be modal.
`void`	`setModalityType(Dialog.ModalityType type)` Sets the modality type for this dialog.
`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`	`setVisible(boolean b)` Shows or hides this depending on the value of parameter .
`void`	`show()` Makes the visible.
`void`	`toBack()` If this Window is visible, sends this Window to the back and may cause it to lose focus or activation if it is the focused or active Window.

Methods inherited from class java.awt.Window
addNotify, addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getAccessibleContext, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Window


addNotify, addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getAccessibleContext, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, 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, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Container


add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, 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, transferFocusBackward, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, 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, getListeners, 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, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, 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, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, 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.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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, 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, getListeners, 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, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, 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, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, 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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

DEFAULT_MODALITY_TYPE

public static final Dialog.ModalityType DEFAULT_MODALITY_TYPE

Default modality type for modal dialogs. The default modality type is APPLICATION_MODAL. Calling the oldstyle setModal(true) is equal to setModalityType(DEFAULT_MODALITY_TYPE).

Constructor Detail

Dialog

public Dialog(Dialog owner)

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

Parameters:: owner - the owner of the dialog or null if this dialog has no owner

Dialog

public Dialog(Dialog owner,
              String title)

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

Parameters:: owner - the owner of the dialog or null if this has no owner; title - the title of the dialog or null if this dialog has no title

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 or null if this dialog has no owner; title - the title of the dialog or null if this dialog has no title; modal - specifes whether dialog blocks user input to other top-level windows when shown. If false, the dialog is MODELESS; if true, the modality type property is set to DEFAULT_MODALITY_TYPE

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 or null if this dialog has no owner; title - the title of the dialog or null if this dialog has no title; modal - specifes whether dialog blocks user input to other top-level windows when shown. If false, the dialog is MODELESS; if true, the modality type property is set to DEFAULT_MODALITY_TYPE; gc - the GraphicsConfiguration of the target screen device; if null, the default system GraphicsConfiguration is assumed

Dialog

public Dialog(Frame owner)

Constructs an initially invisible, modeless Dialog with the specified owner Frame and an empty title.

Parameters:: owner - the owner of the dialog or null if this dialog has no owner

Dialog

public Dialog(Frame owner,
              boolean modal)

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

Parameters:: owner - the owner of the dialog or null if this dialog has no owner; modal - specifes whether dialog blocks user input to other top-level windows when shown. If false, the dialog is MODELESS; if true, the modality type property is set to DEFAULT_MODALITY_TYPE

Dialog

public Dialog(Frame owner,
              String title)

Constructs an initially invisible, modeless Dialog with the specified owner Frame and title.

Parameters:: owner - the owner of the dialog or null if this dialog has no owner; title - the title of the dialog or null if this dialog has no title

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 or null if this dialog has no owner; title - the title of the dialog or null if this dialog has no title; modal - specifes whether dialog blocks user input to other top-level windows when shown. If false, the dialog is MODELESS; if true, the modality type property is set to DEFAULT_MODALITY_TYPE

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 or null if this dialog has no owner; title - the title of the dialog or null if this dialog has no title; modal - specifes whether dialog blocks user input to other top-level windows when shown. If false, the dialog is MODELESS; if true, the modality type property is set to DEFAULT_MODALITY_TYPE; gc - the GraphicsConfiguration of the target screen device; if null, the default system GraphicsConfiguration is assumed

Dialog

public Dialog(Window owner)

Constructs an initially invisible, modeless Dialog with the specified owner Window and an empty title.

Parameters:: owner - the owner of the dialog. The owner must be an instance of {@link java.awt.Dialog Dialog}, {@link java.awt.Frame Frame}, any of their descendents or null

Dialog

public Dialog(Window owner,
              Dialog.ModalityType modalityType)

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

Parameters:: owner - the owner of the dialog. The owner must be an instance of {@link java.awt.Dialog Dialog}, {@link java.awt.Frame Frame}, any of their descendents or null; modalityType - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS

Dialog

public Dialog(Window owner,
              String title)

Constructs an initially invisible, modeless Dialog with the specified owner Window and title.

Parameters:: owner - the owner of the dialog. The owner must be an instance of {@link java.awt.Dialog Dialog}, {@link java.awt.Frame Frame}, any of their descendents or null; title - the title of the dialog or null if this dialog has no title

Dialog

public Dialog(Window owner,
              String title,
              Dialog.ModalityType modalityType)

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

Parameters:: owner - the owner of the dialog. The owner must be an instance of {@link java.awt.Dialog Dialog}, {@link java.awt.Frame Frame}, any of their descendents or null; title - the title of the dialog or null if this dialog has no title; modalityType - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS

Dialog

public Dialog(Window owner,
              String title,
              Dialog.ModalityType modalityType,
              GraphicsConfiguration gc)

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

Parameters:: owner - the owner of the dialog. The owner must be an instance of {@link java.awt.Dialog Dialog}, {@link java.awt.Frame Frame}, any of their descendents or null; title - the title of the dialog or null if this dialog has no title; modalityType - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS; gc - the GraphicsConfiguration of the target screen device; if null, the default system GraphicsConfiguration is assumed

Method Detail

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

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.

Overrides:: getAccessibleContext in class Window
Returns:: an AccessibleAWTDialog that serves as the AccessibleContext of this Dialog

getModalityType

public Dialog.ModalityType getModalityType()

Returns the modality type of this dialog.

Returns:: modality type of this dialog

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.

hide

public void hide()

Hides the Dialog and then causes {@code show} to return if it is currently blocked.

Overrides:: hide in class Window

isModal

public boolean isModal()

Indicates whether the dialog is modal.

This method is obsolete and is kept for backwards compatiblity only. Use {@link #getModalityType getModalityType()} instead.

Returns:: true if this dialog window is modal; false otherwise

isResizable

public boolean isResizable()

Indicates whether this dialog is resizable by the user. By default, all dialogs are initially resizable.

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

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.

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.

setModal

public void setModal(boolean modal)

Specifies whether this dialog should be modal.

This method is obsolete and is kept for backwards compatibility only. Use {@link #setModalityType setModalityType()} instead.

Note: changing modality of the visible dialog may have no effect until it is hidden and then shown again.

Parameters:: modal - specifies whether dialog blocks input to other windows when shown; calling to setModal(true) is equivalent to setModalityType(Dialog.DEFAULT_MODALITY_TYPE), and calling to setModal(false) is equvivalent to setModalityType(Dialog.ModalityType.MODELESS)

setModalityType

public void setModalityType(Dialog.ModalityType type)

Sets the modality type for this dialog. See {@link java.awt.Dialog.ModalityType ModalityType} for possible modality types.

If the given modality type is not supported, MODELESS is used. You may want to call getModalityType() after calling this method to ensure that the modality type has been set.

Note: changing modality of the visible dialog may have no effect until it is hidden and then shown again.

Parameters:: type - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS

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.

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

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.

setVisible

public void setVisible(boolean b)

Shows or hides this {@code Dialog} depending on the value of parameter {@code b}.

Overrides:

setVisible in class Window

Parameters:

b - if {@code true}, makes the {@code Dialog} visible, otherwise hides the {@code Dialog}. If the dialog and/or its owner are not yet displayable, both are made displayable. The dialog will be validated prior to being made visible. If {@code false}, hides the {@code Dialog} and then causes {@code setVisible(true)} to return if it is currently blocked.

Notes for modal dialogs.

{@code setVisible(true)}: If the dialog is not already visible, this call will not return until the dialog is hidden by calling {@code setVisible(false)} or {@code dispose}.
{@code setVisible(false)}: Hides the dialog and then returns on {@code setVisible(true)} if it is currently blocked.
It is OK to call this method from the event dispatching thread because the toolkit ensures that other events are not blocked while this method is blocked.

show

public void show()

Makes the {@code Dialog} visible. If the dialog and/or its owner are not yet displayable, both are made displayable. The dialog will be validated prior to being made visible. If the dialog is already visible, this will bring the dialog to the front.

If the dialog is modal and is not already visible, this call will not return until the dialog is hidden by calling hide or dispose. It is permissible to show modal dialogs from the event dispatching thread because the toolkit will ensure that another event pump runs while the one which invoked this method is blocked.

Overrides:: show in class Window

toBack

public void toBack()

{@inheritDoc}

If this dialog is modal and blocks some windows, then all of them are also sent to the back to keep them below the blocking dialog.

Overrides:: toBack in class Window

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:

The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.

java.awtclass Dialog

DEFAULT_MODALITY_TYPE

Dialog

Dialog

Dialog

Dialog

Dialog

Dialog

Dialog

Dialog

Dialog

Dialog

Dialog

Dialog

Dialog

Dialog

addNotify

getAccessibleContext

getModalityType

getTitle

hide

isModal

isResizable

isUndecorated

paramString

setModal

setModalityType

setResizable

setTitle

setUndecorated

setVisible

show

toBack

java.awt
class Dialog