Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Clickable.java b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Clickable.java
new file mode 100644 (file)
index 0000000..d435403
--- /dev/null
+++ b/bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Clickable.java
@@ -0,0 +1,52 @@
+/*******************************************************************************\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.element.IElement;\r
+import org.simantics.g2d.element.handler.impl.AbstractClickable;\r
+import org.simantics.g2d.element.handler.impl.ClickableImpl;\r
+import org.simantics.utils.threads.IThreadWorkQueue;\r
+\r
+/**\r
+ * Clickable Element\r
+ * \r
+ * \r
+ * @See {@link ClickableImpl}\r
+ * @See {@link AbstractClickable} \r
+ * @author Toni Kalajainen\r
+ */\r
+public interface Clickable extends ElementHandler {\r
+\r
+       public static final ClickableImpl INSTANCE = ClickableImpl.INSTANCE;\r
+       \r
+       // TODO PressStatus should be a variable of the viewport, not the diagram\r
+       public static enum PressStatus { \r
+               NORMAL,  // not pressed \r
+               HOVER,   // not pressed but mouse is hovering over the element\r
+               HELD,    // pressed but mouse is not hovering over the element\r
+               PRESSED  // pressed and mouse is hovering over the element\r
+               };\r
+       \r
+       public interface ClickListener {\r
+               void onClick(IElement e, ICanvasContext ctx);\r
+       }\r
+       \r
+       PressStatus getPressStatus(IElement e, ICanvasContext ctx);\r
+\r
+       // IMPL Note! Invocation must be thread safe (canvas thread is not guaranteed)\r
+       void addListener(IElement e, ICanvasContext ctx, IThreadWorkQueue thread, ClickListener listener);\r
+       \r
+       // IMPL Note! Invocation must be thread safe (canvas thread is not guaranteed)\r
+       void removeListener(IElement e, ICanvasContext ctx, IThreadWorkQueue thread, ClickListener listener);\r
+       \r
+}\r