public
interface
UserDataHandler
| org.w3c.dom.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.
Constants | |
|---|---|
short |
NODE_ADOPTED
The node is adopted, using |
short |
NODE_CLONED
The node is cloned, using |
short |
NODE_DELETED
The node is deleted. |
short |
NODE_IMPORTED
The node is imported, using |
short |
NODE_RENAMED
The node is renamed, using |
Public methods | |
|---|---|
abstract
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. |
short NODE_ADOPTED
The node is adopted, using Document.adoptNode().
Constant Value: 5 (0x00000005)
short NODE_CLONED
The node is cloned, using Node.cloneNode().
Constant Value: 1 (0x00000001)
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.
Constant Value: 3 (0x00000003)
short NODE_IMPORTED
The node is imported, using Document.importNode().
Constant Value: 2 (0x00000002)
short NODE_RENAMED
The node is renamed, using Document.renameNode().
Constant Value: 4 (0x00000004)
Developers
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.
|