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

public Interface UserDataHandler

When associating an object to a key on a node using Node.setUserData() the application can provide a handler that gets called when the node the object is associated to is being cloned, imported, or renamed. This can be used by the application to implement various behaviors regarding the data it associates to the DOM nodes. This interface defines that handler.

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

Since
1.5, DOM Level 3

Field Summary

Modifier and TypeField and Description
public static final short
NODE_ADOPTED

The node is adopted, using Document.adoptNode().

public static final short
NODE_CLONED

The node is cloned, using Node.cloneNode().

public static final short
NODE_DELETED

The node is deleted.

public static final short
NODE_IMPORTED

The node is imported, using Document.importNode().

public static final short
NODE_RENAMED

The node is renamed, using Document.renameNode().

Method Summary

Modifier and TypeMethod and Description
public void
handle(short
Specifies the type of operation that is being performed on the node.
operation, String
Specifies the key for which this handler is being called.
key, Object
Specifies the data for which this handler is being called.
data, Node
Specifies the node being cloned, adopted, imported, or renamed. This is null when the node is being deleted.
src, Node
Specifies the node newly created if any, or null.
dst)

This method is called whenever the node for which this handler is registered is imported or cloned.

Field Detail

NODE_ADOPTEDback to summary
public static final short NODE_ADOPTED

The node is adopted, using Document.adoptNode().

NODE_CLONEDback to summary
public static final short NODE_CLONED

The node is cloned, using Node.cloneNode().

NODE_DELETEDback to summary
public static final short NODE_DELETED

The node is deleted.

Note

This may not be supported or may not be reliable in certain environments, such as Java, where the implementation has no real control over when objects are actually deleted.

NODE_IMPORTEDback to summary
public static final short NODE_IMPORTED

The node is imported, using Document.importNode().

NODE_RENAMEDback to summary
public static final short NODE_RENAMED

The node is renamed, using Document.renameNode().

Method Detail

handleback to summary
public void handle(short operation, String key, Object data, Node src, Node dst)

This method is called whenever the node for which this handler is registered is imported or cloned.
DOM applications must not raise exceptions in a UserDataHandler. The effect of throwing exceptions from the handler is DOM implementation dependent.

Parameters
operation:short

Specifies the type of operation that is being performed on the node.

key:String

Specifies the key for which this handler is being called.

data:Object

Specifies the data for which this handler is being called.

src:Node

Specifies the node being cloned, adopted, imported, or renamed. This is null when the node is being deleted.

dst:Node

Specifies the node newly created if any, or null.