APIdia Launch Partner
Top Description Fields Methods
org.w3c.dom.events

public Interface MutationEvent

extends Event
Known Direct Implementers
com.sun.org.apache.xerces.internal.dom.events.MutationEventImpl
Imports
org.w3c.dom.Node

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

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

Since
1.5, DOM Level 2

Field Summary

Modifier and TypeField and Description
public static final short
ADDITION

The Attr was just added.

public static final short
MODIFICATION

The Attr was modified in place.

public static final short
REMOVAL

The Attr was just removed.

Inherited from org.w3c.dom.events.Event:
AT_TARGETBUBBLING_PHASECAPTURING_PHASE

Method Summary

Modifier and TypeMethod and Description
public short
getAttrChange()

attrChange indicates the type of change which triggered the DOMAttrModified event.

public String
getAttrName()

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

public String
getNewValue()

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

public String
getPrevValue()

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

public Node
getRelatedNode()

relatedNode is used to identify a secondary node related to a mutation event.

public void
initMutationEvent(String
Specifies the event type.
typeArg
,
boolean
Specifies whether or not the event can bubble.
canBubbleArg
,
boolean
Specifies whether or not the event's default action can be prevented.
cancelableArg
,
Node
Specifies the Event's related Node.
relatedNodeArg
,
String
Specifies the Event's prevValue attribute. This value may be null.
prevValueArg
,
String
Specifies the Event's newValue attribute. This value may be null.
newValueArg
,
String
Specifies the Event's attrName attribute. This value may be null.
attrNameArg
,
short
Specifies the Event's attrChange attribute
attrChangeArg
)

The initMutationEvent method is used to initialize the value of a MutationEvent created through the DocumentEvent interface.

Inherited from org.w3c.dom.events.Event:
getBubblesgetCancelablegetCurrentTargetgetEventPhasegetTargetgetTimeStampgetTypeinitEventpreventDefaultstopPropagation

Field Detail

ADDITIONback to summary
public static final short ADDITION

The Attr was just added.

MODIFICATIONback to summary
public static final short MODIFICATION

The Attr was modified in place.

REMOVALback to summary
public static final short REMOVAL

The Attr was just removed.

Method Detail

getAttrChangeback to summary
public short getAttrChange()

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

getAttrNameback to summary
public String getAttrName()

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

getNewValueback to summary
public String getNewValue()

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

getPrevValueback to summary
public String getPrevValue()

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

getRelatedNodeback to summary
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.

initMutationEventback to summary
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:String

Specifies the event type.

canBubbleArg:boolean

Specifies whether or not the event can bubble.

cancelableArg:boolean

Specifies whether or not the event's default action can be prevented.

relatedNodeArg:Node

Specifies the Event's related Node.

prevValueArg:String

Specifies the Event's prevValue attribute. This value may be null.

newValueArg:String

Specifies the Event's newValue attribute. This value may be null.

attrNameArg:String

Specifies the Event's attrName attribute. This value may be null.

attrChangeArg:short

Specifies the Event's attrChange attribute