01 /*
02 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
03 *
04 * This code is free software; you can redistribute it and/or modify it
05 * under the terms of the GNU General Public License version 2 only, as
06 * published by the Free Software Foundation. Sun designates this
07 * particular file as subject to the "Classpath" exception as provided
08 * by Sun in the LICENSE file that accompanied this code.
09 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
22 * have any questions.
23 */
24
25 /*
26 * This file is available under and governed by the GNU General Public
27 * License version 2 only, as published by the Free Software Foundation.
28 * However, the following notice accompanied the original version of this
29 * file and, per its terms, should not be removed:
30 *
31 * Copyright (c) 2000 World Wide Web Consortium,
32 * (Massachusetts Institute of Technology, Institut National de
33 * Recherche en Informatique et en Automatique, Keio University). All
34 * Rights Reserved. This program is distributed under the W3C's Software
35 * Intellectual Property License. This program is distributed in the
36 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
37 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
38 * PURPOSE.
39 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
40 */
41
42 package org.w3c.dom.events;
43
44 /**
45 * The <code>EventListener</code> interface is the primary method for
46 * handling events. Users implement the <code>EventListener</code> interface
47 * and register their listener on an <code>EventTarget</code> using the
48 * <code>AddEventListener</code> method. The users should also remove their
49 * <code>EventListener</code> from its <code>EventTarget</code> after they
50 * have completed using the listener.
51 * <p> When a <code>Node</code> is copied using the <code>cloneNode</code>
52 * method the <code>EventListener</code>s attached to the source
53 * <code>Node</code> are not attached to the copied <code>Node</code>. If
54 * the user wishes the same <code>EventListener</code>s to be added to the
55 * newly created copy the user must add them manually.
56 * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113'>Document Object Model (DOM) Level 2 Events Specification</a>.
57 * @since DOM Level 2
58 */
59 public interface EventListener {
60 /**
61 * This method is called whenever an event occurs of the type for which
62 * the <code> EventListener</code> interface was registered.
63 * @param evt The <code>Event</code> contains contextual information
64 * about the event. It also contains the <code>stopPropagation</code>
65 * and <code>preventDefault</code> methods which are used in
66 * determining the event's flow and default action.
67 */
68 public void handleEvent(Event evt);
69
70 }
|