diff options
Diffstat (limited to 'libjava/java/awt/AWTEvent.java')
| -rw-r--r-- | libjava/java/awt/AWTEvent.java | 164 |
1 files changed, 140 insertions, 24 deletions
diff --git a/libjava/java/awt/AWTEvent.java b/libjava/java/awt/AWTEvent.java index 0717f6d..cb37b64 100644 --- a/libjava/java/awt/AWTEvent.java +++ b/libjava/java/awt/AWTEvent.java @@ -1,10 +1,28 @@ -/* Copyright (C) 1999, 2000 Free Software Foundation +/* Copyright (C) 1999, 2000, 2002 Free Software Foundation - This file is part of libgcj. +This file is part of GNU Classpath. + +GNU Classpath is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2, or (at your option) +any later version. + +GNU Classpath is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with GNU Classpath; see the file COPYING. If not, write to the +Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA +02111-1307 USA. + +As a special exception, if you link this library with other files to +produce an executable, this library does not by itself cause the +resulting executable to be covered by the GNU General Public License. +This exception does not however invalidate any other reasons why the +executable file might be covered by the GNU General Public License. */ -This software is copyrighted work licensed under the terms of the -Libgcj License. Please consult the file "LIBGCJ_LICENSE" for -details. */ package java.awt; @@ -18,26 +36,83 @@ package java.awt; /** * AWTEvent is the root event class for all AWT events in the JDK 1.1 event * model. It supersedes the Event class from JDK 1.0. + * @author Warren Levy <warrenl@cygnus.com> + * @author Aaron M. Renn (arenn@urbanophile.com) */ - public abstract class AWTEvent extends java.util.EventObject { + /** + * @serial Indicates whether or not this event has been consumed. + */ protected boolean consumed; + + /** + * @serial The identifier number of this event. + */ protected int id; - /* Event selection masks */ - public static final long COMPONENT_EVENT_MASK = 1 << 0, - CONTAINER_EVENT_MASK = 1 << 1, - FOCUS_EVENT_MASK = 1 << 2, - KEY_EVENT_MASK = 1 << 3, - MOUSE_EVENT_MASK = 1 << 4, - MOUSE_MOTION_EVENT_MASK = 1 << 5, - WINDOW_EVENT_MASK = 1 << 6, - ACTION_EVENT_MASK = 1 << 7, - ADJUSTMENT_EVENT_MASK = 1 << 8, - ITEM_EVENT_MASK = 1 << 9, - TEXT_EVENT_MASK = 1 << 10, - INPUT_METHOD_EVENT_MASK = 1 << 11; + /** + * Mask for selecting component events. + */ + public static final long COMPONENT_EVENT_MASK = 0x001; + + /** + * Mask for selecting container events. + */ + public static final long CONTAINER_EVENT_MASK = 0x002; + + /** + * Mask for selecting component focus events. + */ + public static final long FOCUS_EVENT_MASK = 0x004; + + /** + * Mask for selecting keyboard events. + */ + public static final long KEY_EVENT_MASK = 0x008; + + /** + * Mask for mouse button events. + */ + public static final long MOUSE_EVENT_MASK = 0x010; + + /** + * Mask for mouse motion events. + */ + public static final long MOUSE_MOTION_EVENT_MASK = 0x020; + + /** + * Mask for window events. + */ + public static final long WINDOW_EVENT_MASK = 0x040; + + /** + * Mask for action events. + */ + public static final long ACTION_EVENT_MASK = 0x080; + + /** + * Mask for adjustment events. + */ + public static final long ADJUSTMENT_EVENT_MASK = 0x100; + + /** + * Mask for item events. + */ + public static final long ITEM_EVENT_MASK = 0x200; + + /** + * Mask for text events. + */ + public static final long TEXT_EVENT_MASK = 0x400; + + /** + * This is the highest number for event ids that are reserved for use by + * the AWT system itself. + */ + public static final int RESERVED_ID_MAX = 1999; + + public static final long INPUT_METHOD_EVENT_MASK = 1 << 11; /* Additional event selection masks from JDK 1.3 javadocs */ public static final long PAINT_EVENT_MASK = 1 << 13, @@ -45,41 +120,82 @@ public abstract class AWTEvent extends java.util.EventObject HIERARCHY_EVENT_MASK = 1 << 15, HIERARCHY_BOUNDS_EVENT_MASK = 1 << 16; - public static final int RESERVED_ID_MAX = 0x7cf; - + /** + * Initializes a new instance of <code>AWTEvent</code> from the + * specified Java 1.0 event object. + * + * @param event The Java 1.0 event to initialize from. + * + * + * Removed this method because we no longer support Java 1.0 + * + */ public AWTEvent(Event event) { // FIXME?? super(event.target); this.id = event.id; } - + + /** + * Initializes a new instance of <code>AWTEvent</code> with the specified + * source and id. + * + * @param source The object that caused the event. + * @param id The event id. + */ public AWTEvent(Object source, int id) { super(source); this.id = id; } + /** + * Returns the id number of this event. + * + * @return The id number of this event. + */ public int getID() { return id; } + /** + * Returns a string representation of this event. + * + * @return A string representation of this event. + */ public String paramString () { return ""; } + /** + * Returns a string representation of this event. + * + * @return A string representation of this event. + */ public String toString () { return getClass().getName() + "[" + paramString() + "] on " + source; } - + + /** + * Consumes this event so that it will not be processed in the default + * manner. + */ protected void consume() { consumed = true; } - + + /** + * Tests whether not not this event has been consumed. A consumed event + * is not processed in the default manner. + * + * @return <code>true</code> if this event has been consumed, + * <code>false</code> otherwise. + */ protected boolean isConsumed() { return consumed; |