Frames | No Frames |
1: 2: /* AWTEvent.java -- the root event in AWT 3: Copyright (C) 1999, 2000, 2002, 2005 Free Software Foundation 4: 5: This file is part of GNU Classpath. 6: 7: GNU Classpath is free software; you can redistribute it and/or modify 8: it under the terms of the GNU General Public License as published by 9: the Free Software Foundation; either version 2, or (at your option) 10: any later version. 11: 12: GNU Classpath is distributed in the hope that it will be useful, but 13: WITHOUT ANY WARRANTY; without even the implied warranty of 14: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15: General Public License for more details. 16: 17: You should have received a copy of the GNU General Public License 18: along with GNU Classpath; see the file COPYING. If not, write to the 19: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 20: 02110-1301 USA. 21: 22: Linking this library statically or dynamically with other modules is 23: making a combined work based on this library. Thus, the terms and 24: conditions of the GNU General Public License cover the whole 25: combination. 26: 27: As a special exception, the copyright holders of this library give you 28: permission to link this library with independent modules to produce an 29: executable, regardless of the license terms of these independent 30: modules, and to copy and distribute the resulting executable under 31: terms of your choice, provided that you also meet, for each linked 32: independent module, the terms and conditions of the license of that 33: module. An independent module is a module which is not derived from 34: or based on this library. If you modify this library, you may extend 35: this exception to your version of the library, but you are not 36: obligated to do so. If you do not wish to do so, delete this 37: exception statement from your version. */ 38: 39: 40: package java.awt; 41: 42: import java.awt.event.ActionEvent; 43: import java.awt.event.AdjustmentEvent; 44: import java.awt.event.ComponentEvent; 45: import java.awt.event.ContainerEvent; 46: import java.awt.event.FocusEvent; 47: import java.awt.event.InputMethodEvent; 48: import java.awt.event.InvocationEvent; 49: import java.awt.event.ItemEvent; 50: import java.awt.event.KeyEvent; 51: import java.awt.event.MouseEvent; 52: import java.awt.event.PaintEvent; 53: import java.awt.event.TextEvent; 54: import java.awt.event.WindowEvent; 55: import java.util.EventObject; 56: 57: /** 58: * AWTEvent is the root event class for all AWT events in the JDK 1.1 event 59: * model. It supersedes the Event class from JDK 1.0. Subclasses outside of 60: * the java.awt package should have IDs greater than RESERVED_ID_MAX. 61: * 62: * <p>Event masks defined here are used by components in 63: * <code>enableEvents</code> to select event types not selected by registered 64: * listeners. Event masks are appropriately set when registering on 65: * components. 66: * 67: * @author Warren Levy (warrenl@cygnus.com) 68: * @author Aaron M. Renn (arenn@urbanophile.com) 69: * @since 1.1 70: * @status updated to 1.4 71: */ 72: public abstract class AWTEvent extends EventObject 73: { 74: /** 75: * Compatible with JDK 1.1+. 76: */ 77: private static final long serialVersionUID = -1825314779160409405L; 78: 79: /** 80: * The ID of the event. 81: * 82: * @see #getID() 83: * @see #AWTEvent(Object, int) 84: * @serial the identifier number of this event 85: */ 86: protected int id; 87: 88: /** 89: * Indicates if the event has been consumed. False mean it is passed to 90: * the peer, true means it has already been processed. Semantic events 91: * generated by low-level events always have the value true. 92: * 93: * @see #consume() 94: * @see #isConsumed() 95: * @serial whether the event has been consumed 96: */ 97: protected boolean consumed; 98: 99: /** 100: * Who knows? It's in the serial version. 101: * 102: * @serial No idea what this is for. 103: */ 104: byte[] bdata; 105: 106: /** 107: * Indicates if this event is dispatched by the KeyboardFocusManager. 108: */ 109: boolean isFocusManagerEvent = false; 110: 111: /** Mask for selecting component events. */ 112: public static final long COMPONENT_EVENT_MASK = 0x00001; 113: 114: /** Mask for selecting container events. */ 115: public static final long CONTAINER_EVENT_MASK = 0x00002; 116: 117: /** Mask for selecting component focus events. */ 118: public static final long FOCUS_EVENT_MASK = 0x00004; 119: 120: /** Mask for selecting keyboard events. */ 121: public static final long KEY_EVENT_MASK = 0x00008; 122: 123: /** Mask for mouse button events. */ 124: public static final long MOUSE_EVENT_MASK = 0x00010; 125: 126: /** Mask for mouse motion events. */ 127: public static final long MOUSE_MOTION_EVENT_MASK = 0x00020; 128: 129: /** Mask for window events. */ 130: public static final long WINDOW_EVENT_MASK = 0x00040; 131: 132: /** Mask for action events. */ 133: public static final long ACTION_EVENT_MASK = 0x00080; 134: 135: /** Mask for adjustment events. */ 136: public static final long ADJUSTMENT_EVENT_MASK = 0x00100; 137: 138: /** Mask for item events. */ 139: public static final long ITEM_EVENT_MASK = 0x00200; 140: 141: /** Mask for text events. */ 142: public static final long TEXT_EVENT_MASK = 0x00400; 143: 144: /** 145: * Mask for input method events. 146: * @since 1.3 147: */ 148: public static final long INPUT_METHOD_EVENT_MASK = 0x00800; 149: 150: /** 151: * Mask if input methods are enabled. Package visible only. 152: */ 153: static final long INPUT_ENABLED_EVENT_MASK = 0x01000; 154: 155: /** 156: * Mask for paint events. 157: * @since 1.3 158: */ 159: public static final long PAINT_EVENT_MASK = 0x02000; 160: 161: /** 162: * Mask for invocation events. 163: * @since 1.3 164: */ 165: public static final long INVOCATION_EVENT_MASK = 0x04000; 166: 167: /** 168: * Mask for hierarchy events. 169: * @since 1.3 170: */ 171: public static final long HIERARCHY_EVENT_MASK = 0x08000; 172: 173: /** 174: * Mask for hierarchy bounds events. 175: * @since 1.3 176: */ 177: public static final long HIERARCHY_BOUNDS_EVENT_MASK = 0x10000; 178: 179: /** 180: * Mask for mouse wheel events. 181: * @since 1.4 182: */ 183: public static final long MOUSE_WHEEL_EVENT_MASK = 0x20000; 184: 185: /** 186: * Mask for window state events. 187: * @since 1.4 188: */ 189: public static final long WINDOW_STATE_EVENT_MASK = 0x40000; 190: 191: /** 192: * Mask for window focus events. 193: * @since 1.4 194: */ 195: public static final long WINDOW_FOCUS_EVENT_MASK = 0x80000; 196: 197: /** 198: * This is the highest number for event ids that are reserved for use by 199: * the AWT system itself. Subclasses outside of java.awt should use higher 200: * ids. 201: */ 202: public static final int RESERVED_ID_MAX = 1999; 203: 204: 205: /** 206: * Initializes a new AWTEvent from the old Java 1.0 event object. 207: * 208: * @param event the old-style event 209: * @throws NullPointerException if event is null 210: */ 211: public AWTEvent(Event event) 212: { 213: this(event.target, event.id); 214: consumed = event.consumed; 215: } 216: 217: /** 218: * Create an event on the specified source object and id. 219: * 220: * @param source the object that caused the event 221: * @param id the event id 222: * @throws IllegalArgumentException if source is null 223: */ 224: public AWTEvent(Object source, int id) 225: { 226: super(source); 227: this.id = id; 228: } 229: 230: /** 231: * Retarget the event, such as converting a heavyweight component to a 232: * lightweight child of the original. This is not for general use, but 233: * is for event targeting systems like KeyboardFocusManager. 234: * 235: * @param source the new source 236: */ 237: public void setSource(Object source) 238: { 239: this.source = source; 240: } 241: 242: /** 243: * Returns the event type id. 244: * 245: * @return the id number of this event 246: */ 247: public int getID() 248: { 249: return id; 250: } 251: 252: /** 253: * Create a string that represents this event in the format 254: * <code>classname[eventstring] on sourcecomponentname</code>. 255: * 256: * @return a string representing this event 257: */ 258: public String toString () 259: { 260: String string = getClass ().getName () + "[" + paramString () + "] on " 261: + source; 262: 263: return string; 264: } 265: 266: /** 267: * Returns a string representation of the state of this event. It may be 268: * empty, but must not be null; it is implementation defined. 269: * 270: * @return a string representation of this event 271: */ 272: public String paramString() 273: { 274: return ""; 275: } 276: 277: /** 278: * Consumes this event so that it will not be processed in the default 279: * manner. 280: */ 281: protected void consume() 282: { 283: consumed = true; 284: } 285: 286: /** 287: * Tests whether not not this event has been consumed. A consumed event 288: * is not processed in the default manner. 289: * 290: * @return true if this event has been consumed 291: */ 292: protected boolean isConsumed() 293: { 294: return consumed; 295: } 296: 297: /** 298: * Converts an event id to the appropriate event mask. 299: * 300: * @param id the event id 301: * 302: * @return the event mask for the specified id 303: */ 304: static long eventIdToMask(int id) 305: { 306: long mask = 0; 307: switch (id) 308: { 309: case ActionEvent.ACTION_PERFORMED: 310: mask = ACTION_EVENT_MASK; 311: break; 312: case AdjustmentEvent.ADJUSTMENT_VALUE_CHANGED: 313: mask = ADJUSTMENT_EVENT_MASK; 314: break; 315: case ComponentEvent.COMPONENT_MOVED: 316: case ComponentEvent.COMPONENT_RESIZED: 317: case ComponentEvent.COMPONENT_SHOWN: 318: case ComponentEvent.COMPONENT_HIDDEN: 319: mask = COMPONENT_EVENT_MASK; 320: break; 321: case ContainerEvent.COMPONENT_ADDED: 322: case ContainerEvent.COMPONENT_REMOVED: 323: mask = CONTAINER_EVENT_MASK; 324: break; 325: case FocusEvent.FOCUS_GAINED: 326: case FocusEvent.FOCUS_LOST: 327: mask = FOCUS_EVENT_MASK; 328: break; 329: case InputMethodEvent.INPUT_METHOD_TEXT_CHANGED: 330: case InputMethodEvent.CARET_POSITION_CHANGED: 331: mask = INPUT_METHOD_EVENT_MASK; 332: break; 333: case InvocationEvent.INVOCATION_DEFAULT: 334: mask = INVOCATION_EVENT_MASK; 335: break; 336: case ItemEvent.ITEM_STATE_CHANGED: 337: mask = ITEM_EVENT_MASK; 338: break; 339: case KeyEvent.KEY_TYPED: 340: case KeyEvent.KEY_PRESSED: 341: case KeyEvent.KEY_RELEASED: 342: mask = KEY_EVENT_MASK; 343: break; 344: case MouseEvent.MOUSE_CLICKED: 345: case MouseEvent.MOUSE_PRESSED: 346: case MouseEvent.MOUSE_RELEASED: 347: mask = MOUSE_EVENT_MASK; 348: break; 349: case MouseEvent.MOUSE_MOVED: 350: case MouseEvent.MOUSE_ENTERED: 351: case MouseEvent.MOUSE_EXITED: 352: case MouseEvent.MOUSE_DRAGGED: 353: mask = MOUSE_MOTION_EVENT_MASK; 354: break; 355: case MouseEvent.MOUSE_WHEEL: 356: mask = MOUSE_WHEEL_EVENT_MASK; 357: break; 358: case PaintEvent.PAINT: 359: case PaintEvent.UPDATE: 360: mask = PAINT_EVENT_MASK; 361: break; 362: case TextEvent.TEXT_VALUE_CHANGED: 363: mask = TEXT_EVENT_MASK; 364: break; 365: case WindowEvent.WINDOW_OPENED: 366: case WindowEvent.WINDOW_CLOSING: 367: case WindowEvent.WINDOW_CLOSED: 368: case WindowEvent.WINDOW_ICONIFIED: 369: case WindowEvent.WINDOW_DEICONIFIED: 370: case WindowEvent.WINDOW_ACTIVATED: 371: case WindowEvent.WINDOW_DEACTIVATED: 372: mask = WINDOW_EVENT_MASK; 373: break; 374: case WindowEvent.WINDOW_GAINED_FOCUS: 375: case WindowEvent.WINDOW_LOST_FOCUS: 376: mask = WINDOW_FOCUS_EVENT_MASK; 377: break; 378: case WindowEvent.WINDOW_STATE_CHANGED: 379: mask = WINDOW_STATE_EVENT_MASK; 380: break; 381: default: 382: mask = 0; 383: } 384: return mask; 385: } 386: } // class AWTEvent