ImageObserver, MenuContainer, Serializable, Accessible
FileDialog, JDialog
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 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 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 Classes
protected class
This class implements accessibility support for the Dialog class.
static enum
Any top-level window can be marked not to be blocked by modal dialogs.
static enum
Modal dialogs block all input to some top-level windows.
Fields
Default modality type for modal dialogs.
Constructors
Constructs an initially invisible, modeless Dialog with the specified owner Dialog and an empty title.
Constructs an initially invisible, modeless Dialog with the specified owner Dialog and title.
Constructs an initially invisible Dialog with the specified owner Dialog, title, and modality.
Constructs an initially invisible Dialog with the specified owner Dialog, title, modality and GraphicsConfiguration.
Constructs an initially invisible, modeless Dialog with the specified owner Frame and an empty title.
Constructs an initially invisible Dialog with the specified owner Frame and modality and an empty title.
Constructs an initially invisible, modeless Dialog with the specified owner Frame and title.
Constructs an initially invisible Dialog with the specified owner Frame, title and modality.
Constructs an initially invisible Dialog with the specified owner Frame, title, modality, and GraphicsConfiguration.
Constructs an initially invisible, modeless Dialog with the specified owner Window and an empty title.
Constructs an initially invisible Dialog with the specified owner Window and modality and an empty title.
Constructs an initially invisible, modeless Dialog with the specified owner Window and title.
Constructs an initially invisible Dialog with the specified owner Window, title and modality.
Constructs an initially invisible Dialog with the specified owner Window, title, modality and GraphicsConfiguration.
void
Makes this Dialog displayable by connecting it to a native screen resource.
Gets the AccessibleContext associated with this Dialog.
Returns the modality type of this dialog.
Gets the title of the dialog.
void
boolean
Indicates whether the dialog is modal.
boolean
Indicates whether this dialog is resizable by the user.
boolean
Indicates whether this dialog is undecorated.
Returns a string representing the state of this dialog.
void
Specifies whether this dialog should be modal.
void
Sets the modality type for this dialog.
void
Sets whether this dialog is resizable by the user.
void
Sets the title of the Dialog.
void
Disables or enables decorations for this dialog.
void
Shows or hides this Dialog depending on the value of parameter b.
void
void
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 declared in class java.awt.WindowaddPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBackground, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setOpacity, setShape, setSize, setSize, setType, toFront Methods declared in class java.awt.Containeradd, 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, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate, validateTree Methods declared in class java.awt.Componentaction, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, 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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycleDefault modality type for modal dialogs. The default modality type is APPLICATION_MODAL. Calling the oldstyle setModal(true) is equal to setModalityType(DEFAULT_MODALITY_TYPE).
Constructs an initially invisible, modeless Dialog with the specified owner Frame and an empty title.
owner - the owner of the dialog or null if this dialog has no owner
IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
Constructs an initially invisible Dialog with the specified owner Frame and modality and an empty title.
owner - the owner of the dialog or null if this dialog has no owner
modal - specifies 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
IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
Constructs an initially invisible, modeless Dialog with the specified owner Frame and title.
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
IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
Constructs an initially invisible Dialog with the specified owner Frame, title and modality.
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 - specifies 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
IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
Constructs an initially invisible Dialog with the specified owner Frame, title, modality, and GraphicsConfiguration.
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 - specifies 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
IllegalArgumentException - if gc is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
Constructs an initially invisible, modeless Dialog with the specified owner Dialog and an empty title.
owner - the owner of the dialog or null if this dialog has no owner
IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
Constructs an initially invisible, modeless Dialog with the specified owner Dialog and title.
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
IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
Constructs an initially invisible Dialog with the specified owner Dialog, title, and modality.
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 - specifies 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
IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
Constructs an initially invisible Dialog with the specified owner Dialog, title, modality and GraphicsConfiguration.
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 - specifies 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
IllegalArgumentException - if gc is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
Constructs an initially invisible, modeless Dialog with the specified owner Window and an empty title.
owner - the owner of the dialog. The owner must be an instance of Dialog, Frame, any of their descendants or null
IllegalArgumentException - if the owner is not an instance of Dialog or Frame
IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
Constructs an initially invisible, modeless Dialog with the specified owner Window and title.
owner - the owner of the dialog. The owner must be an instance of Dialog, Frame, any of their descendants or null
title - the title of the dialog or null if this dialog has no title
IllegalArgumentException - if the owner is not an instance of Dialog or Frame
IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
Constructs an initially invisible Dialog with the specified owner Window and modality and an empty title.
owner - the owner of the dialog. The owner must be an instance of Dialog, Frame, any of their descendants or null
modalityType - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS
IllegalArgumentException - if the owner is not an instance of Dialog or Frame
IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
SecurityException - if the calling thread does not have permission to create modal dialogs with the given modalityType
Constructs an initially invisible Dialog with the specified owner Window, title and modality.
owner - the owner of the dialog. The owner must be an instance of Dialog, Frame, any of their descendants 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
IllegalArgumentException - if the owner is not an instance of Dialog or Frame
IllegalArgumentException - if the owner's GraphicsConfiguration is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
SecurityException - if the calling thread does not have permission to create modal dialogs with the given modalityType
Constructs an initially invisible Dialog with the specified owner Window, title, modality and GraphicsConfiguration.
owner - the owner of the dialog. The owner must be an instance of Dialog, Frame, any of their descendants 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
IllegalArgumentException - if the owner is not an instance of Dialog or Frame
IllegalArgumentException - if gc is not from a screen device
HeadlessException - when GraphicsEnvironment.isHeadless() returns true
SecurityException - if the calling thread does not have permission to create modal dialogs with the given modalityType
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.
public boolean isModal()
This method is obsolete and is kept for backwards compatibility only. Use getModalityType() instead.
true if this dialog window is modal; false otherwise
public void setModal(boolean modal)
Specifies whether this dialog should be modal.
This method is obsolete and is kept for backwards compatibility only. Use setModalityType() instead.
Note: changing modality of the visible dialog may have no effect until it is hidden and then shown again.
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 equivalent to setModalityType(Dialog.ModalityType.MODELESS)
Returns the modality type of this dialog.
Sets the modality type for this dialog. See
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.
type - specifies whether dialog blocks input to other windows when shown. null value and unsupported modality types are equivalent to MODELESS
SecurityException - if the calling thread does not have permission to create modal dialogs with the given modalityType
Gets the title of the dialog. The title is displayed in the dialog's border.
null.
Sets the title of the Dialog.
title - the title displayed in the dialog's border; a null value results in an empty title
public void setVisible(boolean b)
Shows or hides this Dialog depending on the value of parameter b.
setVisible in class Window
b - if true, makes the Dialog visible, otherwise hides the 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 false, hides the Dialog and then causes setVisible(true) to return if it is currently blocked.
Notes for modal dialogs.
setVisible(true): If the dialog is not already visible, this call will not return until the dialog is hidden by calling setVisible(false) or dispose.setVisible(false): Hides the dialog and then returns on setVisible(true) if it is currently blocked.Makes the
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.
Hides the Dialog and then causes show to return if it is currently blocked.
public 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.
Places this Window at the bottom of the stacking order and shows it behind any other Windows in this VM. No action will take place is this Window is not visible. Some platforms do not allow Windows which are owned by other Windows to appear below their owners. Every attempt will be made to move this Window as low as possible in the stacking order; however, developers should not assume that this method will move this Window below all other windows in every situation.
Because of variations in native windowing systems, no guarantees about changes to the focused and active Windows can be made. Developers must never assume that this Window is no longer the focused or active Window until this Window receives a WINDOW_LOST_FOCUS or WINDOW_DEACTIVATED event. On platforms where the top-most window is the focused window, this method will probably cause this Window to lose focus. In that case, the next highest, focusable Window in this VM will receive focus. On platforms where the stacking order does not typically affect the focused window, this method will probably leave the focused and active Windows unchanged.
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.
public boolean isResizable()
Indicates whether this dialog is resizable by the user. By default, all dialogs are initially resizable.
true if the user can resize the dialog; false otherwise.
public void setResizable(boolean resizable)
Sets whether this dialog is resizable by the user.
resizable - true if the user can resize this dialog; false otherwise.
public void setUndecorated(boolean undecorated)
This method can only be called while the dialog is not displayable. To make this dialog decorated, it must be opaque and have the default shape, otherwise the IllegalComponentStateException will be thrown. Refer to Window.setShape(java.awt.Shape), Window.setOpacity(float) and Window.setBackground(java.awt.Color) for details
undecorated - true if no dialog decorations are to be enabled; false if dialog decorations are to be enabled
IllegalComponentStateException - if the dialog is displayable
IllegalComponentStateException - if undecorated is false, and this dialog does not have the default shape
IllegalComponentStateException - if undecorated is false, and this dialog opacity is less than 1.0f
IllegalComponentStateException - if undecorated is false, and the alpha value of this dialog background color is less than 1.0f
public boolean isUndecorated()
Indicates whether this dialog is undecorated. By default, all dialogs are initially decorated.
true if dialog is undecorated; false otherwise.
()
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.
paramString in class Container
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.
getAccessibleContext in interface Accessible
getAccessibleContext in class Window
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4