|  | 
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members 
 DOM_Node  Class ReferenceTheNodeinterface is the primary datatype for the entire Document Object Model. 
More...
#include <DOM_Node.hpp> 
Inheritance diagram for DOM_Node  [legend]List of all members. 
| 
 Equality and Inequality operators. |  | enum | NodeType { ELEMENT_NODE = 1, 
ATTRIBUTE_NODE = 2, 
TEXT_NODE = 3, 
CDATA_SECTION_NODE = 4,
 ENTITY_REFERENCE_NODE = 5, 
ENTITY_NODE = 6, 
PROCESSING_INSTRUCTION_NODE = 7, 
COMMENT_NODE = 8,
 DOCUMENT_NODE = 9, 
DOCUMENT_TYPE_NODE = 10, 
DOCUMENT_FRAGMENT_NODE = 11, 
NOTATION_NODE = 12,
 XML_DECL_NODE = 13
 }
 |  | bool | operator== (const DOM_Node &other)const |  |  | The equality operator. More... 
 
 |  | bool | operator== (const DOM_NullPtr *other)const |  |  | Compare with a pointer. More... 
 
 |  | bool | operator!= (const DOM_Node &other)const |  |  | The inequality operator. More... 
 
 |  | bool | operator!= (const DOM_NullPtr *other)const |  |  | Compare with a pointer. More... 
 
 |  | 
 Public Methods |  |  |  |  | DOM_Node () |  |  | Default constructor for DOM_Node. More... 
 
 |  |  | DOM_Node (const DOM_Node &other) |  |  | Copy constructor. More... 
 
 |  | DOM_Node& | operator= (const DOM_Node &other) |  |  | Assignment operator. More... 
 
 |  | DOM_Node& | operator= (const DOM_NullPtr *val) |  |  | Assignment operator. More... 
 
 |  |  |  |  | ~DOM_Node () |  |  | Destructor for DOM_Node. More... 
 
 |  |  |  | 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. More... 
 
 |  | short | getNodeType ()const |  |  | An enum value representing the type of the underlying object. 
 
 |  | DOM_Node | getParentNode ()const |  |  | Gets the parent of this node. More... 
 
 |  | DOM_NodeList | getChildNodes ()const |  |  | Gets a NodeListthat contains all children of this node. More...
 
 |  | DOM_Node | getFirstChild ()const |  |  | Gets the first child of this node. More... 
 
 |  | DOM_Node | getLastChild ()const |  |  | Gets the last child of this node. More... 
 
 |  | DOM_Node | getPreviousSibling ()const |  |  | Gets the node immediately preceding this node. More... 
 
 |  | DOM_Node | getNextSibling ()const |  |  | Gets the node immediately following this node. More... 
 
 |  | DOM_NamedNodeMap | getAttributes ()const |  |  | Gets a NamedNodeMapcontaining the attributes of this node (if it is anElement) ornullotherwise.
 
 |  | DOM_Document | getOwnerDocument ()const |  |  | Gets the DOM_Documentobject associated with this node. More...
 
 |  | void* | getUserData ()const |  |  | Return the user data pointer. More... 
 
 |  |  |  | DOM_Node | cloneNode (bool deep)const |  |  | Returns a duplicate of this node. More... 
 
 |  |  |  | DOM_Node | insertBefore (const DOM_Node &newChild,const DOM_Node &refChild) |  |  | Inserts the node newChildbefore the existing child noderefChild. More...
 
 |  | DOM_Node | replaceChild (const DOM_Node &newChild,const DOM_Node &oldChild) |  |  | Replaces the child node oldChildwithnewChildin the list of children, and returns theoldChildnode. More...
 
 |  | DOM_Node | removeChild (const DOM_Node &oldChild) |  |  | Removes the child node indicated by oldChildfrom the list of children, and returns it. More...
 
 |  | DOM_Node | appendChild (const DOM_Node &newChild) |  |  | Adds the node newChildto the end of the list of children of this node. More...
 
 |  |  |  | bool | hasChildNodes ()const |  |  | This is a convenience method to allow easy determination of whether a node has any children. More... 
 
 |  | bool | isNull ()const |  |  | Test whether this node is null. More... 
 
 |  |  |  | void | setNodeValue (const DOMString &nodeValue) |  |  | Sets the value of the node. More... 
 
 |  | void | setUserData (void *p) |  |  | Set the user data for a node. More... 
 
 |  |  |  | void | normalize () |  |  | Puts all DOM_Textnodes in the full depth of the sub-tree underneath thisDOM_Node, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separatesDOM_Textnodes, i.e., there are neither adjacentDOM_Textnodes nor emptyDOM_Textnodes. More...
 
 |  | bool | supports (const DOMString &feature,const DOMString &version)const |  |  | Tests whether the DOM implementation implements a specific feature and that feature is supported by this node. More... 
 
 |  | DOMString | getNamespaceURI ()const |  |  | Get the namespace URI of this node, or nullif it is unspecified. More...
 
 |  | DOMString | getPrefix ()const |  |  | Get the namespace prefix of this node, or nullif it is unspecified. More...
 
 |  | DOMString | getLocalName ()const |  |  | Returns the local part of the qualified name of this node. More... 
 
 |  | void | setPrefix (const DOMString &prefix) |  |  | Set the namespace prefix of this node. More... 
 
 |  | 
 Protected Methods |  |  | DOM_Node (NodeImpl *) |  | 
 Protected Attributes |  | NodeImpl* | fImpl |  | 
 Friends |  | class | DOM_Document |  | class | DocumentImpl |  | class | TreeWalkerImpl |  | class | NodeIteratorImpl |  | class | DOM_NamedNodeMap |  | class | DOM_NodeList |  | class | DOMParser |  | class | DOM_Entity |  | class | RangeImpl |  | class | CharacterDataImpl |  | class | XUtil |  
 Detailed DescriptionTheNodeinterface is the primary datatype for the entire Document Object Model.
It represents a single node in the document tree. While all objects implementing the Nodeinterface expose methods for dealing with children, not all objects implementing theNodeinterface may have children. For example,Textnodes may not have children, and adding children to such nodes results in aDOMExceptionbeing raised. 
The attributes nodeName,nodeValueandattributesare included as a mechanism to get at node information without casting down to the specific derived interface. In cases where there is no obvious mapping of these attributes for a specificnodeType(e.g.,nodeValuefor an Element orattributesfor a Comment), this returnsnull. Note that the specialized interfaces may contain additional and more convenient mechanisms to get and set the relevant information. 
 
 Member Enumeration Documentation
 
  
    |  | 
 
Enumeration values:
| ELEMENT_NODE |  |  | ATTRIBUTE_NODE |  |  | TEXT_NODE |  |  | CDATA_SECTION_NODE |  |  | ENTITY_REFERENCE_NODE |  |  | ENTITY_NODE |  |  | PROCESSING_INSTRUCTION_NODE |  |  | COMMENT_NODE |  |  | DOCUMENT_NODE |  |  | DOCUMENT_TYPE_NODE |  |  | DOCUMENT_FRAGMENT_NODE |  |  | NOTATION_NODE |  |  | XML_DECL_NODE |  | 
 |  
 Constructor & Destructor Documentation
 
  
    |  | 
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::DOM_Node ( | const DOM_Node & other ) |  |  
  
    |  | 
Copy constructor.
 
 
Parameters: 
| other | The object to be copied. | 
 |  
 
  
    |  | 
Destructor for DOM_Node.
 
The object being destroyed is the reference object, not the underlying node itself.      |  
 
  
    | 
        
          | DOM_Node::DOM_Node ( | NodeImpl * )  [protected] |  |  
 Member Function Documentation
 
  
    | 
        
          | DOM_Node DOM_Node::appendChild ( | const DOM_Node & newChild ) |  |  
  
    |  | 
Adds the node newChildto the end of the list of children of this node. 
If the newChildis already in the tree, it is first removed. 
Parameters: 
| newChild | The node to add.If it is a DocumentFragmentobject, the entire contents of the document fragment are moved into the child list of this node | 
 
Returns: 
 The node added. 
 
Exceptions: 
| DOMException | HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChildnode, or if the node to append is one of this node's ancestors.WRONG_DOCUMENT_ERR: Raised if
 newChildwas created from a different document than the one that created this node.NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the node being appended is readonly.
 | 
 |  
 
  
    | 
        
          | DOM_Node 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 ( parentNodereturnsnull.).Cloning an
 Elementcopies 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 childTextnode. Cloning any other type of node simply returns a copy of this node. 
Parameters: 
| deep | If true, recursively clone the subtree under the specified node; iffalse, clone only the node itself (and its attributes, if it is anElement). | 
 
Returns: 
 The duplicate node. 
 |  
 
  
    |  | 
Gets a NamedNodeMapcontaining the attributes of this node (if it is anElement) ornullotherwise. 
     |  
 
  
    |  | 
Gets a NodeListthat contains all children of this node. 
If there are no children, this is a NodeListcontaining no nodes. The content of the returnedNodeListis "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 theNodeListaccessors; it is not a static snapshot of the content of the node. This is true for everyNodeList, including the ones returned by thegetElementsByTagNamemethod. 
Reimplemented in DOM_Entity.     |  
 
  
    | 
        
          | DOM_Node DOM_Node::getFirstChild ( | ) const |  |  
  
    |  | 
Gets the first child of this node.
 
If there is no such node, this returns null. 
Reimplemented in DOM_Entity.     |  
 
  
    | 
        
          | DOM_Node DOM_Node::getLastChild ( | ) const |  |  
  
    |  | 
Gets the last child of this node.
 
If there is no such node, this returns null. 
Reimplemented in DOM_Entity.     |  
 
  
    |  | 
Returns the local part of the qualified name of this node.
 
 
 For nodes created with a DOM Level 1 method, such as createElementfrom theDOM_Documentinterface, it is null. 
 
"Experimental - subject to change"      |  
 
  
    | 
        
          | DOMString DOM_Node::getNamespaceURI ( | ) const |  |  
  
    |  | 
Get the namespace URI of this node, or nullif it is unspecified. 
 
 This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time. 
 
 For nodes of any type other than ELEMENT_NODEandATTRIBUTE_NODEand nodes created with a DOM Level 1 method, such ascreateElementfrom theDOM_Documentinterface, this is alwaysnull. 
 
"Experimental - subject to change"      |  
 
  
    | 
        
          | DOM_Node DOM_Node::getNextSibling ( | ) const |  |  
  
    |  | 
Gets the node immediately following this node.
 
If there is no such node, this returns null. 
Reimplemented in DOM_Entity.     |  
 
  
    |  | 
The name of this node, depending on its type; see the table above.
 
     |  
 
  
    | 
        
          | short DOM_Node::getNodeType ( | ) const |  |  
  
    |  | 
An enum value representing the type of the underlying object.
 
     |  
 
  
    |  | 
Gets the value of this node, depending on its type.
 
 
Exceptions: 
| 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 DOMStringvariable on the implementation platform. | 
 |  
 
 
  
    | 
        
          | DOM_Node DOM_Node::getParentNode ( | ) const |  |  
  
    |  | 
Gets the parent of this node.
 
All nodes, except Document,DocumentFragment, andAttrmay 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, anullDOM_Node is returned. |  
 
  
    |  | 
Get the namespace prefix of this node, or nullif it is unspecified. 
 
"Experimental - subject to change"      |  
 
  
    | 
        
          | DOM_Node DOM_Node::getPreviousSibling ( | ) const |  |  
  
    |  | 
Gets the node immediately preceding this node.
 
If there is no such node, this returns null. 
Reimplemented in DOM_Entity.     |  
 
  
    | 
        
          | void * DOM_Node::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. 
 |  
 
  
    | 
        
          | bool DOM_Node::hasChildNodes ( | ) const |  |  
  
    |  | 
This is a convenience method to allow easy determination of whether a node has any children.
 
 
Returns: 
 trueif the node has any children,falseif the node has no children.
 
Reimplemented in DOM_Entity.     |  
 
  
    | 
        
          | DOM_Node DOM_Node::insertBefore ( | const DOM_Node & newChild, |  
          |  | const DOM_Node & refChild ) |  |  
  
    |  | 
Inserts the node newChildbefore the existing child noderefChild. 
If refChildisnull, insertnewChildat the end of the list of children.If
 newChildis aDocumentFragmentobject, all of its children are inserted, in the same order, beforerefChild. If thenewChildis already in the tree, it is first removed. Note that aDOM_Nodethat has never been assigned to refer to an actual node is == null. 
Parameters: 
| newChild | The node to insert. |  | refChild | The reference node, i.e., the node before which the new node must be inserted. | 
 
Returns: 
 The node being inserted. 
 
Exceptions: 
| DOMException | HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChildnode, or if the node to insert is one of this node's ancestors.WRONG_DOCUMENT_ERR: Raised if
 newChildwas created from a different document than the one that created this node.NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the node being inserted is readonly.
 NOT_FOUND_ERR: Raised if
 refChildis not a child of this node. | 
 |  
 
  
    | 
        
          | bool DOM_Node::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.      |  
 
  
    | 
        
          | void DOM_Node::normalize ( | ) |  |  
  
    |  | 
Puts all DOM_Textnodes in the full depth of the sub-tree underneath thisDOM_Node, including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separatesDOM_Textnodes, i.e., there are neither adjacentDOM_Textnodes nor emptyDOM_Textnodes. 
This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used. 
 
Note: In cases where the document contains DOM_CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate betweenDOM_Textnodes andDOM_CDATASectionnodes. 
 
"Experimental - subject to change"      |  
 
  
    | 
        
          | bool DOM_Node::operator!= ( | const DOM_NullPtr * other ) const |  |  
  
    |  | 
Compare with a pointer.
 
Intended only to allow a convenient comparison with null.      |  
 
  
    | 
        
          | bool DOM_Node::operator!= ( | const DOM_Node & other ) const |  |  
  
    |  | 
The inequality operator.
 
See operator ==.      |  
 
  
    | 
        
          | DOM_Node & 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. | 
 
Reimplemented in DOM_Attr, DOM_CDATASection, DOM_CharacterData, DOM_Comment, DOM_Document, DOM_DocumentFragment, DOM_DocumentType, DOM_Element, DOM_Entity, DOM_EntityReference, DOM_Notation, DOM_ProcessingInstruction, DOM_Text, and DOM_XMLDecl.     |  
 
  
    | 
        
          | DOM_Node & DOM_Node::operator= ( | const DOM_Node & other ) |  |  
  
    |  | 
Assignment operator.
 
 
Parameters: 
| other | The source to be assigned. | 
 |  
 
  
    | 
        
          | bool DOM_Node::operator== ( | const DOM_NullPtr * other ) const |  |  
  
    |  | 
Compare with a pointer.
 
Intended only to allow a convenient comparison with null.      |  
 
  
    | 
        
          | bool DOM_Node::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. 
Parameters: 
| other | The object reference with which thisobject is compared | 
 
Returns: 
 True if both DOM_Nodes refer to the same actual node, or are both null; return false otherwise.
 |  
 
  
    | 
        
          | DOM_Node DOM_Node::removeChild ( | const DOM_Node & oldChild ) |  |  
  
    |  | 
Removes the child node indicated by oldChildfrom the list of children, and returns it. 
 
Parameters: 
| oldChild | The node being removed. | 
 
Returns: 
 The node removed. 
 
Exceptions: 
| DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if
 oldChildis not a child of this node. | 
 |  
 
  
    | 
        
          | DOM_Node DOM_Node::replaceChild ( | const DOM_Node & newChild, |  
          |  | const DOM_Node & oldChild ) |  |  
  
    |  | 
Replaces the child node oldChildwithnewChildin the list of children, and returns theoldChildnode. 
If newChildis aDOM_DocumentFragmentobject,oldChildis replaced by all of theDOM_DocumentFragmentchildren, which are inserted in the same order. 
If the newChildis already in the tree, it is first removed. 
Parameters: 
| newChild | The new node to put in the child list. |  | oldChild | The node being replaced in the list. | 
 
Returns: 
 The node replaced. 
 
Exceptions: 
| DOMException | HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChildnode, or it the node to put in is one of this node's ancestors.WRONG_DOCUMENT_ERR: Raised if
 newChildwas created from a different document than the one that created this node.NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the new node is readonly.
 NOT_FOUND_ERR: Raised if
 oldChildis not a child of this node. | 
 |  
 
  
    | 
        
          | void DOM_Node::setNodeValue ( | const DOMString & nodeValue ) |  |  
  
    |  | 
Sets the value of the node.
 
Any node which can have a nodeValue ( 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.
See also: 
 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.
 |  
 
  
    | 
        
          | void DOM_Node::setPrefix ( | const DOMString & prefix ) |  |  
  
    |  | 
Set the namespace prefix of this node.
 
 
 Note that setting this attribute, when permitted, changes the nodeNameattribute, which holds the qualified name, as well as thetagNameandnameattributes of theDOM_ElementandDOM_Attrinterfaces, when applicable. 
 Note also that changing the prefix of an attribute, that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURIandlocalNamedo not change. 
 
"Experimental - subject to change" 
Parameters: 
| prefix | The prefix of this node. | 
 
Exceptions: 
| DOMException | INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
 NAMESPACE_ERR: Raised if the specified
 prefixis malformed, if thenamespaceURIof this node isnull, if the specified prefix is "xml" and thenamespaceURIof this node is different from "http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and thenamespaceURIof this node is different from "http://www.w3.org/2000/xmlns/", or if this node is an attribute and thequalifiedNameof this node is "xmlns". | 
 |  
 
  
    | 
        
          | void DOM_Node::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. | 
 |  
 
  
    |  | 
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
 
 
"Experimental - subject to change" 
Parameters: 
| feature | The string of the feature to test. This is the same name as what can be passed to the method hasFeatureonDOM_DOMImplementation. |  | version | This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true. | 
 
Returns: 
 Returns trueif the specified feature is supported on this node,falseotherwise.
 |  
 Friends And Related Function Documentation
 
  
    | 
        
          | class CharacterDataImpl  [friend] |  |  
 
 
  
    | 
        
          | class DOM_Document  [friend] |  |  
  
    |  | 
 
Reimplemented in DOM_Attr, DOM_CDATASection, DOM_Comment, DOM_DocumentFragment, DOM_DocumentType, DOM_Element, DOM_Entity, DOM_EntityReference, DOM_Notation, DOM_ProcessingInstruction, DOM_Text, and DOM_XMLDecl.     |  
 
  
    | 
        
          | class DOM_Entity  [friend] |  |  
 
  
    | 
        
          | class DOM_NamedNodeMap  [friend] |  |  
 
  
    | 
        
          | class DOM_NodeList  [friend] |  |  
 
  
    | 
        
          | class DocumentImpl  [friend] |  |  
 
  
    | 
        
          | class NodeIteratorImpl  [friend] |  |  
 
 
  
    | 
        
          | class TreeWalkerImpl  [friend] |  |  
 
 Member Data Documentation
 
  
    | 
        
          | NodeImpl * DOM_Node::fImpl  [protected] |  |  The documentation for this class was generated from the following file:
 |