at.spardat.xma.guidesign.presentation.GuidesignEditor.java Source code

Java tutorial

Introduction

Here is the source code for at.spardat.xma.guidesign.presentation.GuidesignEditor.java

Source

/*******************************************************************************
 * Copyright (c) 2003, 2007 s IT Solutions AT Spardat GmbH .
 * 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:
 *     s IT Solutions AT Spardat GmbH - initial API and implementation
 *******************************************************************************/

/**
 * <copyright>
 * </copyright>
 *
 * %W%
 * @version %I% %H%
 */
package at.spardat.xma.guidesign.presentation;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.EventObject;
import java.util.Iterator;
import java.util.List;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceChangeEvent;
import org.eclipse.core.resources.IResourceChangeListener;
import org.eclipse.core.resources.IResourceDelta;
import org.eclipse.core.resources.IResourceDeltaVisitor;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Platform;
import org.eclipse.emf.common.command.BasicCommandStack;
import org.eclipse.emf.common.command.Command;
import org.eclipse.emf.common.command.CommandStack;
import org.eclipse.emf.common.command.CommandStackListener;
import org.eclipse.emf.common.notify.AdapterFactory;
import org.eclipse.emf.common.ui.ViewerPane;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.ecore.xmi.impl.XMIResourceImpl;
import org.eclipse.emf.edit.domain.AdapterFactoryEditingDomain;
import org.eclipse.emf.edit.domain.EditingDomain;
import org.eclipse.emf.edit.domain.IEditingDomainProvider;
import org.eclipse.emf.edit.provider.AdapterFactoryItemDelegator;
import org.eclipse.emf.edit.provider.ComposedAdapterFactory;
import org.eclipse.emf.edit.provider.resource.ResourceItemProviderAdapterFactory;
import org.eclipse.emf.edit.ui.action.EditingDomainActionBarContributor;
import org.eclipse.emf.edit.ui.dnd.EditingDomainViewerDropAdapter;
import org.eclipse.emf.edit.ui.dnd.LocalTransfer;
import org.eclipse.emf.edit.ui.dnd.ViewerDragAdapter;
import org.eclipse.emf.edit.ui.provider.AdapterFactoryContentProvider;
import org.eclipse.emf.edit.ui.provider.AdapterFactoryLabelProvider;
import org.eclipse.jface.action.IMenuListener;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.IStatusLineManager;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.Separator;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.dialogs.ProgressMonitorDialog;
import org.eclipse.jface.viewers.ContentViewer;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.ISelectionProvider;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.StructuredViewer;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.swt.dnd.DND;
import org.eclipse.swt.dnd.Transfer;
import org.eclipse.swt.events.ControlAdapter;
import org.eclipse.swt.events.ControlEvent;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IEditorSite;
import org.eclipse.ui.IFileEditorInput;
import org.eclipse.ui.IPartListener;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.actions.WorkspaceModifyOperation;
import org.eclipse.ui.dialogs.SaveAsDialog;
import org.eclipse.ui.part.FileEditorInput;
import org.eclipse.ui.part.MultiPageEditorPart;
import org.eclipse.ui.views.contentoutline.ContentOutline;
import org.eclipse.ui.views.contentoutline.ContentOutlinePage;
import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
import org.eclipse.ui.views.markers.MarkerSupportView;
import org.eclipse.ui.views.properties.IPropertySheetPage;
import org.eclipse.ui.views.properties.PropertySheet;
import org.eclipse.ui.views.properties.PropertySheetPage;

import at.spardat.xma.guidesign.XMAComponent;
import at.spardat.xma.guidesign.XMAPage;
import at.spardat.xma.guidesign.XMAWidget;
import at.spardat.xma.guidesign.plugin.GUIDesignerPlugin;
import at.spardat.xma.guidesign.provider.GuidesignItemProviderAdapterFactory;
import at.spardat.xma.guidesign.types.provider.TypesItemProviderAdapterFactory;

/**
 * This is an example of a Guidesign model editor.
 * <!-- begin-user-doc -->
 * <!-- end-user-doc -->
 * @generated
 */
public class GuidesignEditor extends MultiPageEditorPart
        implements IEditingDomainProvider, ISelectionProvider, IMenuListener {

    //for debugging
    private static boolean debug = false;

    {
        String value = Platform.getDebugOption("at.spardat.xma.guidesigner/debug/editor");
        if (value != null && value.equalsIgnoreCase("true")) {
            GuidesignEditor.debug = true;
        }
    }

    static void debug(String message) {
        if (GuidesignEditor.debug) {
            System.out.println(message);
        }
    }
    // end debugging stuff

    /**
     * remeber the change state of the  model
     */
    private boolean dirty = false;

    /**
     * remeber the resource file
     */
    private IFile file;

    /**
     * Rembers the XMAComponent that is edited with this editor
     */
    private XMAComponent component;

    /**
     * This keeps track of the editing domain that is used to track all changes to the model.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected AdapterFactoryEditingDomain editingDomain;

    /**
     * This is the one adapter factory used for providing views of the model.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected ComposedAdapterFactory adapterFactory;

    /**
     * This is the content outline page.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected IContentOutlinePage contentOutlinePage;

    /**
     * This is a kludge...
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected IStatusLineManager contentOutlineStatusLineManager;

    /**
     * This is the content outline page's viewer.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected TreeViewer contentOutlineViewer;

    /**
     * This is the property sheet page.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected PropertySheetPage propertySheetPage;

    /**
     *
     * <!-- begin-user-doc -->
     * The graphViewer shows the content of an page as SWT GUI.
     * <!-- end-user-doc -->
     * @modified
     */
    public UIPreviewer graphViewer;

    protected ViewerPane graphViewerPane;

    /**
     * This keeps track of the active viewer pane, in the book.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected ViewerPane currentViewerPane;

    /**
     * This keeps track of the active content viewer, which may be either one of the viewers in the pages or the content outline viewer.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected Viewer currentViewer;

    /**
     * This listens to which ever viewer is active.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected ISelectionChangedListener selectionChangedListener;

    /**
     * This keeps track of all the {@link org.eclipse.jface.viewers.ISelectionChangedListener}s that are listening to this editor.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected Collection selectionChangedListeners = new ArrayList();

    /**
     * This keeps track of the selection of the editor as a whole.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected ISelection editorSelection;

    /**
     * This listens for when the outline becomes active
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @modified
     */
    protected IPartListener partListener = new IPartListener() {
        public void partActivated(IWorkbenchPart p) {
            //for debugging
            debug("+++ part Activated: " + p.getTitle());
            if (p instanceof ContentOutline) {
                if (((ContentOutline) p).getCurrentPage() == contentOutlinePage) {
                    getActionBarContributor().setActiveEditor(GuidesignEditor.this);
                    setCurrentViewer(contentOutlineViewer);
                }
            } else if (p instanceof PropertySheet) {
                if (((PropertySheet) p).getCurrentPage() == propertySheetPage) {
                    getActionBarContributor().setActiveEditor(GuidesignEditor.this);
                }
            } else if (p == GuidesignEditor.this) {
                setCurrentViewer(graphViewer);
                if (contentOutlinePage != null) {
                    contentOutlinePage.setSelection(getSelection());
                }
            }
        }

        public void partBroughtToTop(IWorkbenchPart p) {
            debug(" --- part partBroughtToTop: " + p.getTitle());
        }

        public void partClosed(IWorkbenchPart p) {
        }

        public void partDeactivated(IWorkbenchPart p) {
            debug(" --- part deactivated: " + p.getTitle());
            // mark the double clicked problem also in the editor
            if (p instanceof MarkerSupportView) {
                MarkerSupportView pview = (MarkerSupportView) p;
                IMarker[] markers = pview.getSelectedMarkers();
                if (markers.length > 0) {
                    gotoMarker(markers[0]);
                }
            }
        }

        public void partOpened(IWorkbenchPart p) {
            if (p == GuidesignEditor.this) {
                setCurrentViewerPane(graphViewerPane);
            }
        }
    };

    /**
     * Handles what to do with changed resources on activation.
     */
    protected void handleChangedResources(Resource changedResource) {
        if (!isDirty() || handleDirtyConflict()) {
            // remember old selection before we reload the model
            ISelection isel = getSelection();
            Resource mainResource = (Resource) editingDomain.getResourceSet().getResources().get(0);

            //for (Iterator i = changedResources.iterator(); i.hasNext(); ) {
            Resource resource = changedResource;
            // main resource changed?
            boolean isMainRes = mainResource.equals(resource);
            if (resource.isLoaded()) {
                resource.unload();
            }
            try {
                resource.load(Collections.EMPTY_MAP);
                component = (XMAComponent) resource.getContents().get(0);
            } catch (IOException exception) {
                GUIDesignerPlugin.INSTANCE.log(exception);
            }

            // main resource changed?
            if (isMainRes) {

                // Determine the new selection                   
                final ISelection newSel;
                if (isel instanceof StructuredSelection) {
                    EList eList = resource.getContents();
                    newSel = createNewSelection((StructuredSelection) isel, eList);
                } else {
                    newSel = StructuredSelection.EMPTY;
                }

                // Take the new selection as input when possible (to avoid flickering)
                Object input = resource;
                if (newSel instanceof StructuredSelection) {
                    StructuredSelection structSel = (StructuredSelection) newSel;
                    if (structSel.getFirstElement() instanceof XMAWidget) {
                        input = (XMAWidget) structSel.getFirstElement();
                    }
                }

                // force viewer to reload                   
                graphViewer.invalidateOldInput();
                graphViewer.setInput(input);

                // we only care about structured selections (there should not be somethin else)
                if (isel instanceof StructuredSelection) {
                    // asyncExec to avoid timing problems
                    getSite().getShell().getDisplay().asyncExec(new Runnable() {
                        public void run() {
                            //set the selection to the composite
                            setSelection(newSel);
                        }
                    });
                }
            }
            //}
            ((BasicCommandStack) editingDomain.getCommandStack()).saveIsDone();
            dirty = false;
            firePropertyChange(IEditorPart.PROP_DIRTY);
        }
    }

    // create a new selection from the old one with the new model content
    private StructuredSelection createNewSelection(StructuredSelection selection, EList list) {
        XMAModelPath[] paths = XMAModelPath.createPathsFromSelection(selection);
        StructuredSelection newSelection = XMAModelPath.createSelectionFromKeyPaths(paths, list);
        return newSelection;
    }

    /**
     * Create a root selection array for a XMAComponent
     * (This can be used for default selection.)
     * 
     * @param comp
     * @return
     */
    private Object[] createRootSelectionArray(XMAComponent comp) {
        ArrayList selArray = new ArrayList();
        if (comp.getPage().size() > 0) {
            XMAPage firstPage = (XMAPage) comp.getPage().get(0);
            if (firstPage.getComposite() != null) {
                selArray.add(firstPage.getComposite());
            } else {
                selArray.add(firstPage);
            }
        } else {
            selArray.add(component);
        }
        return selArray.toArray();
    }

    /**
     * This listens for workspace changes.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected IResourceChangeListener resourceChangeListener = new IResourceChangeListener() {
        public void resourceChanged(IResourceChangeEvent event) {
            IResourceDelta delta = event.getDelta();
            try {
                class ResourceDeltaVisitor implements IResourceDeltaVisitor {
                    protected ResourceSet resourceSet = editingDomain.getResourceSet();

                    /*
                     * (non-Javadoc)
                     * @see org.eclipse.core.resources.IResourceDeltaVisitor#visit(org.eclipse.core.resources.IResourceDelta)
                     */
                    public boolean visit(IResourceDelta delta) {
                        IResource changedResource = delta.getResource();
                        if (changedResource.getType() == IResource.FILE) {
                            String fileExtension = changedResource.getFileExtension();
                            if ("xma".equals(fileExtension)) {
                                visitXMAFile(delta);
                            }
                        }
                        return true;
                    }

                    /*
                     * Visit a changed resource which is a XMA-File
                     */
                    public boolean visitXMAFile(IResourceDelta delta) {

                        Resource resource = null;
                        boolean hasBeenChanged = false;
                        boolean hasBeenRemoved = false;

                        // determine
                        if ((delta.getKind() & (IResourceDelta.CHANGED | IResourceDelta.REMOVED)) != 0) {
                            resource = resourceSet.getResource(URI.createURI(delta.getFullPath().toString()),
                                    false);
                            if (resource != null) {
                                if ((delta.getKind() & IResourceDelta.REMOVED) != 0) {
                                    hasBeenRemoved = true;
                                } else {
                                    hasBeenChanged = true;
                                }
                            }
                        }
                        final Resource removedResource = hasBeenRemoved ? resource : null;
                        final Resource changedResource = hasBeenChanged ? resource : null;

                        // handle                                                           
                        getSite().getShell().getDisplay().asyncExec(new Runnable() {
                            public void run() {
                                if (changedResource != null) {
                                    handleChangedResources(changedResource);
                                }
                                if (removedResource != null && !isDirty()) {
                                    getSite().getShell().getDisplay().asyncExec(new Runnable() {
                                        public void run() {
                                            getSite().getPage().closeEditor(GuidesignEditor.this, false);
                                            GuidesignEditor.this.dispose();
                                        }
                                    });
                                }
                            }
                        });
                        return true;
                    }
                }

                ResourceDeltaVisitor visitor = new ResourceDeltaVisitor();
                delta.accept(visitor);
            } catch (CoreException exception) {
                GUIDesignerPlugin.INSTANCE.log(exception);
            }
        }
    };

    /**
     * Shows a dialog that asks if conflicting changes should be discarded.
     * @generated
     */
    protected boolean handleDirtyConflict() {
        // re-activated that for fleXMA refresh:
        boolean res = MessageDialog.openQuestion(getSite().getShell(), getString("_UI_FileConflict_label"),
                getString("_WARN_FileConflict"));
        return res;
    }

    /**
     * This creates a model editor.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public GuidesignEditor() {
        super();

        // Create an adapter factory that yields item providers.
        //
        List factories = new ArrayList();
        factories.add(new ResourceItemProviderAdapterFactory());
        factories.add(new GuidesignItemProviderAdapterFactory());
        factories.add(new TypesItemProviderAdapterFactory());

        adapterFactory = new ComposedAdapterFactory(factories);

        // Create the command stack that will notify this editor as commands are executed.
        //
        BasicCommandStack commandStack = new BasicCommandStack();

        // Add a listener to set the most recent command's affected objects to be the selection of the viewer with focus.
        //
        commandStack.addCommandStackListener(new CommandStackListener() {
            public void commandStackChanged(final EventObject event) {
                getContainer().getDisplay().asyncExec(new Runnable() {
                    public void run() {
                        //for debugging
                        debug("asyncExec in commandStackChanged: command stack changed");
                        firePropertyChange(IEditorPart.PROP_DIRTY);

                        // Try to select the affected objects.
                        //
                        Command mostRecentCommand = ((CommandStack) event.getSource()).getMostRecentCommand();
                        if (mostRecentCommand != null) {
                            //setSelectionToViewer(mostRecentCommand.getAffectedObjects());
                            final Collection theSelection = mostRecentCommand.getAffectedObjects();
                            // Try to select the items in the current content viewer of the editor.
                            //for debugging
                            debug("asyncExec in commandStackChanged: selection changed");
                            if (currentViewer != null) {
                                currentViewer.setSelection(new StructuredSelection(theSelection.toArray()), true);
                            }
                        }
                    }
                });
            }
        });

        // Create the editing domain with a special command stack.
        //
        //TODO Prio 3: global Clipboard: override the setClipboard/getClipboard methods of AdapterFactoryEditingDomain
        editingDomain = new AdapterFactoryEditingDomain(adapterFactory, commandStack);

    }

    /**
     * This is here for the listener to be able to call it.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected void firePropertyChange(int action) {
        super.firePropertyChange(action);
        //for debugging only
        debug("fire PropertyChange called with action " + action);
    }

    /**
     * This returns the editing domain as required by the {@link IEditingDomainProvider} interface.
     * This is important for implementing the static methods of {@link AdapterFactoryEditingDomain}
     * and for supporting {@link org.eclipse.emf.edit.ui.action.CommandAction}.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public EditingDomain getEditingDomain() {
        return editingDomain;
    }

    /**
     *
     * @return the resource file handle of the active editor
     */
    public IFile getResourceFile() {
        return file;
    }

    /**
     *
     * @return the XMAComponent that is edited at time
     */
    public XMAComponent getComponent() {
        return component;
    }

    /**
     * <!-- begin-user-doc -->
     * TODO Prio 0: maybe not used
     * <!-- end-user-doc -->
     * @generated
     */
    public class ReverseAdapterFactoryContentProvider extends AdapterFactoryContentProvider {
        public ReverseAdapterFactoryContentProvider(AdapterFactory adapterFactory) {
            super(adapterFactory);
        }

        public Object[] getElements(Object object) {
            Object parent = super.getParent(object);
            return (parent == null ? Collections.EMPTY_SET : Collections.singleton(parent)).toArray();
        }

        public Object[] getChildren(Object object) {
            Object parent = super.getParent(object);
            return (parent == null ? Collections.EMPTY_SET : Collections.singleton(parent)).toArray();
        }

        public boolean hasChildren(Object object) {
            Object parent = super.getParent(object);
            return parent != null;
        }

        public Object getParent(Object object) {
            return null;
        }
    }

    /**
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public void setCurrentViewerPane(ViewerPane viewerPane) {
        //for debugging only
        debug("call to setCurrentViewerPane=" + viewerPane);
        if (currentViewerPane != null) {
            currentViewerPane.showFocus(false);
            setCurrentViewer(currentViewerPane.getViewer());
        }
        currentViewerPane = viewerPane;
    }

    /**
     * This makes sure that one content viewer, either for the current page or the outline view,
     * if it has focus, is the current one.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @modified!!!
     */
    public void setCurrentViewer(Viewer viewer) {
        //for debugging only
        debug("call to setCurrentViewer=" + viewer);
        // If it is changing...
        //
        if (currentViewer != viewer) {
            if (selectionChangedListener != null) {
                // Stop listening to the old one.
                if (currentViewer != null) {
                    currentViewer.removeSelectionChangedListener(selectionChangedListener);
                }
            } else {
                // Create the listener on demand.
                selectionChangedListener = new ISelectionChangedListener() {
                    // This just notifies those things that are affected by the section.
                    public void selectionChanged(SelectionChangedEvent selectionChangedEvent) {
                        debug("selectionChanged in setCurrentViewer(): " + "Eventsource: "
                                + selectionChangedEvent.getSource() + " Selection: "
                                + selectionChangedEvent.getSelection());
                        setSelection(selectionChangedEvent.getSelection());
                    }
                };
            }

            // Start listening to the new one.
            if (viewer != null) {
                viewer.addSelectionChangedListener(selectionChangedListener);
            }

            // Remember it.
            currentViewer = viewer;
            currentViewer.setSelection(getSelection());
        }
    }

    /**
     * This creates a context menu for the viewer and adds a listener as well registering the menu for extension.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected void createContextMenuFor(StructuredViewer viewer) {
        MenuManager contextMenu = new MenuManager("#PopUp");
        contextMenu.add(new Separator("additions"));
        contextMenu.setRemoveAllWhenShown(true);
        contextMenu.addMenuListener(this);
        Menu menu = contextMenu.createContextMenu(viewer.getControl());
        viewer.getControl().setMenu(menu);
        getSite().registerContextMenu(contextMenu, viewer);

        int dndOperations = DND.DROP_COPY | DND.DROP_MOVE | DND.DROP_LINK;
        Transfer[] transfers = new Transfer[] { LocalTransfer.getInstance() };
        viewer.addDragSupport(dndOperations, transfers, new ViewerDragAdapter(viewer));
        viewer.addDropSupport(dndOperations, transfers, new EditingDomainViewerDropAdapter(editingDomain, viewer));
    }

    /**
     * This is the method used by the framework to install your own controls.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @modified
     */
    public void createPages() {
        // I assume that the input is a file object.
        IFileEditorInput modelFile = (IFileEditorInput) getEditorInput();

        try {
            file = modelFile.getFile();
            // Load the resource through the editing domain.
            editingDomain.loadResource(URI.createPlatformResourceURI(file.getFullPath().toString()).toString());
        } catch (Exception exception) {
            GUIDesignerPlugin.INSTANCE.log(exception);
        }

        // remember the component
        Resource res = (Resource) editingDomain.getResourceSet().getResources().get(0);
        // could be changed outside meanwhile...
        if (res.isLoaded()) {
            res.unload();
        }
        try {
            res.load(Collections.EMPTY_MAP);
        } catch (IOException exception) {
            GUIDesignerPlugin.INSTANCE.log(exception);
        }
        component = (XMAComponent) res.getContents().get(0);

        // This is the page for the graphical viewer
        graphViewerPane = new ViewerPane(getSite().getPage(), GuidesignEditor.this) {
            public Viewer createViewer(Composite composite) {
                return new UIPreviewer(composite, GuidesignEditor.this);
            }

            public void requestActivation() {
                if (currentViewerPane != this) {
                    debug("vor requestActivation() in createPages");
                    super.requestActivation();
                }
            }
        };
        graphViewerPane.createControl(getContainer());
        graphViewer = (UIPreviewer) graphViewerPane.getViewer();
        graphViewer.setContentProvider(new AdapterFactoryContentProvider(adapterFactory));
        graphViewer.setLabelProvider(new AdapterFactoryLabelProvider(adapterFactory));

        int pageIndex = addPage(graphViewerPane.getControl());
        setPageText(pageIndex, getString("_UI_GraphicalPage_label"));

        setActivePage(0);
        getContainer().addControlListener(new ControlAdapter() {
            boolean guard = false;

            public void controlResized(ControlEvent event) {
                if (!guard) {
                    guard = true;
                    hideTabs();
                    guard = false;
                }
            }
        });

        // set the input of the graphical viewer
        graphViewer.setInput(res);
    }

    /**
     * If there is just one page in the multi-page editor part, this hides
     * the single tab at the bottom.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected void hideTabs() {
        if (getPageCount() <= 1) {
            setPageText(0, "");
            ((org.eclipse.swt.custom.CTabFolder) getContainer()).setTabHeight(1);
            Point point = getContainer().getSize();
            getContainer().setSize(point.x, point.y + 2);
        }
    }

    /**
     * This is used to track the active viewer.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    protected void pageChange(int pageIndex) {
        super.pageChange(pageIndex);

        // This is a temporary workaround... EATM
        //
        Control control = (Control) getControl(pageIndex);
        if (control != null) {
            control.setVisible(true);
            control.setFocus();
        }

        handleContentOutlineSelection(getContentOutlinePage().getSelection());
    }

    /**
     * This is how the framework determines which interfaces we implement.
     * <!-- begin-user-doc -->
     *
     * <!-- end-user-doc -->
     * @generated
     */
    public Object getAdapter(Class key) {
        if (key.equals(IContentOutlinePage.class)) {
            return getContentOutlinePage();
        } else if (key.equals(IPropertySheetPage.class)) {
            return getPropertySheetPage();
        } else {
            return super.getAdapter(key);
        }
    }

    /**
     * This accesses a cached version of the content outliner.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public IContentOutlinePage getContentOutlinePage() {
        if (contentOutlinePage == null) {
            // The content outline is just a tree.
            //
            class MyContentOutlinePage extends ContentOutlinePage {
                public void createControl(Composite parent) {
                    super.createControl(parent);
                    contentOutlineViewer = getTreeViewer();
                    contentOutlineViewer.addSelectionChangedListener(this);

                    // Set up the tree viewer.
                    //
                    contentOutlineViewer.setContentProvider(new AdapterFactoryContentProvider(adapterFactory));
                    contentOutlineViewer.setLabelProvider(new AdapterFactoryLabelProvider(adapterFactory));
                    contentOutlineViewer.setInput(editingDomain.getResourceSet());
                    contentOutlineViewer.addFilter(new ContentOutlineFilter());

                    // Make sure our popups work.
                    //
                    createContextMenuFor(contentOutlineViewer);
                }

                public void makeContributions(IMenuManager menuManager, IToolBarManager toolBarManager,
                        IStatusLineManager statusLineManager) {
                    super.makeContributions(menuManager, toolBarManager, statusLineManager);
                    contentOutlineStatusLineManager = statusLineManager;
                }

            }

            contentOutlinePage = new MyContentOutlinePage();

            // Init the new OutlinePage with the current selection of the editor 
            contentOutlinePage.setSelection(getSelection());

            // The OutlinePage listens to selection changes of the editor
            addSelectionChangedListener((ISelectionChangedListener) contentOutlinePage);

            // Listen to selection changes of the OutlinePage so that we can handle it is a special way.
            contentOutlinePage.addSelectionChangedListener(new ISelectionChangedListener() {
                // This ensures that we handle selections correctly.
                public void selectionChanged(SelectionChangedEvent event) {
                    handleContentOutlineSelection(event.getSelection());
                }
            });
        }

        return contentOutlinePage;
    }

    /**
     * This accesses a cached version of the property sheet.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @modified
     */
    public IPropertySheetPage getPropertySheetPage() {
        if (propertySheetPage == null) {
            propertySheetPage = new PropertySheetPage() {
                public void makeContributions(IMenuManager menuManager, IToolBarManager toolBarManager,
                        IStatusLineManager statusLineManager) {
                    super.makeContributions(menuManager, toolBarManager, statusLineManager);
                }

                public void handleEntrySelection(ISelection selection) {
                    super.handleEntrySelection(selection);
                }
            };
            propertySheetPage.setPropertySourceProvider(new XMAAdapterFactoryContentProvider(this));
        }

        return propertySheetPage;
    }

    /**
     * This deals with how we want selection in the outliner to affect the other views.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @modified
     */
    public void handleContentOutlineSelection(ISelection selection) {
        if (currentViewerPane != null && !selection.isEmpty() && selection instanceof IStructuredSelection) {
            Iterator selectedElements = ((IStructuredSelection) selection).iterator();
            if (selectedElements.hasNext()) {
                // Get the first selected element.
                Object selectedElement = selectedElements.next();
                // Set the input to the widget.
                if (currentViewerPane.getViewer().getInput() != selectedElement) {
                    debug("Outline Selection set input: " + selectedElement);
                    // Try to collect information about a bug that sometimes seems to occur
                    // This bug invokes the following assert: 
                    // org.eclipse.core.runtime.AssertionFailedException: assertion failed: ContentViewer must have a content provider  
                    // The assert is located in: org.eclipse.jface.viewers.ContentViewer.setInput(ContentViewer.java:266)
                    // TODO find and fix this bug
                    if (currentViewerPane.getViewer() instanceof ContentViewer) {
                        ContentViewer contentViewer = (ContentViewer) currentViewerPane.getViewer();
                        if (contentViewer.getContentProvider() == null) {
                            RuntimeException ex = new RuntimeException(
                                    "The provider of the viewer of the currentViewerPane is null.");
                            GUIDesignerPlugin.INSTANCE.log("selection = " + selection);
                            GUIDesignerPlugin.INSTANCE.log("selectedElement = " + selectedElement);
                            GUIDesignerPlugin.INSTANCE.log("currentViewerPane = " + currentViewerPane);
                            GUIDesignerPlugin.INSTANCE.log("contentViewer class = " + contentViewer.getClass());
                            GUIDesignerPlugin.INSTANCE.log(ex);
                            throw ex;
                        }
                    }
                    currentViewerPane.getViewer().setInput(selectedElement);
                    currentViewerPane.setTitle(selectedElement);
                }
                // If it's the graphviewer, then we want it to select the same selection as this selection.
                if (currentViewerPane.getViewer() == graphViewer) {
                    // Set the selection to the widget.
                    graphViewer.setSelection((StructuredSelection) selection, true);
                }
            }
        }
    }

    /**
     * Sets the selection of the outlinePage.
     * @param selection
     * @modified
     */
    public void setContentOutlineSelection(ISelection selection) {
        if (contentOutlinePage != null) {
            contentOutlinePage.setSelection(selection);
        }
    }

    /**
     * <!-- begin-user-doc -->
     * This is for implementing {@link IEditorPart} and simply tests if there are some model chnages.
     * <!-- end-user-doc -->
     * @modified
     */
    public boolean isDirty() {
        return (dirty || ((BasicCommandStack) editingDomain.getCommandStack()).isSaveNeeded());
    }

    /**
     * Marks that the underlying model of the editor has unsaved changes.
     * TODO Prio x: GuiDesigner.markDirty() is not used
     * @modified
     */
    public void markDirty() {
        dirty = true;
        firePropertyChange(IEditorPart.PROP_DIRTY);
    }

    /**
     * This is for implementing {@link IEditorPart} and simply saves the model file.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @modified
     */
    public void doSave(IProgressMonitor progressMonitor) {
        // Do the work within an operation because this is a long running activity that modifies the workbench.
        WorkspaceModifyOperation operation = new WorkspaceModifyOperation() {
            // This is the method that gets invoked when the operation runs.
            protected void execute(IProgressMonitor monitor) throws CoreException {
                try {
                    //check validty of the resource and save  it to the file system.
                    GuidesignEditor.this.checkEObjectValidty(monitor);

                    Resource savedResource = (Resource) editingDomain.getResourceSet().getResources().get(0);
                    ((XMIResourceImpl) savedResource).setEncoding("UTF-8");
                    savedResource.save(Collections.EMPTY_MAP);
                } catch (Exception exception) {
                    GUIDesignerPlugin.INSTANCE.log(exception);
                }
            }
        };

        // removing the resource listener temporally to avoid notification on our own change
        ResourcesPlugin.getWorkspace().removeResourceChangeListener(resourceChangeListener);

        try {
            // This runs the options, and shows progress.
            // (It appears to be a bad thing to fork this onto another thread.)
            new ProgressMonitorDialog(getSite().getShell()).run(false, false, operation);

            // Refresh the necessary state.
            ((BasicCommandStack) editingDomain.getCommandStack()).saveIsDone();
            dirty = false;
            firePropertyChange(IEditorPart.PROP_DIRTY);
        } catch (Exception exception) {
            // Something went wrong that shouldn't.
            GUIDesignerPlugin.INSTANCE.log(exception);
        } finally {
            // add the resource listener again
            ResourcesPlugin.getWorkspace().addResourceChangeListener(resourceChangeListener,
                    IResourceChangeEvent.POST_CHANGE);
        }
    }

    /**
     *
     * @param monitor 
     * @return true, if the owner object of the properties is valid to generate
     */
    private void checkEObjectValidty(IProgressMonitor monitor) throws CoreException {
        ValidationAndGenerationExecutor.validate(getResourceFile(), component, monitor);
    }

    /**
     * This always returns true because it is not currently supported.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public boolean isSaveAsAllowed() {
        return true;
    }

    /**
     * This also changes the editor's input.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public void doSaveAs() {
        SaveAsDialog saveAsDialog = new SaveAsDialog(getSite().getShell());
        saveAsDialog.open();
        IPath path = saveAsDialog.getResult();
        if (path != null) {
            IFile file = ResourcesPlugin.getWorkspace().getRoot().getFile(path);
            if (file != null) {
                if (!file.exists() || MessageDialog.openQuestion(getSite().getShell(),
                        getString("_UI_FileExists_label"), getString("_WARN_FileExists", file.getName()))) {
                    ((Resource) editingDomain.getResourceSet().getResources().get(0))
                            .setURI(URI.createPlatformResourceURI(file.getFullPath().toString()));
                    IFileEditorInput modelFile = new FileEditorInput(file);
                    setInput(modelFile);
                    setPartName(file.getName());
                    doSave(getActionBars().getStatusLineManager().getProgressMonitor());
                }
            }
        }
    }

    /**
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @modified
     */
    public void gotoMarker(IMarker marker) {
        Object obj = null;
        try {
            obj = getComponent().findObjectOfMarker(new Long(marker.getId()));
        } catch (Exception e) {
            GUIDesignerPlugin.INSTANCE.log(e);
        }

        if (obj != null) {
            ISelection selection = new StructuredSelection(obj);
            setSelection(selection);
            setContentOutlineSelection(selection);
        }
    }

    /**
     * This is called during startup.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public void init(IEditorSite site, IEditorInput editorInput) throws PartInitException {
        if (editorInput instanceof IFileEditorInput) {
            setSite(site);
            setInput(editorInput);
            setPartName(((IFileEditorInput) editorInput).getFile().getName());
            site.setSelectionProvider(this);
            site.getPage().addPartListener(partListener);
            ResourcesPlugin.getWorkspace().addResourceChangeListener(resourceChangeListener,
                    IResourceChangeEvent.POST_CHANGE);
        } else {
            throw new PartInitException("Invalid Input: Must be IFileEditorInput.");
        }
    }

    /**
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public void setFocus() {
        getControl(getActivePage()).setFocus();
    }

    /**
     * This implements {@link org.eclipse.jface.viewers.ISelectionProvider}.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public void addSelectionChangedListener(ISelectionChangedListener listener) {
        selectionChangedListeners.add(listener);
    }

    /**
     * This implements {@link org.eclipse.jface.viewers.ISelectionProvider}.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public void removeSelectionChangedListener(ISelectionChangedListener listener) {
        selectionChangedListeners.remove(listener);
    }

    /**
     * This implements {@link org.eclipse.jface.viewers.ISelectionProvider} to return this editor's overall selection.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public ISelection getSelection() {
        if (editorSelection == null) {
            return StructuredSelection.EMPTY;
        } else {
            return editorSelection;
        }
    }

    /**
     * This implements {@link org.eclipse.jface.viewers.ISelectionProvider} to set this editor's overall selection.
     * Calling this result will notify the listeners.
     * @param selection current selection in the editor
     *        maybe null in case of creating a new component by the wizzard
     * @modified
     */
    public void setSelection(ISelection selection) {
        if (selection != null) {
            editorSelection = selection;
            List list = Collections.synchronizedList((List) selectionChangedListeners);
            //synchronize the notification because some property changes may alter the list
            synchronized (list) {
                for (Iterator listeners = list.iterator(); listeners.hasNext();) {
                    ISelectionChangedListener listener = (ISelectionChangedListener) listeners.next();
                    listener.selectionChanged(new SelectionChangedEvent(this, selection));
                }
            }
            setStatusLineManager(selection);
        }
    }

    /**
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public void setStatusLineManager(ISelection selection) {
        IStatusLineManager statusLineManager = getActionBars().getStatusLineManager();
        if (currentViewer == contentOutlineViewer) {
            statusLineManager = contentOutlineStatusLineManager;
        }
        // to avoid a NullPointerException
        if (statusLineManager == null)
            return;

        if (selection instanceof IStructuredSelection) {
            Collection collection = ((IStructuredSelection) selection).toList();
            switch (collection.size()) {
            case 0: {
                statusLineManager.setMessage(getString("_UI_NoObjectSelected"));
                break;
            }
            case 1: {
                String text = new AdapterFactoryItemDelegator(adapterFactory).getText(collection.iterator().next());
                statusLineManager.setMessage(getString("_UI_SingleObjectSelected", text));
                break;
            }
            default: {
                statusLineManager
                        .setMessage(getString("_UI_MultiObjectSelected", Integer.toString(collection.size())));
                break;
            }
            }
        } else {
            statusLineManager.setMessage("");
        }
    }

    /**
     * This looks up a string in the plugin's plugin.properties file.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    private static String getString(String key) {
        return GUIDesignerPlugin.INSTANCE.getString(key);
    }

    /**
     * This looks up a string in plugin.properties, making a substitution.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    private static String getString(String key, Object s1) {
        return GUIDesignerPlugin.INSTANCE.getString(key, new Object[] { s1 });
    }

    /**
     * This implements {@link org.eclipse.jface.action.IMenuListener} to help fill the context menus with contributions from the Edit menu.
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public void menuAboutToShow(IMenuManager menuManager) {
        ((IMenuListener) getEditorSite().getActionBarContributor()).menuAboutToShow(menuManager);
    }

    /**
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public EditingDomainActionBarContributor getActionBarContributor() {
        return (EditingDomainActionBarContributor) getEditorSite().getActionBarContributor();
    }

    /**
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public IActionBars getActionBars() {
        return getActionBarContributor().getActionBars();
    }

    /**
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public AdapterFactory getAdapterFactory() {
        return adapterFactory;
    }

    /**
     * <!-- begin-user-doc -->
     * <!-- end-user-doc -->
     * @generated
     */
    public void dispose() {
        ResourcesPlugin.getWorkspace().removeResourceChangeListener(resourceChangeListener);
        getSite().getPage().removePartListener(partListener);
        adapterFactory.dispose();
        getActionBarContributor().setActiveEditor(null);
        if (propertySheetPage != null) {
            propertySheetPage.dispose();
        }
        if (contentOutlinePage != null) {
            contentOutlinePage.dispose();
        }
        super.dispose();
    }

    /**
     * suspends refreshing the Previewer
     *
     */
    public void suspendPreViewRefresh() {
        if (graphViewer != null) {
            graphViewer.suspendRefresh();
        }
    }

    /**
     * suspends refreshing the Previewer
     *
     */
    public void resumePreViewRefresh() {
        if (graphViewer != null) {
            graphViewer.resumeRefresh();
        }
    }

    /* (non-Javadoc)
     * @see org.eclipse.ui.part.MultiPageEditorPart#getContainer()
     */
    public Composite getContainer() {
        //visibility changed from protected to public
        return super.getContainer();
    }

}