org.bonitasoft.studio.expression.editor.viewer.EditExpressionDialog.java Source code

Java tutorial

Introduction

Here is the source code for org.bonitasoft.studio.expression.editor.viewer.EditExpressionDialog.java

Source

/**
 * Copyright (C) 2012 BonitaSoft S.A.
 * BonitaSoft, 31 rue Gustave Eiffel - 38000 Grenoble
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2.0 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.bonitasoft.studio.expression.editor.viewer;

import org.bonitasoft.studio.common.ExpressionConstants;
import org.bonitasoft.studio.common.IBonitaVariableContext;
import org.bonitasoft.studio.common.jface.FileActionDialog;
import org.bonitasoft.studio.common.jface.databinding.DialogSupport;
import org.bonitasoft.studio.common.repository.filestore.FileStoreChangeEvent.EventType;
import org.bonitasoft.studio.expression.editor.ExpressionEditorService;
import org.bonitasoft.studio.expression.editor.i18n.Messages;
import org.bonitasoft.studio.expression.editor.provider.ExpressionTypeContentProvider;
import org.bonitasoft.studio.expression.editor.provider.ExpressionTypeLabelProvider;
import org.bonitasoft.studio.expression.editor.provider.IExpressionEditor;
import org.bonitasoft.studio.expression.editor.provider.IExpressionProvider;
import org.bonitasoft.studio.model.expression.Expression;
import org.bonitasoft.studio.model.expression.ExpressionFactory;
import org.bonitasoft.studio.model.expression.ExpressionPackage;
import org.eclipse.core.databinding.UpdateValueStrategy;
import org.eclipse.core.databinding.conversion.Converter;
import org.eclipse.core.databinding.conversion.IConverter;
import org.eclipse.core.runtime.Assert;
import org.eclipse.emf.databinding.EMFDataBindingContext;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.edit.command.SetCommand;
import org.eclipse.emf.edit.domain.EditingDomain;
import org.eclipse.jface.dialogs.DialogTray;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.dialogs.TrayDialog;
import org.eclipse.jface.layout.GridDataFactory;
import org.eclipse.jface.viewers.ColumnViewerToolTipSupport;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerFilter;
import org.eclipse.jface.viewers.ViewerSorter;
import org.eclipse.jface.window.ToolTip;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.BusyIndicator;
import org.eclipse.swt.events.ControlEvent;
import org.eclipse.swt.events.ControlListener;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;

/**
 * @author Romain Bioteau
 *
 */
public class EditExpressionDialog extends TrayDialog implements IBonitaVariableContext {

    protected Expression inputExpression;
    private TableViewer expressionTypeViewer;
    protected final EObject context;
    protected Composite contentComposite;
    protected EMFDataBindingContext dataBindingContext;
    protected final EditingDomain domain;
    protected IExpressionEditor currentExpressionEditor;
    private ISelection oldSelection;
    protected final ViewerFilter[] viewerTypeFilters;
    private boolean isPassword;
    private boolean isPageFlowContext;
    private final Listener openTrayListener = new Listener() {

        @Override
        public void handleEvent(Event event) {
            if (getShell() != null && currentExpressionEditor != null && currentExpressionEditor.provideDialogTray()
                    && getTray() == null) {
                final DialogTray tray = currentExpressionEditor.createDialogTray();
                openTray(tray);

            } else {
                closeTray();
            }
        }
    };
    protected Control helpControl;
    private ExpressionViewer expressionViewer;

    @Override
    public void openTray(DialogTray tray) throws IllegalStateException, UnsupportedOperationException {
        super.openTray(tray);
        getShell().removeListener(SWT.Move, getShell().getListeners(SWT.Move)[0]);
        getShell().removeListener(SWT.Resize, getShell().getListeners(SWT.Resize)[0]);
    }

    protected EditExpressionDialog(Shell parentShell, boolean isPassword, Expression inputExpression,
            EObject context, EditingDomain domain, ViewerFilter[] viewerTypeFilters,
            ExpressionViewer expressionViewer) {
        super(parentShell);
        this.inputExpression = inputExpression;
        if (this.inputExpression == null) {
            this.inputExpression = ExpressionFactory.eINSTANCE.createExpression();
        }
        if (this.inputExpression.getType() == null) {
            this.inputExpression.setType(ExpressionConstants.CONSTANT_TYPE);
        }
        this.context = context;
        this.domain = domain;
        this.viewerTypeFilters = viewerTypeFilters;
        this.isPassword = isPassword;
        this.expressionViewer = expressionViewer;
        setHelpAvailable(true);
        if (isResizable()) {
            setShellStyle(SWT.DIALOG_TRIM | SWT.APPLICATION_MODAL | SWT.MAX | SWT.RESIZE | getDefaultOrientation());
        } else {
            setShellStyle(SWT.DIALOG_TRIM | SWT.APPLICATION_MODAL | getDefaultOrientation());
        }
    }

    @Override
    public void create() {
        super.create();
        String expressionType = inputExpression.getType();
        if (ExpressionConstants.CONSTANT_TYPE.equals(expressionType)) {
            if (!isSupportedConstantType(inputExpression.getReturnType())) {
                expressionType = ExpressionConstants.SCRIPT_TYPE;
            }
        }
        IExpressionProvider currentProvider = ExpressionEditorService.getInstance()
                .getExpressionProvider(expressionType);
        if (currentProvider != null && expressionTypeViewer != null) {
            expressionTypeViewer.setSelection(new StructuredSelection(currentProvider));
        }

        getShell().layout(true, true);
    }

    private boolean isSupportedConstantType(String returnType) {
        return returnType.equals(String.class.getName()) || returnType.equals(Boolean.class.getName())
                || returnType.equals(Double.class.getName()) || returnType.equals(Float.class.getName())
                || returnType.equals(Long.class.getName()) || returnType.equals(Integer.class.getName());
    }

    @Override
    protected void configureShell(Shell newShell) {
        super.configureShell(newShell);
        newShell.setText(Messages.editExpression);
    }

    @Override
    protected Point getInitialSize() {
        return new Point(600, 460);
    }

    @Override
    protected Control createDialogArea(Composite parent) {
        Composite composite = (Composite) super.createDialogArea(parent);

        composite.setLayout(new GridLayout(2, false));
        composite.setLayoutData(GridDataFactory.fillDefaults().grab(true, true).create());

        createExpressionTypePanel(composite);
        createExpressionContentPanel(composite);

        return composite;
    }

    protected void createExpressionContentPanel(Composite parentForm) {
        contentComposite = new Composite(parentForm, SWT.NONE);
        contentComposite.setLayoutData(GridDataFactory.fillDefaults().grab(true, true).create());
        contentComposite.setLayout(new GridLayout(1, false));
    }

    protected void createExpressionTypePanel(Composite parentForm) {
        Composite parentComposite = new Composite(parentForm, SWT.NONE);
        parentComposite.setLayoutData(
                GridDataFactory.swtDefaults().align(SWT.BEGINNING, SWT.FILL).grab(false, true).create());
        parentComposite.setLayout(new GridLayout(1, false));

        Label expressionTypeLabel = new Label(parentComposite, SWT.NONE);
        expressionTypeLabel.setText(Messages.expressionTypeLabel);
        expressionTypeLabel.setLayoutData(GridDataFactory.swtDefaults().grab(true, false).create());

        expressionTypeViewer = new TableViewer(parentComposite, SWT.FULL_SELECTION | SWT.BORDER | SWT.SINGLE);
        expressionTypeViewer.getTable().setLayoutData(GridDataFactory.fillDefaults().grab(true, true).create());

        expressionTypeViewer.setContentProvider(new ExpressionTypeContentProvider());
        expressionTypeViewer.setLabelProvider(new ExpressionTypeLabelProvider());
        expressionTypeViewer.setSorter(new ViewerSorter() {
            @Override
            public int compare(Viewer viewer, Object e1, Object e2) {
                IExpressionProvider p1 = (IExpressionProvider) e1;
                IExpressionProvider p2 = (IExpressionProvider) e2;
                return p1.getTypeLabel().compareTo(p2.getTypeLabel());
            }
        });
        if (viewerTypeFilters != null) {
            expressionTypeViewer.setFilters(viewerTypeFilters);
        }
        ColumnViewerToolTipSupport.enableFor(expressionTypeViewer, ToolTip.NO_RECREATE);
        expressionTypeViewer.setInput(context);
        expressionTypeViewer.addSelectionChangedListener(new ISelectionChangedListener() {

            @Override
            public void selectionChanged(SelectionChangedEvent event) {
                if (!event.getSelection().equals(oldSelection)) {
                    oldSelection = event.getSelection();
                    expressionTypeChanged(event.getSelection());
                    Button okButton = getButton(OK);
                    if (okButton != null && !okButton.isDisposed() && currentExpressionEditor != null) {
                        okButton.setEnabled(currentExpressionEditor.canFinish());
                    } else if (currentExpressionEditor == null) {
                        okButton.setEnabled(false);
                    }
                }
            }
        });

        expressionTypeViewer.addPostSelectionChangedListener(new ISelectionChangedListener() {

            @Override
            public void selectionChanged(SelectionChangedEvent event) {
                getShell().layout(true, true);
            }
        });
    }

    @Override
    protected boolean isResizable() {
        return true;
    }

    protected void expressionTypeChanged(ISelection selection) {
        if (!selection.isEmpty()) {
            final IExpressionProvider provider = (IExpressionProvider) ((StructuredSelection) selection)
                    .getFirstElement();
            BusyIndicator.showWhile(Display.getDefault(), new Runnable() {

                @Override
                public void run() {
                    showContent(provider.getExpressionType());
                }
            });

        }
    }

    @Override
    protected Button createButton(Composite parent, int id, String label, boolean defaultButton) {
        final Button button = super.createButton(parent, id, label, defaultButton);
        if (id == OK) {
            if (currentExpressionEditor != null) {
                button.setEnabled(currentExpressionEditor.canFinish());
            }
        }
        return button;

    }

    protected void showContent(String type) {
        IExpressionProvider provider = ExpressionEditorService.getInstance().getExpressionProvider(type);

        Assert.isNotNull(provider);

        for (Control c : contentComposite.getChildren()) {
            c.dispose();
        }

        if (currentExpressionEditor != null) {
            currentExpressionEditor.dispose();
        }

        currentExpressionEditor = provider.getExpressionEditor(inputExpression, context);
        currentExpressionEditor.setIsPageFlowContext(isPageFlowContext);
        if (currentExpressionEditor != null) {
            currentExpressionEditor.createExpressionEditor(contentComposite, isPassword);
            contentComposite.layout(true, true);
            if (helpControl != null) {
                //            helpControl.setVisible(currentExpressionEditor.provideDialogTray());
                helpControl.setVisible(false);
                if (currentExpressionEditor.provideDialogTray()) {
                    ToolItem item = ((ToolBar) helpControl).getItem(0);
                    item.setSelection(true);
                    openTrayListener.handleEvent(new Event());
                } else if (getTray() != null) {
                    closeTray();
                }
            }
            if (dataBindingContext != null) {
                dataBindingContext.dispose();
            }
            dataBindingContext = new EMFDataBindingContext();

            UpdateValueStrategy selectionToExpressionType = new UpdateValueStrategy();
            IConverter convert = new Converter(IExpressionProvider.class, String.class) {

                @Override
                public Object convert(Object arg0) {
                    return ((IExpressionProvider) arg0).getExpressionType();
                }
            };
            selectionToExpressionType.setConverter(convert);

            if (domain != null) {
                domain.getCommandStack().execute(SetCommand.create(domain, inputExpression,
                        ExpressionPackage.Literals.EXPRESSION__TYPE, type));
            } else {
                inputExpression.setType(type);
            }
            currentExpressionEditor.bindExpression(dataBindingContext, context, inputExpression, viewerTypeFilters,
                    expressionViewer);
            currentExpressionEditor.addListener(new Listener() {
                @Override
                public void handleEvent(Event event) {
                    Button okButton = getButton(OK);
                    if (okButton != null && !okButton.isDisposed()) {
                        okButton.setEnabled(currentExpressionEditor.canFinish());
                    }
                }
            });
            DialogSupport.create(this, dataBindingContext);
        }
    }

    @Override
    protected void okPressed() {
        if (currentExpressionEditor != null) {
            currentExpressionEditor.okPressed();
        }
        super.okPressed();
    }

    @Override
    public boolean close() {
        if (getTray() != null) {
            closeTray();
        }
        if (currentExpressionEditor != null) {
            currentExpressionEditor.dispose();
        }
        return super.close();
    }

    @Override
    protected boolean canHandleShellCloseEvent() {
        if (FileActionDialog.getDisablePopup()) {
            return true;
        }
        if (MessageDialog.openQuestion(getShell(), Messages.handleShellCloseEventTitle,
                Messages.handleShellCloseEventMessage)) {
            return super.canHandleShellCloseEvent();
        }
        return false;
    }

    @Override
    protected Control createHelpControl(Composite parent) {
        helpControl = super.createHelpControl(parent);
        ToolItem item = ((ToolBar) helpControl).getItem(0);
        Listener[] listeners = item.getListeners(SWT.Selection);
        if (listeners.length > 0) {
            for (Listener l : listeners) {
                item.removeListener(SWT.Selection, l);
            }
        }
        item.addListener(SWT.Selection, openTrayListener);
        if (currentExpressionEditor != null) {
            //         helpControl.setVisible(currentExpressionEditor.provideDialogTray());
            helpControl.setVisible(false);
        }
        return helpControl;
    }

    public Expression getExpression() {
        return inputExpression;
    }

    @Override
    public boolean isPageFlowContext() {

        return isPageFlowContext;
    }

    @Override
    public void setIsPageFlowContext(boolean isPageFlowContext) {
        this.isPageFlowContext = isPageFlowContext;
        if (currentExpressionEditor != null) {
            currentExpressionEditor.setIsPageFlowContext(isPageFlowContext);
        }

    }

}