org.w3c.dom.events

Interface MutationEvent

public interface MutationEvent extends Event

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

To create an instance of the MutationEvent interface, use the DocumentEvent.createEvent("MutationEvent") method call.

See also the Document Object Model (DOM) Level 3 Events Specification .

Since: DOM Level 2

Field Summary
static shortADDITION
The Attr was just added.
static shortMODIFICATION
The Attr was modified in place.
static shortREMOVAL
The Attr was just removed.
Method Summary
shortgetAttrChange()
attrChange indicates the type of change which triggered the DOMAttrModified event.
StringgetAttrName()
attrName indicates the name of the changed Attr node in a DOMAttrModified event.
StringgetNewValue()
newValue indicates the new value of the Attr node in DOMAttrModified events, and of the CharacterData node in DOMCharacterDataModified events.
StringgetPrevValue()
prevValue indicates the previous value of the Attr node in DOMAttrModified events, and of the CharacterData node in DOMCharacterDataModified events.
NodegetRelatedNode()
relatedNode is used to identify a secondary node related to a mutation event.
voidinitMutationEvent(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 object and has the same behavior as Event.initEvent().
voidinitMutationEventNS(String namespaceURI, String typeArg, boolean canBubbleArg, boolean cancelableArg, Node relatedNodeArg, String prevValueArg, String newValueArg, String attrNameArg, short attrChangeArg)
The initMutationEventNS method is used to initialize the value of a MutationEvent object and has the same behavior as Event.initEventNS().

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 object and has the same behavior as Event.initEvent().

Parameters: typeArg Refer to the Event.initEvent() method for a description of this parameter. canBubbleArg Refer to the Event.initEvent() method for a description of this parameter. cancelableArg Refer to the Event.initEvent() method for a description of this parameter. relatedNodeArg Specifies MutationEvent.relatedNode . prevValueArg Specifies MutationEvent.prevValue. This value may be null. newValueArg Specifies MutationEvent.newValue. This value may be null. attrNameArg Specifies MutationEvent.attrname. This value may be null. attrChangeArg Specifies MutationEvent.attrChange. This value may be null.

initMutationEventNS

public void initMutationEventNS(String namespaceURI, String typeArg, boolean canBubbleArg, boolean cancelableArg, Node relatedNodeArg, String prevValueArg, String newValueArg, String attrNameArg, short attrChangeArg)
The initMutationEventNS method is used to initialize the value of a MutationEvent object and has the same behavior as Event.initEventNS().

Parameters: namespaceURI Refer to the Event.initEventNS() method for a description of this parameter. typeArg Refer to the Event.initEventNS() method for a description of this parameter. canBubbleArg Refer to the Event.initEventNS() method for a description of this parameter. cancelableArg Refer to the Event.initEventNS() method for a description of this parameter. relatedNodeArg Refer to the MutationEvent.initMutationEvent() method for a description of this parameter. prevValueArg Refer to the MutationEvent.initMutationEvent() method for a description of this parameter. newValueArg Refer to the MutationEvent.initMutationEvent() method for a description of this parameter. attrNameArg Refer to the MutationEvent.initMutationEvent() method for a description of this parameter. attrChangeArg Refer to the MutationEvent.initMutationEvent() method for a description of this parameter.

Since: DOM Level 3

Copyright B) 2008 Apache Software Foundation. All Rights Reserved.