Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.diagram/src/org/simantics/diagram/handler/CopyStrategy.java b/bundles/org.simantics.diagram/src/org/simantics/diagram/handler/CopyStrategy.java
new file mode 100644 (file)
index 0000000..abcd625
--- /dev/null
+++ b/bundles/org.simantics.diagram/src/org/simantics/diagram/handler/CopyStrategy.java
@@ -0,0 +1,38 @@
+/*******************************************************************************\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 org.eclipse.core.runtime.IStatus;\r
+\r
+/**\r
+ * An additional interface for {@link CopyPasteStrategy} implementation to\r
+ * implement. This can be used to control the set of elements allowed to be\r
+ * copied/cut in the first place.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ * @see CopyPasteStrategy\r
+ * @since 1.23\r
+ */\r
+public interface CopyStrategy {\r
+\r
+    /**\r
+     * @param operation\r
+     *            the contents of the intended copy that this method is allowed\r
+     *            to modify freely.\r
+     * @return status to indicate whether the copy operation can succeed or not.\r
+     *         An OK status indicates the copy operation is ok to commence. Any\r
+     *         other status means that the strategy prevented copy the reason\r
+     *         shown by the status.\r
+     */\r
+    IStatus copy(CopyOperation operation);\r
+\r
+}\r