Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.g2d / src / org / simantics / g2d / element / handler / HandleMouseEvent.java

diff --git a/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/HandleMouseEvent.java b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/HandleMouseEvent.java
new file mode 100644 (file)
index 0000000..c613dda
--- /dev/null
+++ b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/HandleMouseEvent.java
@@ -0,0 +1,55 @@
+/*******************************************************************************\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.element.handler;\r
+\r
+import org.simantics.g2d.canvas.ICanvasContext;\r
+import org.simantics.g2d.diagram.participant.ElementInteractor;\r
+import org.simantics.g2d.element.IElement;\r
+import org.simantics.g2d.element.handler.impl.AbstractClickable;\r
+import org.simantics.g2d.element.handler.impl.AbstractGrabbable;\r
+import org.simantics.g2d.participant.TransformUtil;\r
+import org.simantics.scenegraph.g2d.events.MouseEvent;\r
+\r
+/**\r
+ * Handler that handles mouse events.\r
+ * Coordinates are in element coordinate system.\r
+ * <p>\r
+ * Handler receives mouse enter and exit events when pointer\r
+ * enters / exits the element area / control area. \r
+ * <p>\r
+ * This handler requires that {@link ElementInteractor} in the canvas. \r
+ * \r
+ * @See {@link AbstractGrabbable} Base implementation for elements with draggable content\r
+ * @See {@link AbstractClickable} Base implementation for elements that are pressable\r
+ * \r
+ * @See {@link TransformUtil} Coordinate modifications\r
+ * @author Toni Kalajainen\r
+ */\r
+public interface HandleMouseEvent extends ElementHandler {\r
+       \r
+       /** This handler consumes all mouse events sent to element */\r
+       public static final HandleMouseEvent EVENT_CONSUMER = new HandleMouseEvent() {\r
+               private static final long serialVersionUID = 8575435739682820291L;\r
+               @Override\r
+               public boolean handleMouseEvent(IElement e, ICanvasContext ctx, MouseEvent me) {\r
+                       return true;\r
+               }\r
+       };\r
+       \r
+       /**\r
+        * Handle mouse event. Coordinates are in control coordinates.\r
+        * @param e\r
+        * @return\r
+        */\r
+       boolean handleMouseEvent(IElement e, ICanvasContext ctx, MouseEvent me);\r
+       \r
+}\r