Dialog

This class is the abstract superclass of the classes that represent the built in platform dialogs. A <code>Dialog</code> typically contains other widgets that are not accessible. A <code>Dialog</code> is not a <code>Widget</code>. <p> This class can also be used as the abstract superclass for user-designed dialogs. Such dialogs usually consist of a Shell with child widgets. The basic template for a user-defined dialog typically looks something like this: <pre><code> public class MyDialog extends Dialog { Object result;

public MyDialog (Shell parent, int style) { super (parent, style); } public MyDialog (Shell parent) { this (parent, 0); // your default style bits go here (not the Shell's style bits) } public Object open () { Shell parent = getParent(); Shell shell = new Shell(parent, SWT.DIALOG_TRIM | SWT.APPLICATION_MODAL); shell.setText(getText()); // Your code goes here (widget creation, set result, etc). shell.open(); Display display = parent.getDisplay(); while (!shell.isDisposed()) { if (!display.readAndDispatch()) display.sleep(); } return result; } } </pre></code> <p> Note: The <em>modality</em> styles supported by this class are treated as <em>HINT</em>s, 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 <code>PRIMARY_MODAL</code> is not supported by a particular dialog, it would be upgraded to <code>APPLICATION_MODAL</code>. 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. <dl> <dt><b>Styles:</b></dt> <dd>APPLICATION_MODAL, PRIMARY_MODAL, SYSTEM_MODAL</dd> <dt><b>Events:</b></dt> <dd>(none)</dd> </dl> <p> Note: Only one of the styles APPLICATION_MODAL, PRIMARY_MODAL, and SYSTEM_MODAL may be specified. </p>

@see Shell @see <a href="http://www.eclipse.org/swt/examples.php">SWT Example: ControlExample</a> @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

Constructors

this
this(Shell parent)

Constructs a new instance of this class given only its parent.

this
this(Shell parent, int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. <p> The style value is either one of the style constants defined in class <code>SWT</code> which is applicable to instances of this class, or must be built by <em>bitwise OR</em>'ing together (that is, using the <code>int</code> "|" operator) two or more of those <code>SWT</code> style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Members

Functions

checkParent
void checkParent(Shell parent)

Throws an exception if the specified widget can not be used as a parent for the receiver.

checkSubclass
void checkSubclass()

Checks that this class can be subclassed. <p> IMPORTANT: See the comment in <code>Widget.checkSubclass()</code>. </p>

error
void error(int code)

Does whatever dialog specific cleanup is required, and then uses the code in <code>SWTError.error</code> to handle the error.

getParent
Shell getParent()

Returns the receiver's parent, which must be a <code>Shell</code> or null.

getStyle
int getStyle()

Returns the receiver's style information. <p> Note that, the value which is returned by this method <em>may not match</em> the value which was provided to the constructor when the receiver was created. </p>

getText
String getText()

Returns the receiver's text, which is the string that the window manager will typically display as the receiver's <em>title</em>. If the text has not previously been set, returns an empty string.

setText
void setText(String string)

Sets the receiver's text, which is the string that the window manager will typically display as the receiver's <em>title</em>, to the argument, which must not be null.

Meta