bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/events/IEventHandler.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 /*\r
  13  *\r
  14  * @author Toni Kalajainen\r
  15  */\r
  16 package org.simantics.scenegraph.g2d.events;\r
  17 \r
  18 /**\r
  19  * @author Toni Kalajainen\r
  20  */\r
  21 public interface IEventHandler {\r
  22 \r
  23     /**\r
  24      * Returns a bit mask based on the constants in {@link EventTypes} to\r
  25      * restrict which type of events should be propagated to this event handler.\r
  26      * The value returned by this method must be constant, it must not change\r
  27      * during the handler's life cycle.\r
  28      * \r
  29      * @return a bit mask defining the events to propagate to this handler\r
  30      * @see EventTypes\r
  31      */\r
  32     int getEventMask();\r
  33 \r
  34     /**\r
  35      * Process an event. If this method returns true, the event will be eaten\r
  36      * and not sent to lower levels of the handler stack.\r
  37      * \r
  38      * @return true if the handler consumed the event. Consumed events are not\r
  39      *         propagated further.\r
  40      */\r
  41     boolean handleEvent(Event e);\r
  42 \r
  43 }\r