Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.diagram / src / org / simantics / diagram / handler / PasteOperation.java

diff --git a/bundles/org.simantics.diagram/src/org/simantics/diagram/handler/PasteOperation.java b/bundles/org.simantics.diagram/src/org/simantics/diagram/handler/PasteOperation.java
new file mode 100644 (file)
index 0000000..d10fd21
--- /dev/null
+++ b/bundles/org.simantics.diagram/src/org/simantics/diagram/handler/PasteOperation.java
@@ -0,0 +1,137 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.diagram.handler;\r
+\r
+import java.awt.geom.Point2D;\r
+import java.util.Collections;\r
+import java.util.Map;\r
+\r
+import org.simantics.db.Resource;\r
+import org.simantics.g2d.canvas.ICanvasContext;\r
+import org.simantics.g2d.diagram.IDiagram;\r
+import org.simantics.scenegraph.g2d.events.command.Command;\r
+\r
+/**\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public final class PasteOperation {\r
+\r
+    /**\r
+     * Optional specifications for the paste operation that can be given through.\r
+     */\r
+    public static interface PasteOption {}\r
+\r
+    /**\r
+     * For forcing pasting of diagram reference elements even when the parent\r
+     * element of the reference element is not included in the copied material.\r
+     */\r
+    public static enum ForceCopyReferences implements PasteOption { INSTANCE }\r
+\r
+    // Input\r
+    public final Command                 command;\r
+    public final ICanvasContext          ctx;\r
+    public final Resource                sourceDiagram;\r
+    public final Resource                targetDiagram;\r
+    public final IDiagram                target;\r
+    public final ElementObjectAssortment ea;\r
+    public final boolean                 cut;\r
+    public final Point2D                 offset;\r
+\r
+    public Map<Resource, Resource>       initialNodeMap;\r
+\r
+    public PasteOption[]                 options;\r
+\r
+    // Output\r
+    public final Map<Object, Object>     copyMap;\r
+\r
+    public PasteOperation(\r
+            Command command,\r
+            ICanvasContext ctx,\r
+            Resource sourceDiagram,\r
+            Resource targetDiagram,\r
+            IDiagram target,\r
+            ElementObjectAssortment ea,\r
+            boolean cut,\r
+            Point2D offset,\r
+            Map<Resource, Resource> initialNodeMap,\r
+            Map<Object, Object> copyMap\r
+    ) {\r
+        if (sourceDiagram == null)\r
+            throw new IllegalArgumentException("null source diagram");\r
+        if (targetDiagram == null)\r
+            throw new IllegalArgumentException("null target diagram");\r
+\r
+        this.command = command;\r
+        this.ctx = ctx;\r
+        this.sourceDiagram = sourceDiagram;\r
+        this.targetDiagram = targetDiagram;\r
+        this.target = target;\r
+        this.ea = ea;\r
+        this.cut = cut;\r
+        this.offset = offset;\r
+        this.copyMap = copyMap;\r
+        this.initialNodeMap = initialNodeMap;\r
+    }\r
+\r
+    public PasteOperation(\r
+            Command command,\r
+            ICanvasContext ctx,\r
+            Resource sourceDiagram,\r
+            Resource targetDiagram,\r
+            IDiagram target,\r
+            ElementObjectAssortment ea,\r
+            boolean cut,\r
+            Point2D offset,\r
+            Map<Resource, Resource> initialNodeMap\r
+    ) {\r
+        this(command, ctx, sourceDiagram, targetDiagram, target, ea, cut, offset, initialNodeMap, null);\r
+    }\r
+\r
+    public PasteOperation(\r
+            Command command,\r
+            ICanvasContext ctx,\r
+            Resource sourceDiagram,\r
+            Resource targetDiagram,\r
+            IDiagram target,\r
+            ElementObjectAssortment ea,\r
+            boolean cut,\r
+            Point2D offset\r
+    ) {\r
+        this(command, ctx, sourceDiagram, targetDiagram, target, ea, cut, offset, Collections.<Resource, Resource>emptyMap());\r
+    }\r
+\r
+    public PasteOperation options(PasteOption... options) {\r
+        this.options = options;\r
+        return this;\r
+    }\r
+\r
+    public boolean sameDiagram() {\r
+        return sourceDiagram.equals(targetDiagram);\r
+    }\r
+\r
+    @SuppressWarnings("unchecked")\r
+    public <T extends PasteOption> T getOption(Class<T> clazz) {\r
+        if (options == null)\r
+            return null;\r
+        for (PasteOption option : options) {\r
+            if (clazz.isInstance(option))\r
+                return (T) option;\r
+        }\r
+        return null;\r
+    }\r
+\r
+    public <T extends PasteOption> boolean hasOption(Class<T> clazz) {\r
+        return getOption(clazz) != null;\r
+    }\r
+\r
+}\r