/*******************************************************************************
* Copyright (c) 2011, 2012 Red Hat, Inc.
* All rights reserved.
* This program is 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:
* Red Hat, Inc. - initial API and implementation
*******************************************************************************/
package org.eclipse.bpmn2.modeler.ui.editor;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.bpmn2.BaseElement;
import org.eclipse.bpmn2.Bpmn2Package;
import org.eclipse.bpmn2.Choreography;
import org.eclipse.bpmn2.Collaboration;
import org.eclipse.bpmn2.Definitions;
import org.eclipse.bpmn2.FlowElement;
import org.eclipse.bpmn2.FlowElementsContainer;
import org.eclipse.bpmn2.Participant;
import org.eclipse.bpmn2.RootElement;
import org.eclipse.bpmn2.SubProcess;
import org.eclipse.bpmn2.di.BPMNDiagram;
import org.eclipse.bpmn2.di.BPMNPlane;
import org.eclipse.bpmn2.modeler.core.adapters.ExtendedPropertiesProvider;
import org.eclipse.bpmn2.modeler.core.di.DIUtils;
import org.eclipse.bpmn2.modeler.core.utils.BusinessObjectUtil;
import org.eclipse.bpmn2.modeler.core.utils.ModelUtil;
import org.eclipse.bpmn2.modeler.ui.Activator;
import org.eclipse.bpmn2.modeler.ui.util.PropertyUtil;
import org.eclipse.emf.common.command.Command;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.eclipse.emf.transaction.NotificationFilter;
import org.eclipse.emf.transaction.RecordingCommand;
import org.eclipse.emf.transaction.ResourceSetChangeEvent;
import org.eclipse.emf.transaction.ResourceSetListener;
import org.eclipse.emf.transaction.RollbackException;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.emf.transaction.util.TransactionUtil;
import org.eclipse.gef.ui.actions.ActionRegistry;
import org.eclipse.gef.ui.actions.WorkbenchPartAction;
import org.eclipse.graphiti.mm.pictograms.Diagram;
import org.eclipse.graphiti.mm.pictograms.PictogramElement;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabItem;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.TraverseEvent;
import org.eclipse.swt.events.TraverseListener;
import org.eclipse.swt.layout.FillLayout;
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.ui.IEditorInput;
import org.eclipse.ui.IWorkbenchPart;
public class DesignEditor extends BPMN2Editor {
protected ResourceSetListener resourceSetListener = null;
private BPMNDiagram bpmnDiagramDeleted = null;
// the container that holds the tabFolder
protected Composite container;
protected CTabFolder tabFolder;
private int defaultTabHeight;
public DesignEditor(BPMN2MultiPageEditor bpmn2MultiPageEditor, BPMN2MultiPageEditor mpe) {
super(mpe);
}
public void deleteBpmnDiagram(BPMNDiagram bpmnDiagram) {
this.bpmnDiagramDeleted = bpmnDiagram;
}
public void dispose() {
if (bpmnDiagramDeleted == null) {
getEditingDomain().removeResourceSetListener(resourceSetListener);
resourceSetListener = null;
super.dispose();
} else {
bpmnDiagramDeleted = null;
}
}
@Override
protected void setInput(IEditorInput input) {
super.setInput(input);
if (resourceSetListener == null) {
resourceSetListener = new AddRemoveDiagramListener();
getEditingDomain().addResourceSetListener(resourceSetListener);
}
}
@Override
protected void setPartName(String partName) {
// IEditorInput input = getEditorInput();
// if (input instanceof Bpmn2DiagramEditorInput) {
// URI uri = ((Bpmn2DiagramEditorInput)input).getModelUri();
// partName = URI.decode(uri.trimFileExtension().lastSegment());
// }
// else if (input instanceof DiagramEditorInput) {
// URI uri = ((DiagramEditorInput)input).getUri();
// partName = URI.decode(uri.trimFileExtension().lastSegment());
// }
super.setPartName(URI.decode(partName));
}
private boolean inSelectionChanged = false;
@Override
public void selectionChanged(final IWorkbenchPart part, final ISelection selection) {
// is the selected EObject in our resource?
if (!inSelectionChanged && part==multipageEditor) {
try {
inSelectionChanged = true;
EObject object = BusinessObjectUtil.getBusinessObjectForSelection(selection);
if (object!=null && object.eResource() == bpmnResource) {
BPMNDiagram newBpmnDiagram = null;
boolean showSelection = true;
if (object instanceof BaseElement) {
BaseElement baseElement = (BaseElement) object;
if (!DIUtils.isBPMNDiagramChild(getBpmnDiagram(), baseElement)) {
newBpmnDiagram = DIUtils.findBPMNDiagram(baseElement, true);
Object o = DIUtils.findBPMNDiagram(baseElement, false);
if (o==newBpmnDiagram)
showSelection = false;
}
}
else if (object instanceof BPMNDiagram) {
newBpmnDiagram = (BPMNDiagram)object;
showSelection = false;
}
if (newBpmnDiagram!=null && getBpmnDiagram() != newBpmnDiagram) {
multipageEditor.showDesignPage(newBpmnDiagram);
final BPMNDiagram d = newBpmnDiagram;
if (showSelection) {
Display.getDefault().asyncExec(new Runnable() {
public void run() {
showDesignPage(d);
Object sel = BusinessObjectUtil.getPictogramElementForSelection(selection);
if (sel instanceof PictogramElement)
DesignEditor.super.selectPictogramElements(new PictogramElement[] {(PictogramElement)sel});
}
});
}
}
}
DesignEditor.super.selectionChanged(part,selection);
} catch(Exception e) {
} finally {
inSelectionChanged = false;
}
}
}
public void pageChange(final BPMNDiagram bpmnDiagram) {
setBpmnDiagram(bpmnDiagram);
reloadTabs();
tabFolder.setSelection(0);
tabFolder.getItem(0).getControl().setVisible(true);
tabFolder.getItem(0).setData(bpmnDiagram);
updatePalette();
}
public void selectBpmnDiagram(BPMNDiagram bpmnDiagram) {
Diagram diagram = DIUtils.findDiagram(DesignEditor.this.getDiagramBehavior(), bpmnDiagram);
if (diagram != null) {
selectPictogramElements(new PictogramElement[] {(PictogramElement)diagram});
getDiagramBehavior().refreshContent();
}
}
public void showDesignPage(final BPMNDiagram bpmnDiagram) {
CTabItem current = tabFolder.getSelection();
if (current!=null && current.getData() == bpmnDiagram) {
current.getControl().setVisible(true);
return;
}
showDesignPageInternal(bpmnDiagram);
}
private void showDesignPageInternal(BPMNDiagram bpmnDiagram) {
for (CTabItem item : tabFolder.getItems()) {
if (item.getData() == bpmnDiagram) {
setBpmnDiagram(bpmnDiagram);
tabFolder.setSelection(item);
item.getControl().setVisible(true);
}
}
}
protected void addDesignPage(final BPMNDiagram bpmnDiagram) {
setBpmnDiagram( (BPMNDiagram)tabFolder.getItem(0).getData() );
reloadTabs();
showDesignPage(bpmnDiagram);
}
protected void removeDesignPage(final BPMNDiagram bpmnDiagram) {
CTabItem currentItem = tabFolder.getSelection();
BPMNDiagram currentBpmnDiagram = (BPMNDiagram)currentItem.getData();
setBpmnDiagram( (BPMNDiagram)tabFolder.getItem(0).getData() );
reloadTabs();
showDesignPage(currentBpmnDiagram);
}
private void reloadTabs() {
List<BPMNDiagram> bpmnDiagrams = new ArrayList<BPMNDiagram>();
BaseElement bpmnElement = bpmnDiagram.getPlane().getBpmnElement();
getSubDiagrams(bpmnElement, bpmnDiagrams);
tabFolder.setLayoutDeferred(true);
for (int i=tabFolder.getItemCount()-1; i>0; --i) {
tabFolder.getItem(i).setControl(null);
tabFolder.getItem(i).dispose();
}
if (bpmnDiagrams.size()>0) {
for (BPMNDiagram bd : bpmnDiagrams) {
CTabItem item = new CTabItem(tabFolder, SWT.NONE);
item.setControl(container);
BaseElement be = bd.getPlane().getBpmnElement();
item.setText(ExtendedPropertiesProvider.getTextValue(be));
item.setData(bd);
}
}
tabFolder.setLayoutDeferred(false);
Display.getDefault().asyncExec(new Runnable() {
public void run() {
updateTabs();
}
});
}
private void getSubDiagrams(BaseElement bpmnElement, List<BPMNDiagram> bpmnDiagrams) {
List<FlowElement> flowElements = null;
if (bpmnElement instanceof FlowElementsContainer) {
flowElements = ((FlowElementsContainer)bpmnElement).getFlowElements();
}
else if (bpmnElement instanceof Collaboration) {
flowElements = new ArrayList<FlowElement>();
for (Participant p : ((Collaboration)bpmnElement).getParticipants()) {
if (p.getProcessRef()!=null) {
flowElements.addAll(p.getProcessRef().getFlowElements());
}
}
}
else if (bpmnElement instanceof Choreography) {
flowElements = ((Choreography)bpmnElement).getFlowElements();
}
if (flowElements != null) {
BPMNDiagram mainBpmnDiagram = ModelUtil.getDefinitions(bpmnResource).getDiagrams().get(0);
BPMNDiagram activeBpmnDiagram = getBpmnDiagram();
for (FlowElement fe : flowElements) {
BPMNDiagram bd = DIUtils.findBPMNDiagram(fe);
if (bd!=null && !bpmnDiagrams.contains(bd) && bd!=activeBpmnDiagram && bd!=mainBpmnDiagram)
bpmnDiagrams.add(bd);
getSubDiagrams(fe, bpmnDiagrams);
}
}
}
public void createPartControl(Composite parent) {
if (getGraphicalViewer()==null) {
tabFolder = new CTabFolder(parent, SWT.BOTTOM);
tabFolder.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
if (!tabFolder.isLayoutDeferred()) {
int pageIndex = tabFolder.indexOf((CTabItem) e.item);
CTabItem item = tabFolder.getItem(pageIndex);
BPMNDiagram bpmnDiagram = (BPMNDiagram) item.getData();
showDesignPageInternal(bpmnDiagram);
selectBpmnDiagram(bpmnDiagram);
}
}
});
tabFolder.addTraverseListener(new TraverseListener() {
// see https://bugs.eclipse.org/bugs/show_bug.cgi?id=199499 : Switching tabs by Ctrl+PageUp/PageDown must not be caught on the inner tab set
public void keyTraversed(TraverseEvent e) {
switch (e.detail) {
case SWT.TRAVERSE_PAGE_NEXT:
case SWT.TRAVERSE_PAGE_PREVIOUS:
int detail = e.detail;
e.doit = true;
e.detail = SWT.TRAVERSE_NONE;
Control control = tabFolder.getParent();
control.traverse(detail, new Event());
}
}
});
defaultTabHeight = tabFolder.getTabHeight();
container = new Composite(tabFolder, SWT.NONE);
container.setLayout(new FillLayout());
CTabItem item = new CTabItem(tabFolder, SWT.NONE, 0);
item.setText(Messages.DesignEditor_Diagram_Tab);
item.setControl(container);
item.setData(getBpmnDiagram());
super.createPartControl(container);
// create additional editor tabs for BPMNDiagrams in the parent MultiPageEditor
final List<BPMNDiagram> bpmnDiagrams = getModelHandler().getAll(BPMNDiagram.class);
for (int i=1; i<bpmnDiagrams.size(); ++i) {
BPMNDiagram bpmnDiagram = bpmnDiagrams.get(i);
if (bpmnDiagram.getPlane().getBpmnElement() instanceof RootElement)
multipageEditor.addDesignPage(bpmnDiagram);
}
}
}
public void updateTabs() {
// if (!tabFolder.isLayoutDeferred()) {
if (tabFolder.getItemCount()==1) {
tabFolder.setTabHeight(0);
}
else
tabFolder.setTabHeight(defaultTabHeight);
// }
tabFolder.layout();
}
@Override
protected void createActions() {
super.createActions();
ActionRegistry registry = getActionRegistry();
IAction action = new WorkbenchPartAction(multipageEditor.getDesignEditor()) {
@Override
protected void init() {
super.init();
setId("show.or.hide.source.view"); //$NON-NLS-1$
}
@Override
public String getText() {
return multipageEditor.getSourceViewer() == null ? Messages.DesignEditor_Show_Source_View_Action : Messages.DesignEditor_Hide_Source_View_Action;
}
@Override
protected boolean calculateEnabled() {
return true;
}
public void run() {
if (multipageEditor.getSourceViewer() == null) {
multipageEditor.createSourceViewer();
} else {
multipageEditor.removeSourceViewer();
}
}
};
registry.registerAction(action);
action = new WorkbenchPartAction(multipageEditor.getDesignEditor()) {
@Override
protected void init() {
super.init();
setId("delete.page"); //$NON-NLS-1$
}
@Override
public String getText() {
int pageIndex = multipageEditor.getActivePage();
return NLS.bind(Messages.DesignEditor_Delete_Diagram_Action, multipageEditor.getTabItem(pageIndex).getText());
}
@Override
public boolean isEnabled() {
return calculateEnabled();
}
@Override
protected boolean calculateEnabled() {
final BPMNDiagram bpmnDiagram = getBpmnDiagram();
BPMNPlane plane = bpmnDiagram.getPlane();
BaseElement bpmnElement = plane.getBpmnElement();
if (bpmnElement instanceof SubProcess)
return false;
return true;
}
public void run() {
int pageIndex = multipageEditor.getActivePage();
boolean result = MessageDialog.openQuestion(getSite().getShell(),
Messages.DesignEditor_Delete_Page_Title,
NLS.bind(
Messages.DesignEditor_DeletePage_Message,
multipageEditor.getTabItem(pageIndex).getText()
)
);
if (result) {
final BPMNDiagram bpmnDiagram = getBpmnDiagram();
TransactionalEditingDomain domain = TransactionUtil.getEditingDomain(bpmnDiagram);
// removeDesignPage(bpmnDiagram);
if (domain != null) {
domain.getCommandStack().execute(new RecordingCommand(domain) {
@Override
protected void doExecute() {
BPMNPlane plane = bpmnDiagram.getPlane();
BaseElement process = plane.getBpmnElement();
DIUtils.deleteDiagram(DesignEditor.this.getDiagramBehavior(), bpmnDiagram);
EcoreUtil.delete(process, true);
}
});
}
}
}
};
registry.registerAction(action);
action = new WorkbenchPartAction(multipageEditor.getDesignEditor()) {
@Override
protected void init() {
super.init();
setId("show.property.view"); //$NON-NLS-1$
}
@Override
public String getText() {
return Messages.DesignEditor_Show_Property_View_Action;
}
@Override
protected boolean calculateEnabled() {
return true;
}
public void run() {
PropertyUtil.showPropertySheetView();
}
};
registry.registerAction(action);
// TODO: work in progress
// {@see BPMN2EditorDiagramBehavior}
// action = new WorkbenchPartAction(multipageEditor.getDesignEditor()) {
//
// @Override
// protected void init() {
// super.init();
// setId("show.hide.elements"); //$NON-NLS-1$
// }
//
// @Override
// public String getText() {
// return "Show or Hide Elements...";
// }
//
// @Override
// protected boolean calculateEnabled() {
// return true;
// }
//
// public void run() {
// ShowHideElementsDialog dialog = new ShowHideElementsDialog(getEditorSite().getShell());
// if (dialog.open()==Window.OK) {
// Diagram diagram = getDiagramTypeProvider().getDiagram();
// List<Integer> selections = dialog.getSelections();
// List<PictogramElement> hide = new ArrayList<PictogramElement>();
// List<PictogramElement> show = new ArrayList<PictogramElement>();
// TreeIterator<EObject> iter = diagram.eAllContents();
// while (iter.hasNext()) {
// EObject o = iter.next();
// if (o instanceof PictogramElement) {
// PictogramElement pe = (PictogramElement) o;
// if (FeatureSupport.isLabelShape(pe)) {
// PictogramElement owner = FeatureSupport.getLabelOwner(pe);
// BaseElement be = BusinessObjectUtil.getFirstBaseElement(owner);
// if (be instanceof Gateway) {
// if (selections.contains(ShowHideElementsDialog.GATEWAY_LABELS)) {
// if (!FeatureSupport.isHidden(pe))
// hide.add(pe);
// }
// else {
// if (FeatureSupport.isHidden(pe))
// show.add(pe);
// }
// }
// }
// }
// }
// for (PictogramElement pe : hide)
// FeatureSupport.setHidden(pe, true);
//
// for (PictogramElement pe : show)
// FeatureSupport.setHidden(pe, false);
//
// getDiagramBehavior().refreshContent();
// }
// }
// };
// registry.registerAction(action);
}
public class AddRemoveDiagramListener implements ResourceSetListener {
@Override
public NotificationFilter getFilter() {
return null;
}
@Override
public Command transactionAboutToCommit(ResourceSetChangeEvent event) throws RollbackException {
return null;
}
@Override
public void resourceSetChanged(ResourceSetChangeEvent event) {
boolean debug = Activator.getDefault().isDebugging();
for (Notification n : event.getNotifications()) {
int et = n.getEventType();
Object notifier = n.getNotifier();
Object newValue = n.getNewValue();
Object oldValue = n.getOldValue();
Object feature = n.getFeature();
if (debug) {
if (et == Notification.ADD || et == Notification.REMOVE || et == Notification.SET) {
System.out.print("event: " + et + "\t"); //$NON-NLS-1$ //$NON-NLS-2$
if (notifier instanceof EObject) {
System.out.print("notifier: $" + ((EObject) notifier).eClass().getName()); //$NON-NLS-1$
} else
System.out.print("notifier: " + notifier); //$NON-NLS-1$
}
}
if (et == Notification.ADD) {
if (debug) {
if (newValue instanceof EObject) {
System.out.println("\t\tvalue: " + ((EObject) newValue).eClass().getName()); //$NON-NLS-1$
} else
System.out.println("\t\tvalue: " + newValue); //$NON-NLS-1$
}
if (notifier instanceof Definitions
&& newValue instanceof BPMNDiagram
&& feature == Bpmn2Package.eINSTANCE.getDefinitions_Diagrams()) {
final BPMNDiagram bpmnDiagram = (BPMNDiagram) newValue;
BaseElement bpmnElement = bpmnDiagram.getPlane().getBpmnElement();
if (bpmnElement instanceof RootElement)
multipageEditor.addDesignPage(bpmnDiagram);
else
addDesignPage(bpmnDiagram);
// break;
}
} else if (et == Notification.REMOVE) {
if (debug) {
if (oldValue instanceof EObject) {
System.out.println("\t\tvalue: " + ((EObject) oldValue).eClass().getName()); //$NON-NLS-1$
} else
System.out.println("\t\tvalue: " + oldValue); //$NON-NLS-1$
}
if (notifier instanceof Definitions
&& oldValue instanceof BPMNDiagram
&& feature == Bpmn2Package.eINSTANCE.getDefinitions_Diagrams()) {
final BPMNDiagram bpmnDiagram = (BPMNDiagram) oldValue;
BaseElement bpmnElement = bpmnDiagram.getPlane().getBpmnElement();
if (bpmnElement instanceof RootElement)
multipageEditor.removeDesignPage(bpmnDiagram);
else
removeDesignPage(bpmnDiagram);
// break;
}
} else if (et == Notification.SET) {
// check if we need to change the tab names
if (n.getFeature() instanceof EStructuralFeature &&
((EStructuralFeature)n.getFeature()).getName().equals("name")) { //$NON-NLS-1$
for (int i=1; i<tabFolder.getItemCount(); ++i) {
CTabItem item = tabFolder.getItem(i);
BPMNDiagram bpmnDiagram = (BPMNDiagram)item.getData();
if (bpmnDiagram!=null) {
if (bpmnDiagram==notifier || bpmnDiagram.getPlane().getBpmnElement() == notifier) {
String text = n.getNewStringValue();
if (text==null || text.isEmpty())
text = "Unnamed"; //$NON-NLS-1$
item.setText(text);
}
}
}
for (int i=0; i<multipageEditor.getPageCount(); ++i) {
BPMNDiagram bpmnDiagram = multipageEditor.getBpmnDiagram(i);
if (bpmnDiagram!=null) {
if (bpmnDiagram==notifier || bpmnDiagram.getPlane().getBpmnElement() == notifier) {
CTabItem item = multipageEditor.getTabItem(i);
String text = n.getNewStringValue();
if (text==null || text.isEmpty())
text = "Unnamed"; //$NON-NLS-1$
item.setText(text);
}
}
}
}
}
}
}
@Override
public boolean isAggregatePrecommitListener() {
return false;
}
@Override
public boolean isPrecommitOnly() {
return false;
}
@Override
public boolean isPostcommitOnly() {
return true;
}
}
}