* Copyright (c) 2000 World Wide Web Consortium,
* (Massachusetts Institute of Technology, Institut National de
* Recherche en Informatique et en Automatique, Keio University). All
* Rights Reserved. This program is distributed under the W3C's Software
* Intellectual Property License. This program is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY; without even
* the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* See W3C License http://www.w3.org/Consortium/Legal/ for more details.
Eventinterface is used to provide contextual information about an event to the handler processing the event. An object which implements the
Eventinterface is generally passed as the first parameter to an event handler. More specific context information is passed to event handlers by deriving additional interfaces from
Eventwhich contain information directly relating to the type of event they accompany. These derived interfaces are also implemented by the object passed to the event listener.
See also the.
timeStampmay be not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970.
stopPropagationmethod is used prevent further propagation of an event during event flow. If this method is called by any
EventListenerthe event will cease propagating through the tree. The event will complete dispatch to all listeners on the current
EventTargetbefore event flow stops. This method may be used during any stage of event flow.
preventDefaultmethod is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur. If, during any stage of event flow, the
preventDefaultmethod is called the event is canceled. Any default action associated with the event will not occur. Calling this method for a non-cancelable event has no effect. Once
preventDefaulthas been called it will remain in effect throughout the remainder of the event's propagation. This method may be used during any stage of event flow.
initEventmethod is used to initialize the value of an
Eventcreated through the
DocumentEventinterface. This method may only be called before the
Eventhas been dispatched via the
dispatchEventmethod, though it may be called multiple times during that phase if necessary. If called multiple times the final invocation takes precedence. If called from a subclass of
Eventinterface only the values specified in the
initEventmethod are modified, all other attributes are left unchanged.
eventTypeArgSpecifies the event type. This type may be any event type currently defined in this specification or a new event type.. The string must be an XML name. Any new event type must not begin with any upper, lower, or mixed case version of the string "DOM". This prefix is reserved for future DOM event sets. It is also strongly recommended that third parties adding their own events use their own prefix to avoid confusion and lessen the probability of conflicts with other new events.
canBubbleArgSpecifies whether or not the event can bubble.
cancelableArgSpecifies whether or not the event's default action can be prevented.