src/org/w3c/dom/events/EventTarget.java

Print this page
rev 602 : 8047723: @since tag cleanup in jaxp
Reviewed-by:


  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>EventTarget</code> interface is implemented by all
  46  * <code>Nodes</code> in an implementation which supports the DOM Event
  47  * Model. Therefore, this interface can be obtained by using
  48  * binding-specific casting methods on an instance of the <code>Node</code>
  49  * interface. The interface allows registration and removal of
  50  * <code>EventListeners</code> on an <code>EventTarget</code> and dispatch
  51  * of events to that <code>EventTarget</code>.
  52  * <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>.
  53  * @since DOM Level 2
  54  */
  55 public interface EventTarget {
  56     /**
  57      * This method allows the registration of event listeners on the event
  58      * target. If an <code>EventListener</code> is added to an
  59      * <code>EventTarget</code> while it is processing an event, it will not
  60      * be triggered by the current actions but may be triggered during a
  61      * later stage of event flow, such as the bubbling phase.
  62      * <br> If multiple identical <code>EventListener</code>s are registered
  63      * on the same <code>EventTarget</code> with the same parameters the
  64      * duplicate instances are discarded. They do not cause the
  65      * <code>EventListener</code> to be called twice and since they are
  66      * discarded they do not need to be removed with the
  67      * <code>removeEventListener</code> method.
  68      * @param type The event type for which the user is registering
  69      * @param listener The <code>listener</code> parameter takes an interface
  70      *   implemented by the user which contains the methods to be called
  71      *   when the event occurs.
  72      * @param useCapture If true, <code>useCapture</code> indicates that the
  73      *   user wishes to initiate capture. After initiating capture, all




  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>EventTarget</code> interface is implemented by all
  46  * <code>Nodes</code> in an implementation which supports the DOM Event
  47  * Model. Therefore, this interface can be obtained by using
  48  * binding-specific casting methods on an instance of the <code>Node</code>
  49  * interface. The interface allows registration and removal of
  50  * <code>EventListeners</code> on an <code>EventTarget</code> and dispatch
  51  * of events to that <code>EventTarget</code>.
  52  * <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>.
  53  * @since 1.5, DOM Level 2
  54  */
  55 public interface EventTarget {
  56     /**
  57      * This method allows the registration of event listeners on the event
  58      * target. If an <code>EventListener</code> is added to an
  59      * <code>EventTarget</code> while it is processing an event, it will not
  60      * be triggered by the current actions but may be triggered during a
  61      * later stage of event flow, such as the bubbling phase.
  62      * <br> If multiple identical <code>EventListener</code>s are registered
  63      * on the same <code>EventTarget</code> with the same parameters the
  64      * duplicate instances are discarded. They do not cause the
  65      * <code>EventListener</code> to be called twice and since they are
  66      * discarded they do not need to be removed with the
  67      * <code>removeEventListener</code> method.
  68      * @param type The event type for which the user is registering
  69      * @param listener The <code>listener</code> parameter takes an interface
  70      *   implemented by the user which contains the methods to be called
  71      *   when the event occurs.
  72      * @param useCapture If true, <code>useCapture</code> indicates that the
  73      *   user wishes to initiate capture. After initiating capture, all