bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/events/IEventHandler.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 /*
  13  *
  14  * @author Toni Kalajainen
  15  */
  16 package org.simantics.scenegraph.g2d.events;
  17
  18 /**
  19  * @author Toni Kalajainen
  20  */
  21 public interface IEventHandler {
  22
  23     /**
  24      * Returns a bit mask based on the constants in {@link EventTypes} to
  25      * restrict which type of events should be propagated to this event handler.
  26      * The value returned by this method must be constant, it must not change
  27      * during the handler's life cycle.
  28      *
  29      * @return a bit mask defining the events to propagate to this handler
  30      * @see EventTypes
  31      */
  32     int getEventMask();
  33
  34     /**
  35      * Process an event. If this method returns true, the event will be eaten
  36      * and not sent to lower levels of the handler stack.
  37      *
  38      * @return true if the handler consumed the event. Consumed events are not
  39      *         propagated further.
  40      */
  41     boolean handleEvent(Event e);
  42
  43 }