Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.g2d / src / org / simantics / g2d / dnd / IDragSourceParticipant.java

diff --git a/bundles/org.simantics.g2d/src/org/simantics/g2d/dnd/IDragSourceParticipant.java b/bundles/org.simantics.g2d/src/org/simantics/g2d/dnd/IDragSourceParticipant.java
new file mode 100644 (file)
index 0000000..95498a4
--- /dev/null
+++ b/bundles/org.simantics.g2d/src/org/simantics/g2d/dnd/IDragSourceParticipant.java
@@ -0,0 +1,46 @@
+/*******************************************************************************\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.g2d.dnd;\r
+\r
+import java.awt.datatransfer.Transferable;\r
+import java.awt.dnd.DnDConstants;\r
+import java.awt.dnd.DragGestureEvent;\r
+import java.awt.dnd.DragSourceListener;\r
+\r
+import org.simantics.g2d.canvas.ICanvasParticipant;\r
+import org.simantics.scenegraph.g2d.events.MouseEvent.MouseDragBegin;\r
+\r
+/**\r
+ * This is an interface allows objects to be dragged from the canvas.\r
+ * Implementations produce serializable Transferable object in drag out event.\r
+ * \r
+ * This participant requires {@link DragInteractor} installed in the canvas context.   \r
+ * \r
+ * @author Toni Kalajainen\r
+ */\r
+public interface IDragSourceParticipant extends ICanvasParticipant, DragSourceListener {\r
+\r
+    /** \r
+     * Can participant provide draggable content\r
+     * @return 0 for no, others operations, see {@link DnDConstants}\r
+     */\r
+    int canDrag(MouseDragBegin me);\r
+\r
+    Transferable dragStart(DragGestureEvent e);\r
+\r
+    /**\r
+     * Get allowed ops (See DnDConstants)\r
+     * @return\r
+     */\r
+    int getAllowedOps();\r
+\r
+}\r