nsIDOMEvent

IID:a66b7b80-ff46-bd97-0080-5f8ae38add32
Inherits From:nsISupports

Constants

The current event phase is the capturing phase.
PRUint16 CAPTURING_PHASE = 1
The event is currently being evaluated at the target EventTarget.
PRUint16 AT_TARGET = 2
The current event phase is the bubbling phase.
PRUint16 BUBBLING_PHASE = 3

Properties

readonly PRBool 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.

readonly PRBool 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.

readonly nsIDOMEventTarget currentTarget

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

readonly PRUint16 eventPhase

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

readonly nsIDOMEventTarget target

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

readonly DOMTimeStamp 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.

readonly DOMString type

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


Methods

void initEvent ( DOMString eventTypeArg , PRBool canBubbleArg , PRBool cancelableArg ) void preventDefault ( ) void stopPropagation ( )

void initEvent ( DOMString eventTypeArg , PRBool canBubbleArg , PRBool 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.

Arguments:
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.

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. 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.


void 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.


References

This interface is the type of the following properties:

nsIContextMenuInfo.mouseEvent

This interface is passed as an argument to the following methods:

nsIChromeEventHandler.handleChromeEvent, nsIClipboardDragDropHooks.allowDrop, nsIClipboardDragDropHooks.allowStartDrag, nsIClipboardDragDropHooks.onCopyOrDrag, nsIClipboardDragDropHooks.onPasteOrDrop, nsIContextMenuListener.onShowContextMenu, nsIDOMEventListener.handleEvent, nsIDOMEventTarget.dispatchEvent, nsIDOMJSWindow.routeEvent, nsIDOMNSHTMLDocument.routeEvent, nsIDOMSmartCardEvent.Init, nsIEditor.canDrag, nsIEditor.doDrag, nsIEditor.insertFromDrop, nsIHTMLEditor.canDrag, nsIHTMLEditor.doDrag, nsIHTMLEditor.insertFromDrop, nsIHTMLObjectResizer.mouseMove, nsIXTFElement.handleDefault

This interface is returned from the following methods:

nsIDOMDocumentEvent.createEvent

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com