class DOM_Node

The Node interface is the primary datatype for the entire Document Object Model

Inheritance:

Public

	Cloning function. DOM_Node cloneNode (bool deep) const Returns a duplicate of this node
	Constructors and assignment operators DOM_Node () Default constructor for DOM_Node DOM_Node (const DOM_Node &other) Copy constructor DOM_Node& operator = (const DOM_Node &other) Assignment operator DOM_Node& operator = (const DOM_NullPtr *val) Assignment operator
	Destructor. ~DOM_Node () Destructor for DOM_Node
	Equality and Inequality operators. bool operator == (const DOM_Node & other) const The equality operator bool operator == (const DOM_NullPtr *other) const Compare with a pointer bool operator != (const DOM_Node & other) const The inequality operator bool operator != (const DOM_NullPtr * other) const Compare with a pointer
	Functions to modify the DOM Node. DOM_Node insertBefore (const DOM_Node &newChild, const DOM_Node &refChild) Inserts the node newChild before the existing child node refChild DOM_Node replaceChild (const DOM_Node &newChild, const DOM_Node &oldChild) Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node DOM_Node removeChild (const DOM_Node &oldChild) Removes the child node indicated by oldChild from the list of children, and returns it DOM_Node appendChild (const DOM_Node &newChild) Adds the node newChild to the end of the list of children of this node
	Get functions. DOMString getNodeName () const The name of this node, depending on its type; see the table above DOMString getNodeValue () const Gets the value of this node, depending on its type short getNodeType () const An enum value representing the type of the underlying object DOM_Node getParentNode () const Gets the parent of this node DOM_NodeList getChildNodes () const Gets a NodeList that contains all children of this node DOM_Node getFirstChild () const Gets the first child of this node DOM_Node getLastChild () const Gets the last child of this node DOM_Node getPreviousSibling () const Gets the node immediately preceding this node DOM_Node getNextSibling () const Gets the node immediately following this node DOM_NamedNodeMap getAttributes () const Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise DOM_Document getOwnerDocument () const Gets the Document object associated with this node void* getUserData () const Return the user data pointer
	Query functions. bool hasChildNodes () const This is a convenience method to allow easy determination of whether a node has any children bool isNull () const Test whether this node is null
	Set functions. void setNodeValue (const DOMString &nodeValue) Sets the value of the node void setUserData (void *p) Set the user data for a node

Constructors and assignment operators

DOM_Node()

Default constructor for DOM_Node. The resulting object does not refer to an actual node; it will compare == to 0, and is similar to a null object reference variable in Java. It may subsequently be assigned to refer to an actual node. "Acutal Nodes" will always be of some derived type, such as Element or Attr.

DOM_Node(const DOM_Node &other)

Copy constructor.

Parameters:

other - The object to be copied.

DOM_Node& operator = (const DOM_Node &other)

Assignment operator.

Parameters:

other - The source to be assigned.

DOM_Node& operator = (const DOM_NullPtr *val)

Assignment operator. This overloaded variant is provided for the sole purpose of setting a DOM_Node reference variable to zero. Nulling out a reference variable in this way will decrement the reference count on the underlying Node object that the variable formerly referenced. This effect is normally obtained when reference variable goes out of scope, but zeroing them can be useful for global instances, or for local instances that will remain in scope for an extended time, when the storage belonging to the underlying node needs to be reclaimed.

Parameters:

val. - Only a value of 0, or null, is allowed.

Destructor.

~DOM_Node()

Destructor for DOM_Node. The object being destroyed is the reference object, not the underlying node itself.

Equality and Inequality operators.

bool operator == (const DOM_Node & other) const

The equality operator. This compares to references to nodes, and returns true if they both refer to the same underlying node. It is exactly analogous to Java's operator == on object reference variables. This operator can not be used to compare the values of two different nodes in the document tree.

Returns:

s True if both DOM_Nodes refer to the same actual node, or are both null; return false otherwise.

Parameters:

other - The object reference with which this object is compared

bool operator == (const DOM_NullPtr *other) const

Compare with a pointer. Intended only to allow a convenient comparison with null.

bool operator != (const DOM_Node & other) const

The inequality operator. See operator ==.

bool operator != (const DOM_NullPtr * other) const

Compare with a pointer. Intended only to allow a convenient comparison with null.

Get functions.

DOMString getNodeName() const

The name of this node, depending on its type; see the table above

DOMString getNodeValue() const

Gets the value of this node, depending on its type.

Throws:

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMException DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

short getNodeType() const

An enum value representing the type of the underlying object

DOM_Node getParentNode() const

Gets the parent of this node. All nodes, except Document, DocumentFragment, and Attr may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, a null DOM_Node is returned.

DOM_NodeList getChildNodes() const

Gets a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes. The content of the returned NodeList is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the NodeList accessors; it is not a static snapshot of the content of the node. This is true for every NodeList, including the ones returned by the getElementsByTagName method.

DOM_Node getFirstChild() const

Gets the first child of this node. If there is no such node, this returns null.

DOM_Node getLastChild() const

Gets the last child of this node. If there is no such node, this returns null.

DOM_Node getPreviousSibling() const

Gets the node immediately preceding this node. If there is no such node, this returns null.

DOM_Node getNextSibling() const

Gets the node immediately following this node. If there is no such node, this returns null.

DOM_NamedNodeMap getAttributes() const

Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise

DOM_Document getOwnerDocument() const

Gets the Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document this is null.

void* getUserData() const

Return the user data pointer. User data allows application programs to attach extra data to DOM nodes, and can be set using the function DOM_Node::setUserData(p).

Returns:

The user data pointer.

Cloning function.

DOM_Node cloneNode(bool deep) const

Returns a duplicate of this node. This function serves as a generic copy constructor for nodes. The duplicate node has no parent ( parentNode returns null.).
Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning any other type of node simply returns a copy of this node.

Returns:

The duplicate node.

Parameters:

deep - If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).

Functions to modify the DOM Node.

DOM_Node insertBefore(const DOM_Node &newChild, const DOM_Node &refChild)

Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.
If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed. Note that a DOM_Node that has never been assigned to refer to an actual node is == null.

Throws:

DOMException HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.

Returns:

The node being inserted.

Parameters:

newChild - The node to insert.
refChild - The reference node, i.e., the node before which the new node must be inserted.

DOM_Node replaceChild(const DOM_Node &newChild, const DOM_Node &oldChild)

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If the newChild is already in the tree, it is first removed.

Throws:

DOMException HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or it the node to put in is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

Returns:

The node replaced.

Parameters:

newChild - The new node to put in the child list.
oldChild - The node being replaced in the list.

DOM_Node removeChild(const DOM_Node &oldChild)

Removes the child node indicated by oldChild from the list of children, and returns it.

Throws:

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

Returns:

The node removed.

Parameters:

oldChild - The node being removed.

DOM_Node appendChild(const DOM_Node &newChild)

Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed.

Throws:

DOMException HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to append is one of this node's ancestors.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Returns:

The node added.

Parameters:

newChild - The node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node

Query functions.

bool hasChildNodes() const

This is a convenience method to allow easy determination of whether a node has any children.

Returns:

true if the node has any children, false if the node has no children.

bool isNull() const

Test whether this node is null. This C++ class, DOM_Node functions much like an object reference to an underlying Node, and this function tests for that reference being null. Several DOM APIs, Node.getNextSibling() for example, can return null, and this function is used to test for that condition.

Operator == provides another way to perform this null test on a DOM_Node.

Set functions.

void setNodeValue(const DOMString &nodeValue)

Sets the value of the node. Any node which can have a nodeValue (@see getNodeValue) will also accept requests to set it to a string. The exact response to this varies from node to node -- Attribute, for example, stores its values in its children and has to replace them with a new Text holding the replacement value. For most types of Node, value is null and attempting to set it will throw DOMException(NO_MODIFICATION_ALLOWED_ERR). This will also be thrown if the node is read-only.

void setUserData(void *p)

Set the user data for a node. User data allows application programs to attach extra data to DOM nodes, and can be retrieved using the function DOM_Node::getUserData(p).

Deletion of the user data remains the responsibility of the application program; it will not be automatically deleted when the nodes themselves are reclaimed.

Because DOM_Node is not designed to be subclassed, userdata provides an alternative means for extending the the information kept with nodes by an application program.

Parameters:

p - The pointer to be kept with the node.