W3cubDocs

/OpenJDK 21

Interface MutationEvent

All Superinterfaces:
Event
public interface MutationEvent extends Event
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 Type Field Description
static final short ADDITION
The Attr was just added.
static final short MODIFICATION
The Attr was modified in place.
static final short REMOVAL
The Attr was just removed.

Fields declared in interface org.w3c.dom.events.Event

AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE

Method Summary

Modifier and Type Method Description
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 declared in interface org.w3c.dom.events.Event

getBubbles, getCancelable, getCurrentTarget, getEventPhase, getTarget, getTimeStamp, getType, initEvent, preventDefault, stopPropagation

Field Details

MODIFICATION

static final short MODIFICATION
The Attr was modified in place.
See Also:

ADDITION

static final short ADDITION
The Attr was just added.
See Also:

REMOVAL

static final short REMOVAL
The Attr was just removed.
See Also:

Method Details

getRelatedNode

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.

getPrevValue

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

getNewValue

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

getAttrName

String getAttrName()
attrName indicates the name of the changed Attr node in a DOMAttrModified event.

getAttrChange

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

initMutationEvent

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

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/org/w3c/dom/events/MutationEvent.html