org.apache.xerces.domx.events
Interface EventTarget
- All Known Implementing Classes:
- NodeImpl
- public interface EventTarget
The EventTarget
interface is implemented by all
Node
s in an implementation which supports the DOM Event
Model. The interface allows registration and removal of
EventListener
s on an EventTarget
and dispatch of
events to that EventTarget
.
- Since:
- DOM Level 2
Method Summary |
void |
addEventListener(java.lang.String type,
EventListener listener,
boolean useCapture)
This method allows the registration of event listeners on the event
target. |
boolean |
dispatchEvent(Event evt)
This method allows the dispatch of events into the implementations event
model. |
void |
removeEventListener(java.lang.String type,
EventListener listener,
boolean useCapture)
This method allows the removal of event listeners from the event target. |
addEventListener
public void addEventListener(java.lang.String type,
EventListener listener,
boolean useCapture)
- This method allows the registration of event listeners on the event
target.
- Parameters:
type
- The event type for which the user is registeringlistener
- 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
EventTarget
s beneath them in the tree. Events which are
bubbling upward through the tree will not trigger an
EventListener
designated to use capture.
dispatchEvent
public boolean dispatchEvent(Event evt)
throws DOMException
- This method allows the dispatch of events into the implementations event
model. Events dispatched in this manner will have the same capturing
and bubbling behavior as events dispatched directly by the
implementation. The target of the event is the
EventTarget
on which dispatchEvent
is called.
- Parameters:
evt
- Specifies the event type, behavior, and contextual information
to be used in processing the event.- Returns:
- The return value of
dispatchEvent
indicates whether
any of the listeners which handled the event called
preventDefault
. If preventDefault
was
called the value is false, else the value is true. - Throws:
- DOMException - UNSPECIFIED_EVENT_TYPE: Raised if the
Event
's type was
not specified before dispatchEvent
was called.
removeEventListener
public 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
complete its current actions but will not be triggered again during any
later stages of event flow.
- 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 is a capturing listener or not.