Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIDOMEvent Interface Reference

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

import "nsIDOMEvent.idl";

Inheritance diagram for nsIDOMEvent:
Inheritance graph
[legend]
Collaboration diagram for nsIDOMEvent:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void stopPropagation ()
 The stopPropagation method is used prevent further propagation of an event during event flow.
void 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.
void initEvent (in DOMString eventTypeArg, in boolean canBubbleArg, in boolean cancelableArg)
 The initEvent method is used to initialize the value of an Event created through the DocumentEvent interface.

Public Attributes

const unsigned short CAPTURING_PHASE = 1
 The current event phase is the capturing phase.
const unsigned short AT_TARGET = 2
 The event is currently being evaluated at the target EventTarget.
const unsigned short BUBBLING_PHASE = 3
 The current event phase is the bubbling phase.
readonly attribute DOMString type
 The name of the event (case-insensitive).
readonly attribute
nsIDOMEventTarget 
target
 Used to indicate the EventTarget to which the event was originally dispatched.
readonly attribute
nsIDOMEventTarget 
currentTarget
 Used to indicate the EventTarget whose EventListeners are currently being processed.
readonly attribute unsigned short eventPhase
 Used to indicate which phase of event flow is currently being evaluated.
readonly attribute boolean bubbles
 Used to indicate whether or not an event is a bubbling event.
readonly attribute boolean cancelable
 Used to indicate whether or not an event can have its default action prevented.
readonly attribute DOMTimeStamp timeStamp
 Used to specify the time (in milliseconds relative to the epoch) at which the event was created.

Detailed Description

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

For more information on this interface please see http://www.w3.org/TR/DOM-Level-2-Events/

FROZEN

Definition at line 55 of file nsIDOMEvent.idl.


Member Function Documentation

void nsIDOMEvent::initEvent ( in DOMString  eventTypeArg,
in boolean  canBubbleArg,
in boolean  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:
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.

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.

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.


Member Data Documentation

const unsigned short nsIDOMEvent::AT_TARGET = 2

The event is currently being evaluated at the target EventTarget.

Definition at line 66 of file nsIDOMEvent.idl.

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.

Definition at line 102 of file nsIDOMEvent.idl.

const unsigned short nsIDOMEvent::BUBBLING_PHASE = 3

The current event phase is the bubbling phase.

Definition at line 71 of file nsIDOMEvent.idl.

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.

Definition at line 109 of file nsIDOMEvent.idl.

const unsigned short nsIDOMEvent::CAPTURING_PHASE = 1

The current event phase is the capturing phase.

Definition at line 61 of file nsIDOMEvent.idl.

Used to indicate the EventTarget whose EventListeners are currently being processed.

This is particularly useful during capturing and bubbling.

Definition at line 90 of file nsIDOMEvent.idl.

readonly attribute unsigned short nsIDOMEvent::eventPhase

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

Definition at line 96 of file nsIDOMEvent.idl.

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

Definition at line 83 of file nsIDOMEvent.idl.

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.

Definition at line 119 of file nsIDOMEvent.idl.

readonly attribute DOMString nsIDOMEvent::type

The name of the event (case-insensitive).

The name must be an XML name.

Definition at line 77 of file nsIDOMEvent.idl.


The documentation for this interface was generated from the following file: