path: root/plugins/uml/diagram/org.eclipse.papyrus.uml.diagram.sequence/custom-src/org/eclipse/papyrus/uml/diagram/sequence/SequencePaletteFactory.java

/*****************************************************************************
 * Copyright (c) 2010 CEA
 *
 *    
 * 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:
 *   Soyatec - Initial API and implementation
 *
 *****************************************************************************/
package org.eclipse.papyrus.uml.diagram.sequence;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.draw2d.Cursors;
import org.eclipse.gef.EditPart;
import org.eclipse.gef.EditPartViewer;
import org.eclipse.gef.EditPolicy;
import org.eclipse.gef.Request;
import org.eclipse.gef.Tool;
import org.eclipse.gef.requests.CreateConnectionRequest;
import org.eclipse.gef.requests.CreationFactory;
import org.eclipse.gef.tools.CreationTool;
import org.eclipse.gmf.runtime.diagram.ui.editparts.IPrimaryEditPart;
import org.eclipse.gmf.runtime.diagram.ui.editparts.ShapeEditPart;
import org.eclipse.gmf.runtime.diagram.ui.requests.CreateConnectionViewRequest;
import org.eclipse.gmf.runtime.diagram.ui.requests.CreateConnectionViewRequest.ConnectionViewDescriptor;
import org.eclipse.gmf.runtime.diagram.ui.requests.RequestConstants;
import org.eclipse.gmf.runtime.diagram.ui.services.palette.PaletteFactory;
import org.eclipse.gmf.runtime.emf.type.core.IElementType;
import org.eclipse.gmf.runtime.emf.type.core.IHintedType;
import org.eclipse.gmf.runtime.notation.View;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.papyrus.uml.diagram.common.service.AspectUnspecifiedTypeConnectionTool;
import org.eclipse.papyrus.uml.diagram.common.service.AspectUnspecifiedTypeCreationTool;
import org.eclipse.papyrus.uml.diagram.sequence.edit.parts.GateEditPart;
import org.eclipse.papyrus.uml.diagram.sequence.edit.parts.InteractionInteractionCompartmentEditPart;
import org.eclipse.papyrus.uml.diagram.sequence.edit.policies.AnnotatedLinkEndEditPolicy;
import org.eclipse.papyrus.uml.diagram.sequence.edit.policies.AnnotatedLinkStartEditPolicy;
import org.eclipse.papyrus.uml.diagram.sequence.edit.policies.HighlightEditPolicy;
import org.eclipse.papyrus.uml.diagram.sequence.providers.UMLElementTypes;
import org.eclipse.papyrus.uml.diagram.sequence.util.SequenceRequestConstant;
import org.eclipse.swt.widgets.Display;

/**
 * @author Jin Liu (jin.liu@soyatec.com)
 */
public class SequencePaletteFactory extends PaletteFactory.Adapter {

	private static final String CREATECOMBINEDFRAGMENTTOOL = "createCombinedFragmentTool";

	private static final String CREATECONSIDERIGNOREFRAGMENTTOOL = "createConsiderIgnoreFragmentTool";

	private static final String CREATEDURATIONCONSTRAINTTOOL = "createDurationConstraintTool";

	private static final String CREATEDURATIONOBSERVATIONTOOL = "createDurationObservationTool";

	private static final String CREATETIMEOBSERVATIONTOOL = "createTimeObservationTool";

	private static final String CREATEDESTRUCTIONEVENTTOOL = "createDestructionEventTool";

	private static final String CREATECOMMENTTOOL = "createCommentTool";

	private static final String CREATECONSTRAINTTOOL = "createConstraintTool";

	private static final String CREATEMESSAGESYNCTOOL = "createMessageSyncTool";

	private static final String CREATEMESSAGEASYNCTOOL = "createMessageAsyncTool";

	private static final String CREATEMESSAGEREPLYTOOL = "createMessageReplyTool";

	private static final String CREATEMESSAGECREATETOOL = "createMessageCreateTool";

	private static final String CREATEMESSAGEDELETETOOL = "createMessageDeleteTool";

	private static final String CREATEMESSAGELOSTTOOL = "createMessageLostTool";

	private static final String CREATEMESSAGEFOUNDTOOL = "createMessageFoundTool";

	private static final String CREATEGENERALORDERINGTOOL = "createGeneralOrderingTool";

	private static final String CREATEANNOTATEDLINKTOOL = "createAnnotatedLinkTool";

	private static final String CREATEGATETOOL = "createGateTool";

	public SequencePaletteFactory() {
	}

	@Override
	public Tool createTool(String toolId) {
		if(toolId.equals(CREATECOMBINEDFRAGMENTTOOL)) {
			return createCombinedFragment5CreationTool();
		}
		// add
		if(toolId.equals(CREATECONSIDERIGNOREFRAGMENTTOOL)) {
			return createConsiderIgnoreFragmentCreationTool();
		}
		if(toolId.equals(CREATECOMMENTTOOL)) {
			return createComment9CreationTool();
		}
		if(toolId.equals(CREATECONSTRAINTTOOL)) {
			return createConstraint10CreationTool();
		}
		if(toolId.equals(CREATEDURATIONOBSERVATIONTOOL)) {
			return createDurationObservation12CreationTool();
		}
		if(toolId.equals(CREATETIMEOBSERVATIONTOOL)) {
			return createTimeObservation14CreationTool();
		}
		if(toolId.equals(CREATEDURATIONCONSTRAINTTOOL)) {
			return createDurationConstraint15CreationTool();
		}
		if(toolId.equals(CREATEDESTRUCTIONEVENTTOOL)) {
			return createDestructionEvent16CreationTool();
		}
		if(toolId.equals(CREATEMESSAGESYNCTOOL)) {
			return createMessageSync1CreationTool();
		}
		if(toolId.equals(CREATEMESSAGEASYNCTOOL)) {
			return createMessageAsync2CreationTool();
		}
		if(toolId.equals(CREATEMESSAGEREPLYTOOL)) {
			return createMessageReply3CreationTool();
		}
		if(toolId.equals(CREATEMESSAGECREATETOOL)) {
			return createMessageCreate4CreationTool();
		}
		if(toolId.equals(CREATEMESSAGEDELETETOOL)) {
			return createMessageDelete5CreationTool();
		}
		if(toolId.equals(CREATEMESSAGELOSTTOOL)) {
			return createMessageLost6CreationTool();
		}
		if(toolId.equals(CREATEMESSAGEFOUNDTOOL)) {
			return createMessageFound7CreationTool();
		}
		if(toolId.equals(CREATEGENERALORDERINGTOOL)) {
			return createGeneralOrdering8CreationTool();
		}
		if(toolId.equals(CREATEANNOTATEDLINKTOOL)) {
			return createAnnotatedLink9CreationTool();
		}
		if(toolId.equals(CREATEGATETOOL)) {
			return createGateTool();
		}
		// default return: null
		return null;
	}

	/**
	 * @return
	 */
	private Tool createGateTool() {
		return new CreationTool(new CreationFactory() {

			public Object getObjectType() {
				return GateEditPart.GATE_TYPE;
			}

			public Object getNewObject() {
				return GateEditPart.GATE_TYPE;
			}
		});
	}

	@Override
	public Object getTemplate(String templateId) {
		// default return: null
		return null;
	}

	private Tool createCombinedFragment5CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(2);
		//types.add(UMLElementTypes.ConsiderIgnoreFragment_3007);
		types.add(UMLElementTypes.CombinedFragment_3004);
		Tool tool = new AspectUnspecifiedTypeCreationTool(types);
		return tool;
	}

	private Tool createConsiderIgnoreFragmentCreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(2);
		types.add(UMLElementTypes.ConsiderIgnoreFragment_3007);
		Tool tool = new AspectUnspecifiedTypeCreationTool(types);
		return tool;
	}

	private Tool createComment9CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.Comment_3009);
		//		Tool tool = new AspectUnspecifiedTypeCreationTool(types){
		//			protected Command getCommand() {
		//				if (!antiScroll){
		//					if(getTargetEditPart() instanceof LifelineEditPart){
		//						InteractionInteractionCompartmentEditPart parent = ((LifelineEditPart) getTargetEditPart()).getParentInteractionCompartmentEditPart();
		//						if(parent != null)
		//							return parent.getCommand( getTargetRequest() );
		//					}
		//					return super.getCommand();
		//				}
		//				return null;
		//			}
		//		};
		InteractionChildCreationTool tool = new InteractionChildCreationTool(types);
		return tool;
	}

	private Tool createConstraint10CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.Constraint_3008);
		//		Tool tool = new AspectUnspecifiedTypeCreationTool(types){
		//			protected Command getCommand() {
		//				if (!antiScroll){
		//					if(getTargetEditPart() instanceof LifelineEditPart){
		//						InteractionInteractionCompartmentEditPart parent = ((LifelineEditPart) getTargetEditPart()).getParentInteractionCompartmentEditPart();
		//						if(parent != null)
		//							return parent.getCommand( getTargetRequest() );
		//					}
		//					return super.getCommand();
		//				}
		//				return null;
		//			}
		//		};
		InteractionChildCreationTool tool = new InteractionChildCreationTool(types);
		return tool;
	}

	private Tool createDurationObservation12CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.DurationObservation_3024);
		// use DurationCreationTool
		//Tool tool = new DurationCreationTool(types);
		//		AspectUnspecifiedTypeCreationTool tool = new AspectUnspecifiedTypeCreationTool(types);
		InteractionChildCreationTool tool = new InteractionChildCreationTool(types);
		//		tool.setDefaultCursor(SharedCursors.HAND);
		//		tool.setDisabledCursor(SharedCursors.NO);
		return tool;
	}

	private Tool createTimeObservation14CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.TimeObservation_3020);
		//		AspectUnspecifiedTypeCreationTool tool = new AspectUnspecifiedTypeCreationTool(types){
		//			protected Command getCommand() {
		//				if (!antiScroll){
		//					if(getTargetEditPart() instanceof LifelineEditPart){
		//						InteractionInteractionCompartmentEditPart parent = ((LifelineEditPart) getTargetEditPart()).getParentInteractionCompartmentEditPart();
		//						if(parent != null)
		//							return parent.getCommand( getTargetRequest() );
		//					}
		//					return super.getCommand();
		//				}
		//				return null;
		//			}
		//		};
		InteractionChildCreationTool tool = new InteractionChildCreationTool(types);
		//		tool.setDefaultCursor(SharedCursors.HAND);
		//		tool.setDisabledCursor(SharedCursors.NO);
		return tool;
	}

	private Tool createDurationConstraint15CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(2);
		types.add(UMLElementTypes.DurationConstraint_3021);
		//		types.add(UMLElementTypes.DurationConstraint_3023);
		// use DurationCreationTool
		//		Tool tool = new DurationCreationTool(types);
		//Disable old DurationConstraint creation.
		InteractionChildCreationTool tool = new InteractionChildCreationTool(types);
		return tool;
	}

	private Tool createDestructionEvent16CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.DestructionOccurrenceSpecification_3022);
		Tool tool = new AspectUnspecifiedTypeCreationTool(types);
		return tool;
	}

	private Tool createMessageSync1CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.Message_4003);
		Tool tool = new MessageConnectionTool(types);
		return tool;
	}

	private Tool createMessageAsync2CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.Message_4004);
		Tool tool = new MessageConnectionTool(types);
		return tool;
	}

	private Tool createMessageReply3CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.Message_4005);
		Tool tool = new MessageConnectionTool(types);
		return tool;
	}

	private Tool createMessageCreate4CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.Message_4006);
		Tool tool = new MessageConnectionTool(types);
		return tool;
	}

	private Tool createMessageDelete5CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.Message_4007);
		Tool tool = new MessageConnectionTool(types);
		return tool;
	}

	private Tool createMessageLost6CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.Message_4008);
		Tool tool = new MessageConnectionTool(types);
		return tool;
	}

	private Tool createMessageFound7CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.Message_4009);
		Tool tool = new MessageConnectionTool(types);
		return tool;
	}

	private Tool createGeneralOrdering8CreationTool() {
		List<IElementType> types = new ArrayList<IElementType>(1);
		types.add(UMLElementTypes.GeneralOrdering_4012);
		Tool tool = new AspectUnspecifiedTypeConnectionToolEx(types);
		return tool;
	}

	private Tool createAnnotatedLink9CreationTool() {
		AspectUnspecifiedTypeConnectionToolEx tool = new AspectUnspecifiedTypeConnectionToolEx(null) {

			@Override
			protected CreateConnectionRequest createTargetRequest() {
				IHintedType type = (IHintedType)UMLElementTypes.CommentAnnotatedElement_4010;
				return new CreateConnectionViewRequest(new ConnectionViewDescriptor(type, type.getSemanticHint(), getPreferencesHint()));
			}

			@Override
			protected String getCommandName() {
				if(isInState(STATE_CONNECTION_STARTED | STATE_ACCESSIBLE_DRAG_IN_PROGRESS)) {
					return AnnotatedLinkEndEditPolicy.REQ_ANNOTATED_LINK_END;
				} else {
					return AnnotatedLinkStartEditPolicy.REQ_ANNOTATED_LINK_START;
				}
			}

			@Override
			protected boolean handleCreateConnection() {
				boolean handled = super.handleCreateConnection();
				//Make sure to erase source feedback whatever the connection created or not.
				setAvoidDeactivation(false);
				eraseSourceFeedback();
				deactivate();
				return handled;
			}
		};
		tool.setUnloadWhenFinished(true);
		return tool;
	}

	public static class AspectUnspecifiedTypeConnectionToolEx extends AspectUnspecifiedTypeConnectionTool {

		private EditPart source;

		public AspectUnspecifiedTypeConnectionToolEx(List<IElementType> elementTypes) {
			super(elementTypes);
			setDisabledCursor(Cursors.NO);
		}

		@Override
		protected void setConnectionSource(EditPart source) {
			this.source = source;
			super.setConnectionSource(source);
		}

		public void clearConnectionFeedback() {
			if(!isShowingSourceFeedback()) {
				return;
			}
			if(source != null) {
				Request req = getSourceRequest();
				req.setType(REQ_CONNECTION_END);
				source.eraseSourceFeedback(req);
			}
		}
	}

	/**
	 * Try to create child in Interaction directly.
	 * 
	 * @author Jin Liu (jin.liu@soyatec.com)
	 */
	public static class InteractionChildCreationTool extends AspectUnspecifiedTypeCreationTool {

		/**
		 * Constructor.
		 * 
		 * @param elementTypes
		 */
		public InteractionChildCreationTool(List<IElementType> elementTypes) {
			super(elementTypes);
		}

		@Override
		protected boolean updateTargetUnderMouse() {
			if(antiScroll) {
				return super.updateTargetUnderMouse();
			}
			if(!isTargetLocked()) {
				EditPart editPart = null;
				if(getCurrentViewer() != null) {
					editPart = getCurrentViewer().findObjectAtExcluding(getLocation(), getExclusionSet(), getTargetingConditional());
				}
				if(editPart != null) {
					editPart = getInteractionEditPart(editPart);
				}
				boolean changed = getTargetEditPart() != editPart;
				setTargetEditPart(editPart);
				return changed;
			} else {
				return false;
			}
		}

		private EditPart getInteractionEditPart(EditPart editPart) {
			if(editPart == null) {
				return null;
			}
			if(editPart instanceof InteractionInteractionCompartmentEditPart) {
				return editPart;
			}
			return getInteractionEditPart(editPart.getParent());
		}
	}

	public static class MessageConnectionTool extends AspectUnspecifiedTypeConnectionToolEx {

		/**
		 * Constructor.
		 * 
		 * @param elementTypes
		 */
		public MessageConnectionTool(List<IElementType> elementTypes) {
			super(elementTypes);
		}

		@Override
		protected void selectAddedObject(EditPartViewer viewer, Collection objects) {
			final List editparts = new ArrayList();
			final EditPart[] primaryEP = new EditPart[1];
			for(Iterator i = objects.iterator(); i.hasNext();) {
				Object object = i.next();
				if(object instanceof IAdaptable) {
					Object editPart = viewer.getEditPartRegistry().get(((IAdaptable)object).getAdapter(View.class));
					if(editPart instanceof IPrimaryEditPart) {
						editparts.add(editPart);
					}
					// Priority is to put a shape into direct edit mode.
					if(editPart instanceof ShapeEditPart) {
						primaryEP[0] = (ShapeEditPart)editPart;
					}
				}
			}
			if(!editparts.isEmpty()) {
				viewer.setSelection(new StructuredSelection(editparts));
				// automatically put the first shape into edit-mode
				Display.getCurrent().asyncExec(new Runnable() {

					public void run() {
						if(primaryEP[0] == null) {
							primaryEP[0] = (EditPart)editparts.get(0);
						}
						//
						// add active test since test scripts are failing on this
						// basically, the editpart has been deleted when this
						// code is being executed. (see RATLC00527114)
						if(primaryEP[0].isActive()) {
							Request request = new Request(RequestConstants.REQ_DIRECT_EDIT);
							//Mark this request as the first direct edit after creation.
							request.getExtendedData().put(SequenceRequestConstant.DIRECT_EDIT_AFTER_CREATION, true);
							primaryEP[0].performRequest(request);
						}
					}
				});
			}
		}

		/**
		 * @see org.eclipse.gmf.runtime.diagram.ui.tools.ConnectionCreationTool#deactivate()
		 * 
		 */
		@Override
		public void deactivate() {
			EditPart targetEditPart = getTargetEditPart();
			if(targetEditPart != null) {
				EditPolicy editPolicy = targetEditPart.getEditPolicy(HighlightEditPolicy.HIGHLIGHT_ROLE);
				if(editPolicy != null) {
					editPolicy.eraseSourceFeedback(getTargetRequest());
				}
			}
			super.deactivate();
		}
	}
}