libjava/java/awt/AWTEvent.java

   1 /* AWTEvent.java -- the root event in AWT
   2    Copyright (C) 1999, 2000, 2002 Free Software Foundation
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.awt;
  40
  41 import java.util.EventObject;
  42
  43 /**
  44  * AWTEvent is the root event class for all AWT events in the JDK 1.1 event
  45  * model. It supersedes the Event class from JDK 1.0. Subclasses outside of
  46  * the java.awt package should have IDs greater than RESERVED_ID_MAX.
  47  *
  48  * <p>Event masks defined here are used by components in
  49  * <code>enableEvents</code> to select event types not selected by registered
  50  * listeners. Event masks are appropriately set when registering on
  51  * components.
  52  *
  53  * @author Warren Levy  <warrenl@cygnus.com>
  54  * @author Aaron M. Renn <arenn@urbanophile.com>
  55  * @since 1.1
  56  * @status updated to 1.4
  57  */
  58 public abstract class AWTEvent extends EventObject
  59 {
  60   /**
  61    * Compatible with JDK 1.1+.
  62    */
  63   private static final long serialVersionUID = -1825314779160409405L;
  64
  65   /**
  66    * The ID of the event.
  67    *
  68    * @see #getID()
  69    * @see #AWTEvent(Object, int)
  70    * @serial the identifier number of this event
  71    */
  72   protected int id;
  73
  74   /**
  75    * Indicates if the event has been consumed. False mean it is passed to
  76    * the peer, true means it has already been processed. Semantic events
  77    * generated by low-level events always have the value true.
  78    *
  79    * @see #consume()
  80    * @see #isConsumed()
  81    * @serial whether the event has been consumed
  82    */
  83   protected boolean consumed;
  84
  85   /**
  86    * Who knows? It's in the serial version.
  87    *
  88    * @serial No idea what this is for.
  89    */
  90   byte[] bdata;
  91
  92   /** Mask for selecting component events. */
  93   public static final long COMPONENT_EVENT_MASK = 0x00001;
  94
  95   /** Mask for selecting container events. */
  96   public static final long CONTAINER_EVENT_MASK = 0x00002;
  97
  98   /** Mask for selecting component focus events. */
  99   public static final long FOCUS_EVENT_MASK = 0x00004;
 100
 101   /** Mask for selecting keyboard events. */
 102   public static final long KEY_EVENT_MASK = 0x00008;
 103
 104   /** Mask for mouse button events. */
 105   public static final long MOUSE_EVENT_MASK = 0x00010;
 106
 107   /** Mask for mouse motion events. */
 108   public static final long MOUSE_MOTION_EVENT_MASK = 0x00020;
 109
 110   /** Mask for window events. */
 111   public static final long WINDOW_EVENT_MASK = 0x00040;
 112
 113   /** Mask for action events. */
 114   public static final long ACTION_EVENT_MASK = 0x00080;
 115
 116   /** Mask for adjustment events. */
 117   public static final long ADJUSTMENT_EVENT_MASK = 0x00100;
 118
 119   /** Mask for item events. */
 120   public static final long ITEM_EVENT_MASK = 0x00200;
 121
 122   /** Mask for text events. */
 123   public static final long TEXT_EVENT_MASK = 0x00400;
 124
 125   /**
 126    * Mask for input method events.
 127    * @since 1.3
 128    */
 129   public static final long INPUT_METHOD_EVENT_MASK = 0x00800;
 130
 131   /**
 132    * Mask if input methods are enabled. Package visible only.
 133    */
 134   static final long INPUT_ENABLED_EVENT_MASK = 0x01000;
 135
 136   /**
 137    * Mask for paint events.
 138    * @since 1.3
 139    */
 140   public static final long PAINT_EVENT_MASK = 0x02000;
 141
 142   /**
 143    * Mask for invocation events.
 144    * @since 1.3
 145    */
 146   public static final long INVOCATION_EVENT_MASK = 0x04000;
 147
 148   /**
 149    * Mask for hierarchy events.
 150    * @since 1.3
 151    */
 152   public static final long HIERARCHY_EVENT_MASK = 0x08000;
 153
 154   /**
 155    * Mask for hierarchy bounds events.
 156    * @since 1.3
 157    */
 158   public static final long HIERARCHY_BOUNDS_EVENT_MASK = 0x10000;
 159
 160   /**
 161    * Mask for mouse wheel events.
 162    * @since 1.4
 163    */
 164   public static final long MOUSE_WHEEL_EVENT_MASK = 0x20000;
 165
 166   /**
 167    * Mask for window state events.
 168    * @since 1.4
 169    */
 170   public static final long WINDOW_STATE_EVENT_MASK = 0x40000;
 171
 172   /**
 173    * Mask for window focus events.
 174    * @since 1.4
 175    */
 176   public static final long WINDOW_FOCUS_EVENT_MASK = 0x80000;
 177
 178   /**
 179   * This is the highest number for event ids that are reserved for use by
 180   * the AWT system itself. Subclasses outside of java.awt should use higher
 181   * ids.
 182   */
 183   public static final int RESERVED_ID_MAX = 1999;
 184
 185 \f
 186   /**
 187    * Initializes a new AWTEvent from the old Java 1.0 event object.
 188    *
 189    * @param event the old-style event
 190    * @throws NullPointerException if event is null
 191    */
 192   public AWTEvent(Event event)
 193   {
 194     this(event.target, event.id);
 195     consumed = event.consumed;
 196   }
 197
 198   /**
 199    * Create an event on the specified source object and id.
 200    *
 201    * @param source the object that caused the event
 202    * @param id the event id
 203    * @throws IllegalArgumentException if source is null
 204    */
 205   public AWTEvent(Object source, int id)
 206   {
 207     super(source);
 208     this.id = id;
 209   }
 210
 211   /**
 212    * Retarget the event, such as converting a heavyweight component to a
 213    * lightweight child of the original. This is not for general use, but
 214    * is for event targeting systems like KeyboardFocusManager.
 215    *
 216    * @param source the new source
 217    */
 218   public void setSource(Object source)
 219   {
 220     this.source = source;
 221   }
 222
 223   /**
 224    * Returns the event type id.
 225    *
 226    * @return the id number of this event
 227    */
 228   public int getID()
 229   {
 230     return id;
 231   }
 232
 233   /**
 234    * Returns a string representation of this event. This is in the format
 235    * <code>getClass().getName() + '[' + paramString() + "] on "
 236    * + source</code>.
 237    *
 238    * @return a string representation of this event
 239    */
 240   public String toString()
 241   {
 242     return getClass().getName() + "[" + paramString() + "] on " + source;
 243   }
 244
 245   /**
 246    * Returns a string representation of the state of this event. It may be
 247    * empty, but must not be null; it is implementation defined.
 248    *
 249    * @return a string representation of this event
 250    */
 251   public String paramString()
 252   {
 253     return "";
 254   }
 255
 256   /**
 257    * Consumes this event so that it will not be processed in the default
 258    * manner.
 259    */
 260   protected void consume()
 261   {
 262     consumed = true;
 263   }
 264
 265   /**
 266    * Tests whether not not this event has been consumed. A consumed event
 267    * is not processed in the default manner.
 268    *
 269    * @return true if this event has been consumed
 270    */
 271   protected boolean isConsumed()
 272   {
 273     return consumed;
 274   }
 275 } // class AWTEvent