nsIDOMEvent

The nsIDOMEvent interface is the primary datatype for all events in
the Document Object Model.

For more information on this interface please see
http://dev.w3.org/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html and
http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html

Methods

stopPropagation()

The stopPropagation method is used prevent further propagation of an
event during event flow. If this method is called by any
EventListener the event will cease propagating through the tree. The
event will complete dispatch to all listeners on the current
EventTarget before event flow stops. This method may be used during
any stage of event flow.

preventDefault()

If an event is cancelable, the preventDefault method 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 preventDefault
method 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 preventDefault has 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.

initEvent(eventTypeArg, canBubbleArg, cancelableArg)

The initEvent method is used to initialize the value of an Event
created through the DocumentEvent interface. This method may only be
called before the Event has been dispatched via the dispatchEvent
method, 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 Event interface only the
values specified in the initEvent method are modified, all other
attributes are left unchanged.

Parameters

eventTypeArg	Specifies 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.
canBubbleArg	Specifies whether or not the event can bubble.
cancelableArg	Specifies whether or not the event's default action can be prevented.

stopImmediatePropagation()

Prevents other event listeners from being triggered and,
unlike Event.stopPropagation() its effect is immediate.

getPreventDefault()

@deprecated Use nsIDOMEvent::defaultPrevented.
To be removed in bug 691151.

duplicatePrivateData()

setTarget(aTarget)

IsDispatchStopped()

GetInternalNSEvent()

SetTrusted(aTrusted)

Serialize(aMsg, aSerializeInterfaceType)

Deserialize(aMsg, aIter)

SetOwner(aOwner)

InternalDOMEvent()

Attributes

type

The name of the event (case-insensitive). The name must be an XML
name.

target

Used to indicate the EventTarget to which the event was originally
dispatched.

currentTarget

Used to indicate the EventTarget whose EventListeners are currently
being processed. This is particularly useful during capturing and
bubbling.

eventPhase

Used to indicate which phase of event flow is currently being
evaluated.

bubbles

Used to indicate whether or not an event is a bubbling event. If the
event can bubble the value is true, else the value is false.

cancelable

Used to indicate whether or not an event can have its default action
prevented. If the default action can be prevented the value is true,
else the value is false.

timeStamp

Used to specify the time (in milliseconds relative to the epoch) at
which the event was created. Due to the fact that some systems may
not provide this information the value of timeStamp may 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.

defaultPrevented

Used to indicate whether preventDefault() has been called for this event.

originalTarget

The original target of the event, before any retargetings. */

explicitOriginalTarget

The explicit original target of the event. If the event was retargeted
for some reason other than an anonymous boundary crossing, this will be set
to the target before the retargeting occurs. For example, mouse events
are retargeted to their parent node when they happen over text nodes (bug
185889), and in that case .target will show the parent and
.explicitOriginalTarget will show the text node.
.explicitOriginalTarget differs from .originalTarget in that it will never
contain anonymous content.