/*******************************************************************************
* Copyright (c) 2000, 2011 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.swt.widgets;
import org.eclipse.swt.*;
/**
* This class is the abstract superclass of the classes
* that represent the built in platform dialogs.
* A 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. The basic template for a * user-defined dialog typically looks something like this:
*
* 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;
* }
* }
*
*
* 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. *
* * @see Shell * @see SWT Example: ControlExample * @see Sample code and further information */ public abstract class Dialog { int style; Shell parent; String title; /** * Constructs a new instance of this class given only its * parent. * * @param parent a shell which will be the parent of the new instance * * @exception IllegalArgumentException
* 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.
*
* @param parent a shell which will be the parent of the new instance
* @param style the style of dialog to construct
*
* @exception IllegalArgumentException
* IMPORTANT: See the comment in Widget.checkSubclass()
.
*
SWTError.error
to handle the error.
*
* @param code the descriptive error code
*
* @see SWT#error(int)
*/
void error (int code) {
SWT.error(code);
}
/**
* Returns the receiver's parent, which must be a Shell
* or null.
*
* @return the receiver's parent
*
* @exception SWTException * 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. *
* * @return the style bits * * @exception SWTException