MutationEvent

This object is available to unprivileged JavaScript. It implements the following interfaces:

Constants

The current event phase is the capturing phase.
short CAPTURING_PHASE = 1
The event is currently being evaluated at the target EventTarget.
short AT_TARGET = 2
The current event phase is the bubbling phase.
short BUBBLING_PHASE = 3
short MODIFICATION = 1
short ADDITION = 2
short REMOVAL = 3
PRInt32 MOUSEDOWN = 1
PRInt32 MOUSEUP = 2
PRInt32 MOUSEOVER = 4
PRInt32 MOUSEOUT = 8
PRInt32 MOUSEMOVE = 16
PRInt32 MOUSEDRAG = 32
PRInt32 CLICK = 64
PRInt32 DBLCLICK = 128
PRInt32 KEYDOWN = 256
PRInt32 KEYUP = 512
PRInt32 KEYPRESS = 1024
PRInt32 DRAGDROP = 2048
PRInt32 FOCUS = 4096
PRInt32 BLUR = 8192
PRInt32 SELECT = 16384
PRInt32 CHANGE = 32768
PRInt32 RESET = 65536
PRInt32 SUBMIT = 131072
PRInt32 SCROLL = 262144
PRInt32 LOAD = 524288
PRInt32 UNLOAD = 1048576
PRInt32 XFER_DONE = 2097152
PRInt32 ABORT = 4194304
PRInt32 ERROR = 8388608
PRInt32 LOCATE = 16777216
PRInt32 MOVE = 33554432
PRInt32 RESIZE = 67108864
PRInt32 FORWARD = 134217728
PRInt32 HELP = 268435456
PRInt32 BACK = 536870912
PRInt32 TEXT = 1073741824
PRInt32 ALT_MASK = 1
PRInt32 CONTROL_MASK = 2
PRInt32 SHIFT_MASK = 4
PRInt32 META_MASK = 8

Properties

readonly short attrChange

readonly String attrName

readonly boolean 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 boolean 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 EventTarget currentTarget

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

readonly short eventPhase

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

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

readonly boolean isTrusted

readonly String newValue

readonly EventTarget originalTarget

readonly String prevValue

readonly Node relatedNode

readonly EventTarget 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 EventTarget tmpRealOriginalTarget

readonly String type

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


Methods

void initEvent ( String eventTypeArg , boolean canBubbleArg , boolean cancelableArg ) void initMutationEvent ( String typeArg , boolean canBubbleArg , boolean cancelableArg , Node relatedNodeArg , String prevValueArg , String newValueArg , String attrNameArg , short attrChangeArg ) void preventBubble ( ) void preventCapture ( ) void preventDefault ( ) void stopPropagation ( )

void initEvent ( String eventTypeArg , boolean canBubbleArg , 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.

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 initMutationEvent ( String typeArg , boolean canBubbleArg , boolean cancelableArg , Node relatedNodeArg , String prevValueArg , String newValueArg , String attrNameArg , short attrChangeArg )

Arguments:
typeArg
canBubbleArg
cancelableArg
relatedNodeArg
prevValueArg
newValueArg
attrNameArg
attrChangeArg

void preventBubble ( )


void preventCapture ( )


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.

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com