| /******************************************************************************* |
| * Copyright (c) 2004, 2007 Boeing. |
| * 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: |
| * Boeing - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.osee.ats.workflow.editor; |
| |
| import java.util.Arrays; |
| import java.util.EventObject; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Set; |
| import org.eclipse.core.runtime.IProgressMonitor; |
| import org.eclipse.draw2d.geometry.Point; |
| import org.eclipse.gef.ContextMenuProvider; |
| import org.eclipse.gef.DefaultEditDomain; |
| import org.eclipse.gef.EditPartViewer; |
| import org.eclipse.gef.GraphicalViewer; |
| import org.eclipse.gef.dnd.TemplateTransferDragSourceListener; |
| import org.eclipse.gef.dnd.TemplateTransferDropTargetListener; |
| import org.eclipse.gef.editparts.ScalableFreeformRootEditPart; |
| import org.eclipse.gef.palette.PaletteRoot; |
| import org.eclipse.gef.requests.CreationFactory; |
| import org.eclipse.gef.requests.SimpleFactory; |
| import org.eclipse.gef.ui.actions.ActionRegistry; |
| import org.eclipse.gef.ui.palette.PaletteViewer; |
| import org.eclipse.gef.ui.palette.PaletteViewerProvider; |
| import org.eclipse.gef.ui.parts.ContentOutlinePage; |
| import org.eclipse.gef.ui.parts.GraphicalEditorWithFlyoutPalette; |
| import org.eclipse.gef.ui.parts.GraphicalViewerKeyHandler; |
| import org.eclipse.gef.ui.parts.TreeViewer; |
| import org.eclipse.jface.action.IAction; |
| import org.eclipse.jface.util.TransferDropTargetListener; |
| import org.eclipse.osee.ats.help.ui.AtsHelpContext; |
| import org.eclipse.osee.ats.internal.AtsPlugin; |
| import org.eclipse.osee.ats.util.AtsUtil; |
| import org.eclipse.osee.ats.workdef.StateDefinition; |
| import org.eclipse.osee.ats.workdef.StateXWidgetPage; |
| import org.eclipse.osee.ats.workdef.WorkDefinition; |
| import org.eclipse.osee.ats.workflow.ATSXWidgetOptionResolver; |
| import org.eclipse.osee.ats.workflow.editor.actions.EditAction; |
| import org.eclipse.osee.ats.workflow.editor.model.CancelledWorkPageShape; |
| import org.eclipse.osee.ats.workflow.editor.model.CompletedWorkPageShape; |
| import org.eclipse.osee.ats.workflow.editor.model.DefaultTransitionConnection; |
| import org.eclipse.osee.ats.workflow.editor.model.TransitionConnection; |
| import org.eclipse.osee.ats.workflow.editor.model.WorkPageShape; |
| import org.eclipse.osee.ats.workflow.editor.model.WorkflowDiagram; |
| import org.eclipse.osee.ats.workflow.editor.parts.ShapesEditPartFactory; |
| import org.eclipse.osee.ats.workflow.editor.parts.ShapesTreeEditPartFactory; |
| import org.eclipse.osee.framework.core.enums.CoreArtifactTypes; |
| import org.eclipse.osee.framework.core.exception.OseeArgumentException; |
| import org.eclipse.osee.framework.core.exception.OseeCoreException; |
| import org.eclipse.osee.framework.logging.OseeLevel; |
| import org.eclipse.osee.framework.logging.OseeLog; |
| import org.eclipse.osee.framework.skynet.core.artifact.Artifact; |
| import org.eclipse.osee.framework.skynet.core.event.OseeEventManager; |
| import org.eclipse.osee.framework.skynet.core.event.filter.IEventFilter; |
| import org.eclipse.osee.framework.skynet.core.event.listener.IArtifactEventListener; |
| import org.eclipse.osee.framework.skynet.core.event.model.ArtifactEvent; |
| import org.eclipse.osee.framework.skynet.core.event.model.EventModType; |
| import org.eclipse.osee.framework.skynet.core.event.model.Sender; |
| import org.eclipse.osee.framework.skynet.core.transaction.SkynetTransaction; |
| import org.eclipse.osee.framework.ui.plugin.util.AWorkbench; |
| import org.eclipse.osee.framework.ui.plugin.util.HelpUtil; |
| import org.eclipse.osee.framework.ui.plugin.util.Result; |
| import org.eclipse.osee.framework.ui.swt.Displays; |
| import org.eclipse.swt.widgets.Composite; |
| import org.eclipse.swt.widgets.Control; |
| import org.eclipse.ui.IActionBars; |
| import org.eclipse.ui.IEditorInput; |
| import org.eclipse.ui.IEditorPart; |
| import org.eclipse.ui.actions.ActionFactory; |
| import org.eclipse.ui.part.IPageSite; |
| import org.eclipse.ui.views.contentoutline.IContentOutlinePage; |
| |
| /** |
| * A graphical editor for the configuration of ATS workflows<br> |
| * |
| * @author Donald G. Dunne |
| */ |
| public class AtsWorkflowConfigEditor extends GraphicalEditorWithFlyoutPalette implements IArtifactEventListener { |
| |
| /** This is the root of the editor's model. */ |
| private WorkflowDiagram diagram; |
| /** Palette component, holding the tools and shapes. */ |
| private final PaletteRoot palletteModel; |
| public final static String EDITOR_ID = "org.eclipse.osee.ats.workflow.editor.AtsWorkflowConfigEditor"; |
| |
| /** Create a new ShapesEditor instance. This is called by the Workspace. */ |
| public AtsWorkflowConfigEditor() { |
| setEditDomain(new DefaultEditDomain(this)); |
| OseeEventManager.addListener(this); |
| palletteModel = AtsWorkflowConfigEditorPaletteFactory.createPalette(this); |
| } |
| |
| /** |
| * Configure the graphical viewer before it receives contents. |
| * <p> |
| * This is the place to choose an appropriate RootEditPart and EditPartFactory for your editor. The RootEditPart |
| * determines the behavior of the editor's "work-area". For example, GEF includes zoomable and scrollable root edit |
| * parts. The EditPartFactory maps model elements to edit parts (controllers). |
| * </p> |
| * |
| * @see org.eclipse.gef.ui.parts.GraphicalEditor#configureGraphicalViewer() |
| */ |
| @Override |
| protected void configureGraphicalViewer() { |
| super.configureGraphicalViewer(); |
| |
| GraphicalViewer viewer = getGraphicalViewer(); |
| viewer.setEditPartFactory(new ShapesEditPartFactory()); |
| viewer.setRootEditPart(new ScalableFreeformRootEditPart()); |
| viewer.setKeyHandler(new GraphicalViewerKeyHandler(viewer)); |
| |
| // configure the context menu provider |
| ContextMenuProvider cmProvider = new AtsWorkflowConfigEditorContextMenuProvider(viewer, getActionRegistry()); |
| viewer.setContextMenu(cmProvider); |
| getSite().registerContextMenu(cmProvider, viewer); |
| HelpUtil.setHelp(viewer.getControl(), AtsHelpContext.CONFIGURE_WORKFLOW); |
| |
| } |
| |
| @Override |
| public void commandStackChanged(EventObject event) { |
| firePropertyChange(IEditorPart.PROP_DIRTY); |
| super.commandStackChanged(event); |
| } |
| |
| @Override |
| protected PaletteViewerProvider createPaletteViewerProvider() { |
| return new PaletteViewerProvider(getEditDomain()) { |
| @Override |
| protected void configurePaletteViewer(PaletteViewer viewer) { |
| super.configurePaletteViewer(viewer); |
| // create a drag source listener for this palette viewer |
| // together with an appropriate transfer drop target listener, this will enable |
| // model element creation by dragging a CombinatedTemplateCreationEntries |
| // from the palette into the editor |
| // @see ShapesEditor#createTransferDropTargetListener() |
| viewer.addDragSourceListener(new TemplateTransferDragSourceListener(viewer)); |
| } |
| }; |
| } |
| |
| /** |
| * Create a transfer drop target listener. When using a CombinedTemplateCreationEntry tool in the palette, this will |
| * enable model element creation by dragging from the palette. |
| * |
| * @see #createPaletteViewerProvider() |
| */ |
| private TransferDropTargetListener createTransferDropTargetListener() { |
| return new TemplateTransferDropTargetListener(getGraphicalViewer()) { |
| @Override |
| protected CreationFactory getFactory(Object template) { |
| return new SimpleFactory((Class<?>) template); |
| } |
| }; |
| } |
| |
| @Override |
| public void doSave(IProgressMonitor monitor) { |
| try { |
| SkynetTransaction transaction = new SkynetTransaction(AtsUtil.getAtsBranch(), "ATS Configuration Editor Save"); |
| Result result = diagram.doSave(transaction); |
| if (result.isFalse()) { |
| AWorkbench.popup("Save Error", result.getText()); |
| return; |
| } |
| transaction.execute(); |
| // diagram.getWorkFlowDefinition().loadPageData(true); |
| getCommandStack().markSaveLocation(); |
| |
| } catch (OseeCoreException ex) { |
| OseeLog.log(AtsPlugin.class, OseeLevel.SEVERE_POPUP, ex); |
| } |
| } |
| |
| @Override |
| public void doSaveAs() { |
| AWorkbench.popup("ERROR", "Not implemented yet"); |
| } |
| |
| @SuppressWarnings("rawtypes") |
| @Override |
| public Object getAdapter(Class type) { |
| if (type == IContentOutlinePage.class) { |
| return new ShapesOutlinePage(new TreeViewer()); |
| } |
| return super.getAdapter(type); |
| } |
| |
| WorkflowDiagram getModel() { |
| return diagram; |
| } |
| |
| @Override |
| protected PaletteRoot getPaletteRoot() { |
| return palletteModel; |
| } |
| |
| /** |
| * Set up the editor's inital content (after creation). |
| * |
| * @see org.eclipse.gef.ui.parts.GraphicalEditorWithFlyoutPalette#initializeGraphicalViewer() |
| */ |
| @Override |
| protected void initializeGraphicalViewer() { |
| super.initializeGraphicalViewer(); |
| GraphicalViewer viewer = getGraphicalViewer(); |
| viewer.setContents(getModel()); // set the contents of this editor |
| |
| // listen for dropped parts |
| viewer.addDropTargetListener(createTransferDropTargetListener()); |
| createActions(); |
| } |
| |
| @SuppressWarnings("unchecked") |
| @Override |
| protected void createActions() { |
| super.createActions(); |
| ActionRegistry registry = getActionRegistry(); |
| IAction action; |
| |
| action = new EditAction(); |
| registry.registerAction(action); |
| getStackActions().add(action.getId()); |
| } |
| |
| @Override |
| public boolean isSaveAsAllowed() { |
| return true; |
| } |
| |
| @Override |
| protected void setInput(IEditorInput input) { |
| super.setInput(input); |
| if (input instanceof AtsWorkflowConfigEditorInput) { |
| AtsWorkflowConfigEditorInput editorInput = (AtsWorkflowConfigEditorInput) input; |
| WorkDefinition workflowDef = editorInput.workflow; |
| try { |
| setPartName(workflowDef.getName()); |
| diagram = new WorkflowDiagram(workflowDef); |
| int yLoc = 0; |
| StateDefinition startPage = workflowDef.getStartState(); |
| if (startPage == null || startPage.getName().equals("")) { |
| throw new OseeArgumentException("StartPage null for workflow [%s]", workflowDef); |
| } |
| // Create states |
| List<StateDefinition> pages = workflowDef.getStatesOrdered(); |
| for (StateDefinition page : workflowDef.getStates()) { |
| if (!pages.contains(page)) { |
| pages.add(page); |
| } |
| } |
| for (StateDefinition pageDef : pages) { |
| WorkPageShape pageShape = null; |
| if (pageDef.isCancelledPage()) { |
| pageShape = new CancelledWorkPageShape(pageDef); |
| pageShape.setLocation(new Point(250, 300)); |
| } else if (pageDef.isCompletedPage()) { |
| pageShape = new CompletedWorkPageShape(pageDef); |
| pageShape.setLocation(new Point(50, yLoc += 90)); |
| } else { |
| pageShape = new WorkPageShape(pageDef); |
| pageShape.setLocation(new Point(50, yLoc += 90)); |
| } |
| pageShape.setStartPage(startPage.getName().equals(pageShape.getId()) || pageShape.getId().endsWith( |
| startPage.getName())); |
| diagram.addChild(pageShape); |
| } |
| |
| // Create transitions |
| createTransitions(workflowDef); |
| } catch (OseeCoreException ex) { |
| OseeLog.log(AtsPlugin.class, OseeLevel.SEVERE_POPUP, ex); |
| } |
| |
| } else { |
| throw new IllegalStateException("Invalid editor input"); |
| } |
| |
| } |
| |
| @SuppressWarnings("unused") |
| private void createTransitions(WorkDefinition workflowDef) throws OseeCoreException { |
| for (StateDefinition workPageDefinition : workflowDef.getStatesOrdered()) { |
| WorkPageShape pageShape = getWorkPageShape(workPageDefinition); |
| StateXWidgetPage statePage = |
| new StateXWidgetPage(workflowDef, workPageDefinition, null, ATSXWidgetOptionResolver.getInstance()); |
| // Handle to pages |
| Set<StateDefinition> toPages = new HashSet<StateDefinition>(); |
| toPages.addAll(statePage.getToPages()); |
| for (StateDefinition toPageDef : toPages) { |
| WorkPageShape toPageShape = getWorkPageShape(toPageDef); |
| if (toPageDef.equals(statePage.getDefaultToPage())) { |
| new DefaultTransitionConnection(pageShape, toPageShape); |
| // System.out.println("Default: " + statePage.getName() + " -> " + toPageShape.getName()); |
| } else { |
| new TransitionConnection(pageShape, toPageShape); |
| // System.out.println("To: " + statePage.getName() + " -> " + toPageShape.getName()); |
| } |
| } |
| // Handle return pages |
| // for (StateDefinition toPageDef : returnPages) { |
| // WorkPageShape toPageShape = getWorkPageShape(toPageDef); |
| // new ReturnTransitionConnection(pageShape, toPageShape); |
| // // System.out.println("Return: " + statePage.getName() + " -> " + toPageShape.getName()); |
| // } |
| } |
| } |
| |
| private WorkPageShape getWorkPageShape(StateDefinition page) { |
| for (Object object : getModel().getChildren()) { |
| if (object instanceof WorkPageShape && (((WorkPageShape) object).getId().equals(page.getName()) || page.getName() != null && ((WorkPageShape) object).getId().equals( |
| page.getName()))) { |
| return (WorkPageShape) object; |
| } |
| } |
| return null; |
| } |
| /** |
| * Creates an outline pagebook for this editor. |
| */ |
| public class ShapesOutlinePage extends ContentOutlinePage { |
| /** |
| * Create a new outline page for the shapes editor. |
| * |
| * @param viewer a viewer (TreeViewer instance) used for this outline page |
| * @throws OseeArgumentException if editor is null |
| */ |
| public ShapesOutlinePage(EditPartViewer viewer) { |
| super(viewer); |
| } |
| |
| @Override |
| public void createControl(Composite parent) { |
| // create outline viewer page |
| getViewer().createControl(parent); |
| // configure outline viewer |
| getViewer().setEditDomain(getEditDomain()); |
| getViewer().setEditPartFactory(new ShapesTreeEditPartFactory()); |
| // configure & add context menu to viewer |
| ContextMenuProvider cmProvider = |
| new AtsWorkflowConfigEditorContextMenuProvider(getViewer(), getActionRegistry()); |
| getViewer().setContextMenu(cmProvider); |
| getSite().registerContextMenu("org.eclipse.osee.ats.config.editor.contextmenu", cmProvider, |
| getSite().getSelectionProvider()); |
| // hook outline viewer |
| getSelectionSynchronizer().addViewer(getViewer()); |
| // initialize outline viewer with model |
| getViewer().setContents(getModel()); |
| // show outline viewer |
| } |
| |
| @Override |
| public void dispose() { |
| // unhook outline viewer |
| getSelectionSynchronizer().removeViewer(getViewer()); |
| // dispose |
| super.dispose(); |
| } |
| |
| @Override |
| public Control getControl() { |
| return getViewer().getControl(); |
| } |
| |
| /** |
| * @see org.eclipse.ui.part.IPageBookViewPage#init(org.eclipse.ui.part.IPageSite) |
| */ |
| @Override |
| public void init(IPageSite pageSite) { |
| super.init(pageSite); |
| ActionRegistry registry = getActionRegistry(); |
| IActionBars bars = pageSite.getActionBars(); |
| String id = ActionFactory.UNDO.getId(); |
| bars.setGlobalActionHandler(id, registry.getAction(id)); |
| id = ActionFactory.REDO.getId(); |
| bars.setGlobalActionHandler(id, registry.getAction(id)); |
| id = ActionFactory.DELETE.getId(); |
| bars.setGlobalActionHandler(id, registry.getAction(id)); |
| } |
| } |
| |
| public void closeEditor() { |
| final IEditorPart editor = this; |
| Displays.ensureInDisplayThread(new Runnable() { |
| @Override |
| public void run() { |
| if (AWorkbench.getActivePage() != null) { |
| AWorkbench.getActivePage().closeEditor(editor, false); |
| } |
| } |
| }); |
| } |
| |
| @Override |
| public List<? extends IEventFilter> getEventFilters() { |
| return Arrays.asList(OseeEventManager.getCommonBranchFilter(), AtsUtil.getWorkItemArtifactTypeEventFilter()); |
| } |
| |
| @Override |
| public void handleArtifactEvent(ArtifactEvent artifactEvent, Sender sender) { |
| for (Artifact delArt : artifactEvent.getCacheArtifacts(EventModType.Deleted)) { |
| if (delArt.isOfType(CoreArtifactTypes.WorkFlowDefinition) && delArt.getName().equals(getPartName())) { |
| closeEditor(); |
| } |
| } |
| } |
| |
| } |
