public abstract class Dialog extends java.lang.Object implements Adaptable
Dialog
typically contains other widgets
that are not accessible. A Dialog
is not
a Widget
.
This class can also be used as the abstract superclass for user-designed dialogs. Such dialogs usually consist of a Shell with child widgets.
Note: The modality styles supported by this class
are treated as HINTs, because not all are supported
by every subclass on every platform. If a modality style is
not supported, it is "upgraded" to a more restrictive modality
style that is supported. For example, if PRIMARY_MODAL
is not supported by a particular dialog, it would be upgraded to
APPLICATION_MODAL
. In addition, as is the case
for shells, the window manager for the desktop on which the
instance is visible has ultimate control over the appearance
and behavior of the instance, including its modality.
Note: Only one of the styles APPLICATION_MODAL, PRIMARY_MODAL, and SYSTEM_MODAL may be specified.
Shell
Modifier and Type | Field and Description |
---|---|
protected int |
returnCode |
protected Shell |
shell |
Constructor and Description |
---|
Dialog(Shell parent)
Constructs a new instance of this class given only its
parent.
|
Dialog(Shell parent,
int style)
Constructs a new instance of this class given its parent
and a style value describing its behavior and appearance.
|
Modifier and Type | Method and Description |
---|---|
protected void |
checkOperationMode() |
protected void |
checkSubclass() |
<T> T |
getAdapter(java.lang.Class<T> adapter)
Implementation of the
Adaptable interface. |
Shell |
getParent()
Returns the receiver's parent, which must be a
Shell
or null. |
int |
getStyle()
Returns the receiver's style information.
|
java.lang.String |
getText()
Returns the receiver's text, which is the string that the
window manager will typically display as the receiver's
title.
|
void |
open(DialogCallback dialogCallback)
Opens this dialog in a non-blocking way and brings it to the front of the display.
|
protected void |
prepareOpen() |
protected void |
runEventLoop(Shell shell) |
void |
setText(java.lang.String string)
Sets the receiver's text, which is the string that the
window manager will typically display as the receiver's
title, to the argument, which must not be null.
|
protected Shell shell
protected int returnCode
public Dialog(Shell parent)
parent
- a shell which will be the parent of the new instancejava.lang.IllegalArgumentException
- SWTException
- public Dialog(Shell parent, int style)
The style value is either one of the style constants defined in
class SWT
which is applicable to instances of this
class, or must be built by bitwise OR'ing together
(that is, using the int
"|" operator) two or more
of those SWT
style constants. The class description
lists the style constants that are applicable to the class.
Style bits are also inherited from superclasses.
parent
- a shell which will be the parent of the new instancestyle
- the style of dialog to constructjava.lang.IllegalArgumentException
- SWTException
-
public Shell getParent()
Shell
or null.SWTException
- public int getStyle()
Note that, the value which is returned by this method may not match the value which was provided to the constructor when the receiver was created.
SWTException
- public java.lang.String getText()
SWTException
- public void setText(java.lang.String string)
string
- the new textjava.lang.IllegalArgumentException
- SWTException
- public void open(DialogCallback dialogCallback)
dialogCallback
is notified when the dialog is closed.
Use this method instead of the open()
method from the respective
Dialog
implementation when running in JEE_COMPATIBILTY mode.
dialogCallback
- the callback to be notified when the dialog was closed or
null
if no callback should be notified.DialogCallback
,
Application.OperationMode
public <T> T getAdapter(java.lang.Class<T> adapter)
Adaptable
interface.
IMPORTANT: This method is not part of the RWT public API. It is marked public only so that it can be shared within the packages provided by RWT. It should never be accessed from application code.
getAdapter
in interface Adaptable
adapter
- the lookup classnull
if
there is no adapter associated with the given class.protected void prepareOpen()
protected void checkSubclass()
protected void checkOperationMode()
protected void runEventLoop(Shell shell)
Copyright (c) EclipseSource and others 2002, 2020.
All rights reserved. This program and the accompanying materials
are made available under the terms of the
Eclipse Public License v1.0