bundles/org.simantics.g2d/src/org/simantics/g2d/element/handler/Clickable.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.g2d.element.handler;\r
  13 \r
  14 import org.simantics.g2d.canvas.ICanvasContext;\r
  15 import org.simantics.g2d.element.IElement;\r
  16 import org.simantics.g2d.element.handler.impl.AbstractClickable;\r
  17 import org.simantics.g2d.element.handler.impl.ClickableImpl;\r
  18 import org.simantics.utils.threads.IThreadWorkQueue;\r
  19 \r
  20 /**\r
  21  * Clickable Element\r
  22  * \r
  23  * \r
  24  * @See {@link ClickableImpl}\r
  25  * @See {@link AbstractClickable} \r
  26  * @author Toni Kalajainen\r
  27  */\r
  28 public interface Clickable extends ElementHandler {\r
  29 \r
  30         public static final ClickableImpl INSTANCE = ClickableImpl.INSTANCE;\r
  31         \r
  32         // TODO PressStatus should be a variable of the viewport, not the diagram\r
  33         public static enum PressStatus { \r
  34                 NORMAL,  // not pressed \r
  35                 HOVER,   // not pressed but mouse is hovering over the element\r
  36                 HELD,    // pressed but mouse is not hovering over the element\r
  37                 PRESSED  // pressed and mouse is hovering over the element\r
  38                 };\r
  39         \r
  40         public interface ClickListener {\r
  41                 void onClick(IElement e, ICanvasContext ctx);\r
  42         }\r
  43         \r
  44         PressStatus getPressStatus(IElement e, ICanvasContext ctx);\r
  45 \r
  46         // IMPL Note! Invocation must be thread safe (canvas thread is not guaranteed)\r
  47         void addListener(IElement e, ICanvasContext ctx, IThreadWorkQueue thread, ClickListener listener);\r
  48         \r
  49         // IMPL Note! Invocation must be thread safe (canvas thread is not guaranteed)\r
  50         void removeListener(IElement e, ICanvasContext ctx, IThreadWorkQueue thread, ClickListener listener);\r
  51         \r
  52 }\r