| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2001-2007 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package java.awt.event; |
| 27 | |
| 28 | import java.util.EventListenerProxy; |
| 29 | import java.awt.AWTEvent; |
| 30 | |
| 31 | /** |
| 32 | * A class which extends the {@code EventListenerProxy} |
| 33 | * specifically for adding an {@code AWTEventListener} |
| 34 | * for a specific event mask. |
| 35 | * Instances of this class can be added as {@code AWTEventListener}s |
| 36 | * to a {@code Toolkit} object. |
| 37 | * <p> |
| 38 | * The {@code getAWTEventListeners} method of {@code Toolkit} |
| 39 | * can return a mixture of {@code AWTEventListener} |
| 40 | * and {@code AWTEventListenerProxy} objects. |
| 41 | * |
| 42 | * @see java.awt.Toolkit |
| 43 | * @see java.util.EventListenerProxy |
| 44 | * @since 1.4 |
| 45 | */ |
| 46 | public class AWTEventListenerProxy |
| 47 | extends EventListenerProxy<AWTEventListener> |
| 48 | implements AWTEventListener { |
| 49 | |
| 50 | private final long eventMask; |
| 51 | |
| 52 | /** |
| 53 | * Constructor which binds the {@code AWTEventListener} |
| 54 | * to a specific event mask. |
| 55 | * |
| 56 | * @param eventMask the bitmap of event types to receive |
| 57 | * @param listener the listener object |
| 58 | */ |
| 59 | public AWTEventListenerProxy (long eventMask, AWTEventListener listener) { |
| 60 | super(listener); |
| 61 | this.eventMask = eventMask; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Forwards the AWT event to the listener delegate. |
| 66 | * |
| 67 | * @param event the AWT event |
| 68 | */ |
| 69 | public void eventDispatched(AWTEvent event) { |
| 70 | getListener().eventDispatched(event); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Returns the event mask associated with the listener. |
| 75 | * |
| 76 | * @return the event mask associated with the listener |
| 77 | */ |
| 78 | public long getEventMask() { |
| 79 | return this.eventMask; |
| 80 | } |
| 81 | } |