Node

# GdomeSmartDOM::Node

The Node interface is the primary datatype for the entire Document Object Model. It represents a single node in the document tree. While all objects implementing the Node interface expose methods for dealing with children, not all objects implementing the Node interface may have children. For example, Text nodes may not have children, and adding children to such nodes results in a DOMException being raised. The attributes nodeName, nodeValue and attributes are 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 specific nodeType (e.g., nodeValue for an Element or attributes for a Comment), this returns null. Note that the specialized interfaces may contain additional and more convenient mechanisms to get and set the relevant information.

Default Constructor
Node(GdomeNode* = 0)
Creates a smart pointer for the Gdome element whose pointer is passed as an argument. The user should never pass a non-null pointer to this constructor.

Copy and Cast Constructors
Node(const Node&)
These constructors can be used to copy a smart pointer or to downcast it. If the downcasting is not possible, the resulting smart pointer will be null.

Copy Operator
Node& operator=(const Node&)

Equality
bool operator==(const Node&) const bool operator!=(const Node&) const
Two smart pointers are equal if they point to the same Gdome object.

Constants
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

Attributes
void* get_userData(void) const void set_userData(void*) const
Get and set the user data associated with this node.
DOMString get_nodeName(void) const
The name of this node, depending on its type; see the table above.
DOMString get_nodeValue(void) const void set_nodeValue(const DOMString& ) const
The value of this node, depending on its type; see the table above. When it is defined to be null, setting it has no effect.
unsigned short get_nodeType(void) const
A code representing the type of the underlying object, as defined above.
Node get_parentNode(void) const
The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation 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, this is null.
NodeList get_childNodes(void) const
A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.
Node get_firstChild(void) const
The first child of this node. If there is no such node, this returns null.
Node get_lastChild(void) const
The last child of this node. If there is no such node, this returns null.
Node get_previousSibling(void) const
The node immediately preceding this node. If there is no such node, this returns null.
Node get_nextSibling(void) const
The node immediately following this node. If there is no such node, this returns null.
NamedNodeMap get_attributes(void) const
A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
Document get_ownerDocument(void) const
The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.
DOMString get_namespaceURI(void) const
The namespace URI of this node, or null if 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_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null. Note: Per the Namespaces in XML Specification an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.
DOMString get_prefix(void) const void set_prefix(const DOMString& ) const
The namespace prefix of this node, or null if it is unspecified. Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, 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 namespaceURI and localName do not change. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.
DOMString get_localName(void) const
Returns the local part of the qualified name of this node. For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Methods
Node insertBefore(const Node& newChild, const Node& refChild) const
Parameters: newChild The node to insert. refChild The reference node, i.e., the node before which the new node must be inserted. Description: 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. Exceptions: 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 or if the parent of the node being inserted is readonly. NOT_FOUND_ERR: Raised if refChild is not a child of this node.
Node replaceChild(const Node& newChild, const Node& oldChild) const
Parameters: newChild The new node to put in the child list. oldChild The node being replaced in the list. Description: Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed. Exceptions: 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 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 or the parent of the new node is readonly. NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
Node removeChild(const Node& oldChild) const
Parameters: oldChild The node being removed. Description: Removes the child node indicated by oldChild from the list of children, and returns it. Exceptions: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
Node appendChild(const Node& newChild) const
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 Description: 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. Exceptions: 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.
bool hasChildNodes(void) const
Description: Returns whether this node has any children.
Node cloneNode(const booldeep) const
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). Description: Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent; (parentNode is 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 an Attribute directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute (specified is true). Cloning any other type of node simply returns a copy of this node. Note that cloning an immutable subtree results in a mutable copy, but the children of an EntityReference clone are readonly. In addition, clones of unspecified Attr nodes are specified. And, cloning Document, DocumentType, Entity, and Notation nodes is implementation dependent.
void normalize(void) const
Description: Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes. 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 CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.
bool isSupported(const DOMString& feature, const DOMString& version) const
Parameters: feature The name of the feature to test. This is the same name which can be passed to the method hasFeature on 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. Description: Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
bool hasAttributes(void) const
Description: Returns whether this node (if it is an element) has any attributes.

This file has been generated automatically on mar apr 9 10:53:25 CEST 2002 as part of GMetaDOM. For more information see the home page of the project, or contact the main author: luca.padovani@cs.unibo.it.