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 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
.
- Since:
- 1.0
- See Also:
-
WindowEvent
,Window.addWindowListener(java.awt.event.WindowListener)
, Serialized Form
Nested Class Summary
Modifier and Type | Class | Description |
---|---|---|
protected class | Dialog.AccessibleAWTDialog | This class implements accessibility support for the |
static class | Dialog.ModalExclusionType | Any top-level window can be marked not to be blocked by modal dialogs. |
static class | Dialog.ModalityType | Modal dialogs block all input to some top-level windows. |
Nested classes/interfaces declared in class java.awt.Window
Window.AccessibleAWTWindow, Window.Type
Nested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Field Summary
Modifier and Type | Field | Description |
---|---|---|
static Dialog.ModalityType | DEFAULT_MODALITY_TYPE | Default modality type for modal dialogs. |
Fields declared in class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor Summary
Constructor | Description |
---|---|
Dialog(Dialog owner) | Constructs an initially invisible, modeless |
Dialog(Dialog owner,
String title) | Constructs an initially invisible, modeless |
Dialog(Dialog owner,
String title,
boolean modal) | Constructs an initially invisible |
Dialog(Dialog owner,
String title,
boolean modal,
GraphicsConfiguration gc) | Constructs an initially invisible |
Dialog(Frame owner) | Constructs an initially invisible, modeless |
Dialog(Frame owner,
boolean modal) | Constructs an initially invisible |
Dialog(Frame owner,
String title) | Constructs an initially invisible, modeless |
Dialog(Frame owner,
String title,
boolean modal) | Constructs an initially invisible |
Dialog(Frame owner,
String title,
boolean modal,
GraphicsConfiguration gc) | Constructs an initially invisible |
Dialog(Window owner) | Constructs an initially invisible, modeless |
Dialog(Window owner,
Dialog.ModalityType modalityType) | Constructs an initially invisible |
Dialog(Window owner,
String title) | Constructs an initially invisible, modeless |
Dialog(Window owner,
String title,
Dialog.ModalityType modalityType) | Constructs an initially invisible |
Dialog(Window owner,
String title,
Dialog.ModalityType modalityType,
GraphicsConfiguration gc) | Constructs an initially invisible |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
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() | Deprecated. As of JDK version 1.5, replaced by 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 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 |
void | show() | Deprecated. As of JDK version 1.5, replaced by setVisible(boolean) . |
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 declared in class java.awt.Window
addPropertyChangeListener, 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.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, 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.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, 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, transferFocusUpCycle
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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)
.
- Since:
- 1.6
- See Also:
-
Dialog.ModalityType
,setModal(boolean)
Constructor Detail
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 ornull
if this dialog has no owner - Throws:
-
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- See Also:
-
GraphicsEnvironment.isHeadless()
,Component.setSize(int, int)
,Component.setVisible(boolean)
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 ornull
if this dialog has no owner -
modal
- specifies whether dialog blocks user input to other top-level windows when shown. Iffalse
, the dialog isMODELESS
; iftrue
, the modality type property is set toDEFAULT_MODALITY_TYPE
- Throws:
-
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- See Also:
-
Dialog.ModalityType
,Dialog.ModalityType.MODELESS
,DEFAULT_MODALITY_TYPE
,setModal(boolean)
,setModalityType(java.awt.Dialog.ModalityType)
,GraphicsEnvironment.isHeadless()
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 ornull
if this dialog has no owner -
title
- the title of the dialog ornull
if this dialog has no title - Throws:
-
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- 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 ornull
if this dialog has no owner -
title
- the title of the dialog ornull
if this dialog has no title -
modal
- specifies whether dialog blocks user input to other top-level windows when shown. Iffalse
, the dialog isMODELESS
; iftrue
, the modality type property is set toDEFAULT_MODALITY_TYPE
- Throws:
-
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- See Also:
-
Dialog.ModalityType
,Dialog.ModalityType.MODELESS
,DEFAULT_MODALITY_TYPE
,setModal(boolean)
,setModalityType(java.awt.Dialog.ModalityType)
,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 ornull
if this dialog has no owner -
title
- the title of the dialog ornull
if this dialog has no title -
modal
- specifies whether dialog blocks user input to other top-level windows when shown. Iffalse
, the dialog isMODELESS
; iftrue
, the modality type property is set toDEFAULT_MODALITY_TYPE
-
gc
- theGraphicsConfiguration
of the target screen device; ifnull
, the default systemGraphicsConfiguration
is assumed - Throws:
-
IllegalArgumentException
- ifgc
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- Since:
- 1.4
- See Also:
-
Dialog.ModalityType
,Dialog.ModalityType.MODELESS
,DEFAULT_MODALITY_TYPE
,setModal(boolean)
,setModalityType(java.awt.Dialog.ModalityType)
,GraphicsEnvironment.isHeadless()
,Component.setSize(int, int)
,Component.setVisible(boolean)
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 ornull
if this dialog has no owner - Throws:
-
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- Since:
- 1.2
- See Also:
GraphicsEnvironment.isHeadless()
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 ornull
if this has no owner -
title
- the title of the dialog ornull
if this dialog has no title - Throws:
-
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- 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 ornull
if this dialog has no owner -
title
- the title of the dialog ornull
if this dialog has no title -
modal
- specifies whether dialog blocks user input to other top-level windows when shown. Iffalse
, the dialog isMODELESS
; iftrue
, the modality type property is set toDEFAULT_MODALITY_TYPE
- Throws:
-
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- Since:
- 1.2
- See Also:
-
Dialog.ModalityType
,Dialog.ModalityType.MODELESS
,DEFAULT_MODALITY_TYPE
,setModal(boolean)
,setModalityType(java.awt.Dialog.ModalityType)
,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 ornull
if this dialog has no owner -
title
- the title of the dialog ornull
if this dialog has no title -
modal
- specifies whether dialog blocks user input to other top-level windows when shown. Iffalse
, the dialog isMODELESS
; iftrue
, the modality type property is set toDEFAULT_MODALITY_TYPE
-
gc
- theGraphicsConfiguration
of the target screen device; ifnull
, the default systemGraphicsConfiguration
is assumed - Throws:
-
IllegalArgumentException
- ifgc
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- Since:
- 1.4
- See Also:
-
Dialog.ModalityType
,Dialog.ModalityType.MODELESS
,DEFAULT_MODALITY_TYPE
,setModal(boolean)
,setModalityType(java.awt.Dialog.ModalityType)
,GraphicsEnvironment.isHeadless()
,Component.setSize(int, int)
,Component.setVisible(boolean)
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 ofDialog
,Frame
, any of their descendants ornull
- Throws:
-
IllegalArgumentException
- if theowner
is not an instance ofDialog
orFrame
-
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- Since:
- 1.6
- See Also:
GraphicsEnvironment.isHeadless()
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 ofDialog
,Frame
, any of their descendants ornull
-
title
- the title of the dialog ornull
if this dialog has no title - Throws:
-
IllegalArgumentException
- if theowner
is not an instance ofDialog
orFrame
-
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
- Since:
- 1.6
- See Also:
GraphicsEnvironment.isHeadless()
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 ofDialog
,Frame
, any of their descendants ornull
-
modalityType
- specifies whether dialog blocks input to other windows when shown.null
value and unsupported modality types are equivalent toMODELESS
- Throws:
-
IllegalArgumentException
- if theowner
is not an instance ofDialog
orFrame
-
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
-
SecurityException
- if the calling thread does not have permission to create modal dialogs with the givenmodalityType
- Since:
- 1.6
- See Also:
-
Dialog.ModalityType
,setModal(boolean)
,setModalityType(java.awt.Dialog.ModalityType)
,GraphicsEnvironment.isHeadless()
,Toolkit.isModalityTypeSupported(java.awt.Dialog.ModalityType)
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 ofDialog
,Frame
, any of their descendants ornull
-
title
- the title of the dialog ornull
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 toMODELESS
- Throws:
-
IllegalArgumentException
- if theowner
is not an instance ofDialog
orFrame
-
IllegalArgumentException
- if theowner
'sGraphicsConfiguration
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
-
SecurityException
- if the calling thread does not have permission to create modal dialogs with the givenmodalityType
- Since:
- 1.6
- See Also:
-
Dialog.ModalityType
,setModal(boolean)
,setModalityType(java.awt.Dialog.ModalityType)
,GraphicsEnvironment.isHeadless()
,Toolkit.isModalityTypeSupported(java.awt.Dialog.ModalityType)
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 ofDialog
,Frame
, any of their descendants ornull
-
title
- the title of the dialog ornull
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 toMODELESS
-
gc
- theGraphicsConfiguration
of the target screen device; ifnull
, the default systemGraphicsConfiguration
is assumed - Throws:
-
IllegalArgumentException
- if theowner
is not an instance ofDialog
orFrame
-
IllegalArgumentException
- ifgc
is not from a screen device -
HeadlessException
- whenGraphicsEnvironment.isHeadless()
returnstrue
-
SecurityException
- if the calling thread does not have permission to create modal dialogs with the givenmodalityType
- Since:
- 1.6
- See Also:
-
Dialog.ModalityType
,setModal(boolean)
,setModalityType(java.awt.Dialog.ModalityType)
,GraphicsEnvironment.isHeadless()
,Toolkit.isModalityTypeSupported(java.awt.Dialog.ModalityType)
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 classWindow
- See Also:
-
Component.isDisplayable()
,Container.removeNotify()
isModal
public boolean isModal()
Indicates whether the dialog is modal.
This method is obsolete and is kept for backwards compatibility only. Use getModalityType()
instead.
- Returns:
-
true
if this dialog window is modal;false
otherwise - See Also:
-
DEFAULT_MODALITY_TYPE
,Dialog.ModalityType.MODELESS
,setModal(boolean)
,getModalityType()
,setModalityType(java.awt.Dialog.ModalityType)
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 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 tosetModal(true)
is equivalent tosetModalityType(Dialog.DEFAULT_MODALITY_TYPE)
, and calling tosetModal(false)
is equivalent tosetModalityType(Dialog.ModalityType.MODELESS)
- Since:
- 1.1
- See Also:
-
DEFAULT_MODALITY_TYPE
,Dialog.ModalityType.MODELESS
,isModal()
,getModalityType()
,setModalityType(java.awt.Dialog.ModalityType)
getModalityType
public Dialog.ModalityType getModalityType()
Returns the modality type of this dialog.
- Returns:
- modality type of this dialog
- Since:
- 1.6
- See Also:
setModalityType(java.awt.Dialog.ModalityType)
setModalityType
public void setModalityType(Dialog.ModalityType type)
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.
- Parameters:
-
type
- specifies whether dialog blocks input to other windows when shown.null
value and unsupported modality types are equivalent toMODELESS
- Throws:
-
SecurityException
- if the calling thread does not have permission to create modal dialogs with the givenmodalityType
- Since:
- 1.6
- See Also:
-
getModalityType()
,Toolkit.isModalityTypeSupported(java.awt.Dialog.ModalityType)
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()
setVisible
public void setVisible(boolean b)
Shows or hides this Dialog
depending on the value of parameter b
.
- Overrides:
-
setVisible
in classWindow
- Parameters:
-
b
- iftrue
, makes theDialog
visible, otherwise hides theDialog
. 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. Iffalse
, hides theDialog
and then causessetVisible(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 callingsetVisible(false)
ordispose
. -
setVisible(false)
: Hides the dialog and then returns onsetVisible(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.
-
- See Also:
-
Window.setVisible(boolean)
,Window.dispose()
,Component.isDisplayable()
,Component.validate()
,isModal()
show
@Deprecated public void show()
setVisible(boolean)
.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.
- Overrides:
-
show
in classWindow
- See Also:
-
Component.hide()
,Component.isDisplayable()
,Component.validate()
,isModal()
,Window.setVisible(boolean)
hide
@Deprecated public void hide()
setVisible(boolean)
.Hides the Dialog and then causes show
to return if it is currently blocked.
- Overrides:
-
hide
in classWindow
- See Also:
-
Window.show()
,Window.dispose()
,Window.setVisible(boolean)
toBack
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.
- Overrides:
-
toBack
in classWindow
- See Also:
Window.toBack()
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. - 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. 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
- 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 -
IllegalComponentStateException
- ifundecorated
isfalse
, and this dialog does not have the default shape -
IllegalComponentStateException
- ifundecorated
isfalse
, and this dialog opacity is less than1.0f
-
IllegalComponentStateException
- ifundecorated
isfalse
, and the alpha value of this dialog background color is less than1.0f
- Since:
- 1.4
- See Also:
-
isUndecorated()
,Component.isDisplayable()
,Window.getShape()
,Window.getOpacity()
,Window.getBackground()
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 classContainer
- 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 interfaceAccessible
- Overrides:
-
getAccessibleContext
in classWindow
- Returns:
- an AccessibleAWTDialog that serves as the AccessibleContext of this Dialog
- Since:
- 1.3