org.w3c.dom.events

Interface EventTarget

public interface EventTarget

The EventTarget interface is implemented by all Nodes in an implementation which supports the DOM Event Model. Therefore, this interface can be obtained by using binding-specific casting methods on an instance of the Node interface. The interface allows registration and removal of EventListeners on an EventTarget and dispatch of events to that EventTarget.

See also the Document Object Model (DOM) Level 2 Events Specification.

Since:

DOM Level 2

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventListener(java.lang.String type, EventListener listener, boolean useCapture) This method allows the registration of event listeners on the event target.
void	addEventListenerNS(java.lang.String namespaceURI, java.lang.String type, EventListener listener, boolean useCapture) This method allows the registration of an event listener in a specified group or the default group and, depending on the useCapture parameter, on the capture phase of the DOM event flow or its target and bubbling phases.
boolean	dispatchEvent(Event evt) This method allows the dispatch of events into the implementation's event model.
void	removeEventListener(java.lang.String type, EventListener listener, boolean useCapture) This method allows the removal of event listeners from the event target.
void	removeEventListenerNS(java.lang.String namespaceURI, java.lang.String type, EventListener listener, boolean useCapture) This method allows the removal of an event listener, independently of the associated event group.

Method Detail

addEventListener

void addEventListener(java.lang.String type,
                    EventListener listener,
                    boolean useCapture)

This method allows the registration of event listeners on the event target. If an EventListener is added to an EventTarget while it is processing an event, it will not be triggered by the current actions but may be triggered during a later stage of event flow, such as the bubbling phase.
If multiple identical EventListeners are registered on the same EventTarget with the same parameters the duplicate instances are discarded. They do not cause the EventListener to be called twice and since they are discarded they do not need to be removed with the removeEventListener method.

Parameters:

type - The event type for which the user is registering

listener - The listener parameter takes an interface implemented by the user which contains the methods to be called when the event occurs.

useCapture - If true, useCapture indicates that the user wishes to initiate capture. After initiating capture, all events of the specified type will be dispatched to the registered EventListener before being dispatched to any EventTargets beneath them in the tree. Events which are bubbling upward through the tree will not trigger an EventListener designated to use capture.

removeEventListener

void removeEventListener(java.lang.String type,
                       EventListener listener,
                       boolean useCapture)

This method allows the removal of event listeners from the event target. If an EventListener is removed from an EventTarget while it is processing an event, it will not be triggered by the current actions. EventListeners can never be invoked after being removed.
Calling removeEventListener with arguments which do not identify any currently registered EventListener on the EventTarget has no effect.

Parameters:

type - Specifies the event type of the EventListener being removed.

listener - The EventListener parameter indicates the EventListener to be removed.

useCapture - Specifies whether the EventListener being removed was registered as a capturing listener or not. If a listener was registered twice, one with capture and one without, each must be removed separately. Removal of a capturing listener does not affect a non-capturing version of the same listener, and vice versa.

addEventListenerNS

void addEventListenerNS(java.lang.String namespaceURI,
                      java.lang.String type,
                      EventListener listener,
                      boolean useCapture)

This method allows the registration of an event listener in a specified group or the default group and, depending on the useCapture parameter, on the capture phase of the DOM event flow or its target and bubbling phases.

Parameters:

namespaceURI - Specifies the Event.namespaceURI associated with the event for which the user is registering.

type - Refer to the EventTarget.addEventListener() method for a description of this parameter.

listener - Refer to the EventTarget.addEventListener() method for a description of this parameter.

useCapture - Refer to the EventTarget.addEventListener() method for a description of this parameter.

Since:

DOM Level 3

removeEventListenerNS

void removeEventListenerNS(java.lang.String namespaceURI,
                         java.lang.String type,
                         EventListener listener,
                         boolean useCapture)

This method allows the removal of an event listener, independently of the associated event group. Calling removeEventListenerNS with arguments which do not identify any currently registered EventListener on the EventTarget has no effect.

Parameters:

namespaceURI - Specifies the Event.namespaceURI associated with the event for which the user registered the event listener.

type - Refer to the EventTarget.removeEventListener() method for a description of this parameter.

listener - Refer to the EventTarget.removeEventListener() method for a description of this parameter.

useCapture - Refer to the EventTarget.removeEventListener() method for a description of this parameter.

Since:

DOM Level 3

dispatchEvent

boolean dispatchEvent(Event evt)
                      throws EventException,
                             DOMException

This method allows the dispatch of events into the implementation's event model. The event target of the event is the EventTarget object on which dispatchEvent is called.
Clarification: Independently on whether the event target supports the given event or not, Event must be dispatched to that event target. No checking on the semantic correctness of the request to dispatch the event object is performed by the implementation.

Parameters:

evt - The event to be dispatched.

Returns:

Indicates whether any of the listeners which handled the event called Event.preventDefault(). If Event.preventDefault() was called the returned value is false, else it is true.

Throws:

EventException - UNSPECIFIED_EVENT_TYPE_ERR: Raised if the Event.type was not specified by initializing the event before dispatchEvent was called. Specification of the Event.type as null or an empty string will also trigger this exception.
DISPATCH_REQUEST_ERR: Raised if the Event object is already being dispatched.

DOMException - NOT_SUPPORTED_ERR: Raised if the Event object has not been created using DocumentEvent.createEvent().
INVALID_CHARACTER_ERR: Raised if Event.type is not an NCName as defined in [ XML Namespaces 1.1].

Since:

DOM Level 3