org.eclipse.swt.widgets.Dialog Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2002, 2016 Innoopract Informationssysteme GmbH and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Innoopract Informationssysteme GmbH - initial API and implementation
* EclipseSource - ongoing development
******************************************************************************/
package org.eclipse.swt.widgets;
import static org.eclipse.rap.rwt.internal.service.ContextProvider.getApplicationContext;
import org.eclipse.rap.rwt.Adaptable;
import org.eclipse.rap.rwt.internal.lifecycle.SimpleLifeCycle;
import org.eclipse.rap.rwt.internal.textsize.TextSizeUtil;
import org.eclipse.rap.rwt.widgets.DialogCallback;
import org.eclipse.swt.SWT;
import org.eclipse.swt.SWTException;
import org.eclipse.swt.events.ShellAdapter;
import org.eclipse.swt.events.ShellEvent;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.internal.SerializableCompatibility;
/**
* 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.
*
* 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.
*
* - Styles:
* - APPLICATION_MODAL, PRIMARY_MODAL, SYSTEM_MODAL
* - Events:
* - (none)
*
*
* Note: Only one of the styles APPLICATION_MODAL, PRIMARY_MODAL,
* and SYSTEM_MODAL may be specified.
*
*
* @see Shell
*/
public abstract class Dialog implements Adaptable, SerializableCompatibility {
private static final int HORIZONTAL_DIALOG_UNIT_PER_CHAR = 4;
final int style;
final Shell parent;
protected Shell shell;
protected int returnCode;
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
* - ERROR_NULL_ARGUMENT - if the parent is null
*
* @exception SWTException
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
*
*/
public Dialog( Shell parent ) {
this( parent, SWT.PRIMARY_MODAL );
}
/**
* Constructs a new instance of this class given its parent
* and a style value describing its behavior and appearance.
*
* 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
* - ERROR_NULL_ARGUMENT - if the parent is null
*
* @exception SWTException
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
*
*
*
* @see SWT#APPLICATION_MODAL
*
*/
public Dialog( Shell parent, int style ) {
checkParent( parent );
this.parent = parent;
this.style = style;
title = "";
}
/**
* Returns the receiver's parent, which must be a Shell
* or null.
*
* @return the receiver's parent
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public Shell getParent() {
return parent;
}
/**
* Returns the receiver's style information.
*
* 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
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public int getStyle() {
return style;
}
/**
* Returns the receiver's text, which is the string that the
* window manager will typically display as the receiver's
* title. If the text has not previously been set,
* returns an empty string.
*
* @return the text
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public String getText() {
return title;
}
/**
* 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.
*
* @param string the new text
*
* @exception IllegalArgumentException
* - ERROR_NULL_ARGUMENT - if the text is null
*
* @exception SWTException
* - ERROR_WIDGET_DISPOSED - if the receiver has been disposed
* - ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
*
*/
public void setText( String string ) {
if( string == null ) {
SWT.error( SWT.ERROR_NULL_ARGUMENT );
}
title = string;
}
/**
* Opens this dialog in a non-blocking way and brings it to the front of the display. If given,
* the 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.
*
*
* @param dialogCallback the callback to be notified when the dialog was closed or
* null if no callback should be notified.
* @see DialogCallback
* @see org.eclipse.rap.rwt.application.Application.OperationMode
* @rwtextension This method is not available in SWT.
* @since 3.1
*/
public void open( final DialogCallback dialogCallback ) {
prepareOpen();
returnCode = SWT.CANCEL;
shell.open();
shell.addShellListener( new ShellAdapter() {
@Override
public void shellClosed( ShellEvent event ) {
if( dialogCallback != null ) {
dialogCallback.dialogClosed( returnCode );
}
}
} );
}
/**
* Implementation of the 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.
*
*/
@Override
public T getAdapter( Class adapter ) {
return null;
}
protected void prepareOpen() {
}
protected void checkSubclass() {
if( !Display.isValidClass( getClass() ) ) {
SWT.error( SWT.ERROR_INVALID_SUBCLASS );
}
}
protected void checkOperationMode() {
if( getApplicationContext().getLifeCycleFactory().getLifeCycle() instanceof SimpleLifeCycle ) {
throw new UnsupportedOperationException( "Method not supported in JEE_COMPATIBILITY mode." );
}
}
protected void runEventLoop( Shell shell ) {
shell.open();
Display display = shell.getDisplay();
while( !shell.isDisposed() ) {
if( !display.readAndDispatch() ) {
display.sleep();
}
}
}
static int convertHorizontalDLUsToPixels( Control control, int dlus ) {
Font dialogFont = control.getFont();
float charWidth = TextSizeUtil.getAvgCharWidth( dialogFont );
float width = charWidth * dlus + HORIZONTAL_DIALOG_UNIT_PER_CHAR / 2;
return ( int )( width / HORIZONTAL_DIALOG_UNIT_PER_CHAR );
}
static int checkStyle( Shell parent, int style ) {
int result = style;
int mask = SWT.PRIMARY_MODAL | SWT.APPLICATION_MODAL | SWT.SYSTEM_MODAL;
if( ( result & SWT.SHEET ) != 0 ) {
result &= ~SWT.SHEET;
if( ( result & mask ) == 0 ) {
result |= parent == null ? SWT.APPLICATION_MODAL : SWT.PRIMARY_MODAL;
}
}
if( ( result & mask ) == 0 ) {
result |= SWT.APPLICATION_MODAL;
}
if( ( result & ( SWT.LEFT_TO_RIGHT ) ) == 0 ) {
if( parent != null ) {
if( ( parent.style & SWT.LEFT_TO_RIGHT ) != 0 ) {
result |= SWT.LEFT_TO_RIGHT;
}
}
}
return result;
}
private static void checkParent( Shell parent ) {
if( parent == null ) {
SWT.error( SWT.ERROR_NULL_ARGUMENT );
}
parent.checkWidget();
}
}