MutationEvent (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.w3c.dom.events
interface MutationEvent

All Superinterfaces:: Event

public interface MutationEvent
extends Event

The MutationEvent interface provides specific contextual information associated with Mutation events.

Field Summary
`static short`	`ADDITION` The `Attr` was just added.
`static short`	`MODIFICATION` The `Attr` was modified in place.
`static short`	`REMOVAL` The `Attr` was just removed.

Fields inherited from class org.w3c.dom.events.Event
`AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE`

Method Summary
`short`	`getAttrChange()` `attrChange` indicates the type of change which triggered the DOMAttrModified event.
`String`	`getAttrName()` `attrName` indicates the name of the changed `Attr` node in a DOMAttrModified event.
`String`	`getNewValue()` `newValue` indicates the new value of the `Attr` node in DOMAttrModified events, and of the `CharacterData` node in DOMCharacterDataModified events.
`String`	`getPrevValue()` `prevValue` indicates the previous value of the `Attr` node in DOMAttrModified events, and of the `CharacterData` node in DOMCharacterDataModified events.
`Node`	`getRelatedNode()` `relatedNode` is used to identify a secondary node related to a mutation event.
`void`	`initMutationEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, Node relatedNodeArg, String prevValueArg, String newValueArg, String attrNameArg, short attrChangeArg)` The `initMutationEvent` method is used to initialize the value of a `MutationEvent` created through the `DocumentEvent` interface.

Methods inherited from class org.w3c.dom.events.Event
`getBubbles, getCancelable, getCurrentTarget, getEventPhase, getTarget, getTimeStamp, getType, initEvent, preventDefault, stopPropagation`

Field Detail

ADDITION

public static final short ADDITION

The Attr was just added.

MODIFICATION

public static final short MODIFICATION

The Attr was modified in place.

REMOVAL

public static final short REMOVAL

The Attr was just removed.

Method Detail

getAttrChange

public short getAttrChange()

attrChange indicates the type of change which triggered the DOMAttrModified event. The values can be MODIFICATION , ADDITION, or REMOVAL.

getAttrName

public String getAttrName()

attrName indicates the name of the changed Attr node in a DOMAttrModified event.

getNewValue

public String getNewValue()

newValue indicates the new value of the Attr node in DOMAttrModified events, and of the CharacterData node in DOMCharacterDataModified events.

getPrevValue

public String getPrevValue()

prevValue indicates the previous value of the Attr node in DOMAttrModified events, and of the CharacterData node in DOMCharacterDataModified events.

getRelatedNode

public Node getRelatedNode()

relatedNode is used to identify a secondary node related to a mutation event. For example, if a mutation event is dispatched to a node indicating that its parent has changed, the relatedNode is the changed parent. If an event is instead dispatched to a subtree indicating a node was changed within it, the relatedNode is the changed node. In the case of the DOMAttrModified event it indicates the Attr node which was modified, added, or removed.

initMutationEvent

public void initMutationEvent(String typeArg,
                              boolean canBubbleArg,
                              boolean cancelableArg,
                              Node relatedNodeArg,
                              String prevValueArg,
                              String newValueArg,
                              String attrNameArg,
                              short attrChangeArg)

The initMutationEvent method is used to initialize the value of a MutationEvent created through the DocumentEvent interface. This method may only be called before the MutationEvent 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.

Parameters:: typeArg - Specifies the event type.; canBubbleArg - Specifies whether or not the event can bubble.; cancelableArg - Specifies whether or not the event's default action can be prevented.; relatedNodeArg - Specifies the Event's related Node.; prevValueArg - Specifies the Event's prevValue attribute. This value may be null.; newValueArg - Specifies the Event's newValue attribute. This value may be null.; attrNameArg - Specifies the Event's attrName attribute. This value may be null.; attrChangeArg - Specifies the Event's attrChange attribute