Xerces-C++
3.1.2
|
By far the vast majority of objects (apart from text) that authors encounter when traversing a document are DOMElement
nodes.
More...
Public Member Functions | |
Destructor | |
virtual | ~DOMElement () |
Destructor. More... | |
Functions introduced in DOM Level 1 | |
virtual const XMLCh * | getTagName () const =0 |
The name of the element. More... | |
virtual const XMLCh * | getAttribute (const XMLCh *name) const =0 |
Retrieves an attribute value by name. More... | |
virtual DOMAttr * | getAttributeNode (const XMLCh *name) const =0 |
Retrieves an DOMAttr node by name. More... | |
virtual DOMNodeList * | getElementsByTagName (const XMLCh *name) const =0 |
Returns a DOMNodeList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the DOMElement tree. More... | |
virtual void | setAttribute (const XMLCh *name, const XMLCh *value)=0 |
Adds a new attribute. More... | |
virtual DOMAttr * | setAttributeNode (DOMAttr *newAttr)=0 |
Adds a new attribute. More... | |
virtual DOMAttr * | removeAttributeNode (DOMAttr *oldAttr)=0 |
Removes the specified attribute node. More... | |
virtual void | removeAttribute (const XMLCh *name)=0 |
Removes an attribute by name. More... | |
Functions introduced in DOM Level 2. | |
virtual const XMLCh * | getAttributeNS (const XMLCh *namespaceURI, const XMLCh *localName) const =0 |
Retrieves an attribute value by local name and namespace URI. More... | |
virtual void | setAttributeNS (const XMLCh *namespaceURI, const XMLCh *qualifiedName, const XMLCh *value)=0 |
Adds a new attribute. More... | |
virtual void | removeAttributeNS (const XMLCh *namespaceURI, const XMLCh *localName)=0 |
Removes an attribute by local name and namespace URI. More... | |
virtual DOMAttr * | getAttributeNodeNS (const XMLCh *namespaceURI, const XMLCh *localName) const =0 |
Retrieves an DOMAttr node by local name and namespace URI. More... | |
virtual DOMAttr * | setAttributeNodeNS (DOMAttr *newAttr)=0 |
Adds a new attribute. More... | |
virtual DOMNodeList * | getElementsByTagNameNS (const XMLCh *namespaceURI, const XMLCh *localName) const =0 |
Returns a DOMNodeList of all the DOMElement s with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the DOMDocument tree, starting from this node. More... | |
virtual bool | hasAttribute (const XMLCh *name) const =0 |
Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. More... | |
virtual bool | hasAttributeNS (const XMLCh *namespaceURI, const XMLCh *localName) const =0 |
Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise. More... | |
Functions introduced in DOM Level 3 | |
virtual void | setIdAttribute (const XMLCh *name, bool isId)=0 |
If the parameter isId is true , this method declares the specified attribute to be a user-determined ID attribute. More... | |
virtual void | setIdAttributeNS (const XMLCh *namespaceURI, const XMLCh *localName, bool isId)=0 |
If the parameter isId is true , this method declares the specified attribute to be a user-determined ID attribute. More... | |
virtual void | setIdAttributeNode (const DOMAttr *idAttr, bool isId)=0 |
If the parameter isId is true , this method declares the specified attribute to be a user-determined ID attribute. More... | |
virtual const DOMTypeInfo * | getSchemaTypeInfo () const =0 |
Returns the type information associated with this element. More... | |
Functions introduced in the ElementTraversal specification (http://www.w3.org/TR/2008/REC-ElementTraversal-20081222/) | |
virtual DOMElement * | getFirstElementChild () const =0 |
The first child of type DOMElement. More... | |
virtual DOMElement * | getLastElementChild () const =0 |
The last child of type DOMElement. More... | |
virtual DOMElement * | getPreviousElementSibling () const =0 |
The previous sibling node of type DOMElement. More... | |
virtual DOMElement * | getNextElementSibling () const =0 |
The next sibling node of type DOMElement. More... | |
virtual XMLSize_t | getChildElementCount () const =0 |
The number of child nodes that are of type DOMElement. More... | |
Public Member Functions inherited from DOMNode | |
virtual | ~DOMNode () |
Destructor. More... | |
virtual const XMLCh * | getNodeName () const =0 |
The name of this node, depending on its type; see the table above. More... | |
virtual const XMLCh * | getNodeValue () const =0 |
Gets the value of this node, depending on its type. More... | |
virtual NodeType | getNodeType () const =0 |
An enum value representing the type of the underlying object. More... | |
virtual DOMNode * | getParentNode () const =0 |
Gets the parent of this node. More... | |
virtual DOMNodeList * | getChildNodes () const =0 |
Gets a DOMNodeList that contains all children of this node. More... | |
virtual DOMNode * | getFirstChild () const =0 |
Gets the first child of this node. More... | |
virtual DOMNode * | getLastChild () const =0 |
Gets the last child of this node. More... | |
virtual DOMNode * | getPreviousSibling () const =0 |
Gets the node immediately preceding this node. More... | |
virtual DOMNode * | getNextSibling () const =0 |
Gets the node immediately following this node. More... | |
virtual DOMNamedNodeMap * | getAttributes () const =0 |
Gets a DOMNamedNodeMap containing the attributes of this node (if it is an DOMElement ) or null otherwise. More... | |
virtual DOMDocument * | getOwnerDocument () const =0 |
Gets the DOMDocument object associated with this node. More... | |
virtual DOMNode * | cloneNode (bool deep) const =0 |
Returns a duplicate of this node. More... | |
virtual DOMNode * | insertBefore (DOMNode *newChild, DOMNode *refChild)=0 |
Inserts the node newChild before the existing child node refChild . More... | |
virtual DOMNode * | replaceChild (DOMNode *newChild, DOMNode *oldChild)=0 |
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node. More... | |
virtual DOMNode * | removeChild (DOMNode *oldChild)=0 |
Removes the child node indicated by oldChild from the list of children, and returns it. More... | |
virtual DOMNode * | appendChild (DOMNode *newChild)=0 |
Adds the node newChild to the end of the list of children of this node. More... | |
virtual bool | hasChildNodes () const =0 |
This is a convenience method to allow easy determination of whether a node has any children. More... | |
virtual void | setNodeValue (const XMLCh *nodeValue)=0 |
Sets the value of the node. More... | |
virtual void | normalize ()=0 |
Puts all DOMText nodes in the full depth of the sub-tree underneath this DOMNode , including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates DOMText nodes, i.e., there are neither adjacent DOMText nodes nor empty DOMText nodes. More... | |
virtual bool | isSupported (const XMLCh *feature, const XMLCh *version) const =0 |
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node. More... | |
virtual const XMLCh * | getNamespaceURI () const =0 |
Get the namespace URI of this node, or null if it is unspecified. More... | |
virtual const XMLCh * | getPrefix () const =0 |
Get the namespace prefix of this node, or null if it is unspecified. More... | |
virtual const XMLCh * | getLocalName () const =0 |
Returns the local part of the qualified name of this node. More... | |
virtual void | setPrefix (const XMLCh *prefix)=0 |
Set the namespace prefix of this node. More... | |
virtual bool | hasAttributes () const =0 |
Returns whether this node (if it is an element) has any attributes. More... | |
virtual bool | isSameNode (const DOMNode *other) const =0 |
Returns whether this node is the same node as the given one. More... | |
virtual bool | isEqualNode (const DOMNode *arg) const =0 |
Tests whether two nodes are equal. More... | |
virtual void * | setUserData (const XMLCh *key, void *data, DOMUserDataHandler *handler)=0 |
Associate an object to a key on this node. More... | |
virtual void * | getUserData (const XMLCh *key) const =0 |
Retrieves the object associated to a key on a this node. More... | |
virtual const XMLCh * | getBaseURI () const =0 |
The absolute base URI of this node or null if undefined. More... | |
virtual short | compareDocumentPosition (const DOMNode *other) const =0 |
Compares the reference node, i.e. More... | |
virtual const XMLCh * | getTextContent () const =0 |
This attribute returns the text content of this node and its descendants. More... | |
virtual void | setTextContent (const XMLCh *textContent)=0 |
This attribute removes any possible children this node may have and, if the new string is not empty or null, replaced by a single DOMText node containing the string this attribute is set to. More... | |
virtual const XMLCh * | lookupPrefix (const XMLCh *namespaceURI) const =0 |
Look up the prefix associated to the given namespace URI, starting from this node. More... | |
virtual bool | isDefaultNamespace (const XMLCh *namespaceURI) const =0 |
This method checks if the specified namespaceURI is the default namespace or not. More... | |
virtual const XMLCh * | lookupNamespaceURI (const XMLCh *prefix) const =0 |
Look up the namespace URI associated to the given prefix, starting from this node. More... | |
virtual void * | getFeature (const XMLCh *feature, const XMLCh *version) const =0 |
This method makes available a DOMNode 's specialized interface. More... | |
virtual void | release ()=0 |
Called to indicate that this Node (and its associated children) is no longer in use and that the implementation may relinquish any resources associated with it and its associated children. More... | |
Protected Member Functions | |
Hidden constructors | |
DOMElement () | |
DOMElement (const DOMElement &other) | |
Protected Member Functions inherited from DOMNode | |
DOMNode () | |
DOMNode (const DOMNode &) | |
Additional Inherited Members | |
Public Types inherited from DOMNode | |
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 } |
NodeType. More... | |
enum | DocumentPosition { DOCUMENT_POSITION_DISCONNECTED = 0x01, DOCUMENT_POSITION_PRECEDING = 0x02, DOCUMENT_POSITION_FOLLOWING = 0x04, DOCUMENT_POSITION_CONTAINS = 0x08, DOCUMENT_POSITION_CONTAINED_BY = 0x10, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20 } |
DocumentPosition: More... | |
By far the vast majority of objects (apart from text) that authors encounter when traversing a document are DOMElement
nodes.
Assume the following XML document:<elementExample id="demo"> <subelement1/> <subelement2><subsubelement/></subelement2> </elementExample>
When represented using DOM, the top node is an DOMElement
node for "elementExample", which contains two child DOMElement
nodes, one for "subelement1" and one for "subelement2". "subelement1" contains no child nodes.
Elements may have attributes associated with them; since the DOMElement
interface inherits from DOMNode
, the generic DOMNode
interface method getAttributes
may be used to retrieve the set of all attributes for an element. There are methods on the DOMElement
interface to retrieve either an DOMAttr
object by name or an attribute value by name. In XML, where an attribute value may contain entity references, an DOMAttr
object should be retrieved to examine the possibly fairly complex sub-tree representing the attribute value. On the other hand, in HTML, where all attributes have simple string values, methods to directly access an attribute value can safely be used as a convenience.
It also defines the ElementTraversal helper interface defined by http://www.w3.org/TR/2008/REC-ElementTraversal-20081222/
|
protected |
|
protected |
|
virtual |
Destructor.
Retrieves an attribute value by name.
name | The name of the attribute to retrieve. |
DOMAttr
value as a string, or the empty string if that attribute does not have a specified or default value.
|
pure virtual |
Retrieves an DOMAttr
node by local name and namespace URI.
namespaceURI | The namespace URI of the attribute to retrieve. |
localName | The local name of the attribute to retrieve. |
DOMAttr
node with the specified attribute local name and namespace URI or null
if there is no such attribute.
|
pure virtual |
Retrieves an attribute value by local name and namespace URI.
namespaceURI | The namespace URI of the attribute to retrieve. |
localName | The local name of the attribute to retrieve. |
DOMAttr
value as a string, or an null
if that attribute does not have a specified or default value.
|
pure virtual |
The number of child nodes that are of type DOMElement.
Note: the count is computed every time this function is invoked
DOMElement
objects that are direct children of this object (nested elements are not counted), or 0
if there is none.
|
pure virtual |
Returns a DOMNodeList
of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the DOMElement
tree.
name | The name of the tag to match on. The special value "*" matches all tags. |
DOMElement
nodes.
|
pure virtual |
Returns a DOMNodeList
of all the DOMElement
s with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the DOMDocument
tree, starting from this node.
namespaceURI | The namespace URI of the elements to match on. The special value "*" matches all namespaces. |
localName | The local name of the elements to match on. The special value "*" matches all local names. |
DOMNodeList
object containing all the matched DOMElement
s.
|
pure virtual |
The first child of type DOMElement.
DOMElement
object that is the first element node among the child nodes of this node, or null
if there is none.
|
pure virtual |
The last child of type DOMElement.
DOMElement
object that is the last element node among the child nodes of this node, or null
if there is none.
|
pure virtual |
The next sibling node of type DOMElement.
DOMElement
object that is the next sibling element node in document order, or null
if there is none.
|
pure virtual |
The previous sibling node of type DOMElement.
DOMElement
object that is the previous sibling element node in document order, or null
if there is none.
|
pure virtual |
Returns the type information associated with this element.
DOMTypeInfo
associated with this element
|
pure virtual |
The name of the element.
For example, in: <elementExample id="demo"> ... </elementExample> , tagName
has the value "elementExample"
. Note that this is case-preserving in XML, as are all of the operations of the DOM.
|
pure virtual |
Returns true
when an attribute with a given name is specified on this element or has a default value, false
otherwise.
name | The name of the attribute to look for. |
true
if an attribute with the given name is specified on this element or has a default value, false
otherwise.
|
pure virtual |
Returns true
when an attribute with a given local name and namespace URI is specified on this element or has a default value, false
otherwise.
HTML-only DOM implementations do not need to implement this method.
namespaceURI | The namespace URI of the attribute to look for. |
localName | The local name of the attribute to look for. |
true
if an attribute with the given local name and namespace URI is specified or has a default value on this element, false
otherwise.
|
pure virtual |
Removes an attribute by name.
If the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.
To remove an attribute by local name and namespace URI, use the removeAttributeNS
method.
name | The name of the attribute to remove. |
DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
Removes the specified attribute node.
If the removed DOMAttr
has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix, when applicable.
oldAttr | The DOMAttr node to remove from the attribute list. |
DOMAttr
node that was removed. DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element. |
|
pure virtual |
Removes an attribute by local name and namespace URI.
If the removed attribute has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix.
namespaceURI | The namespace URI of the attribute to remove. |
localName | The local name of the attribute to remove. |
DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
Adds a new attribute.
If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string, it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an DOMAttr
node plus any DOMText
and DOMEntityReference
nodes, build the appropriate subtree, and use setAttributeNode
to assign it as the value of an attribute.
name | The name of the attribute to create or alter. |
value | Value to set in string form. |
DOMException | INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
Adds a new attribute.
If an attribute with that name (nodeName
) is already present in the element, it is replaced by the new one.
newAttr | The DOMAttr node to add to the attribute list. |
newAttr
attribute replaces an existing attribute, the replaced DOMAttr
node is returned, otherwise null
is returned. DOMException | WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another DOMElement object. The DOM user must explicitly clone DOMAttr nodes to re-use them in other elements. |
Adds a new attribute.
If an attribute with that local name and namespace URI is already present in the element, it is replaced by the new one.
newAttr | The DOMAttr node to add to the attribute list. |
newAttr
attribute replaces an existing attribute with the same local name and namespace URI, the replaced DOMAttr
node is returned, otherwise null
is returned. DOMException | WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another DOMElement object. The DOM user must explicitly clone DOMAttr nodes to re-use them in other elements. |
|
pure virtual |
Adds a new attribute.
If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName
, and its value is changed to be the value
parameter. This value is a simple string, it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an DOMAttr
node plus any DOMText
and DOMEntityReference
nodes, build the appropriate subtree, and use setAttributeNodeNS
or setAttributeNode
to assign it as the value of an attribute.
namespaceURI | The namespace URI of the attribute to create or alter. |
qualifiedName | The qualified name of the attribute to create or alter. |
value | The value to set in string form. |
DOMException | INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix and the namespaceURI is null or an empty string, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from "http://www.w3.org/XML/1998/namespace", if the qualifiedName has a prefix that is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the qualifiedName is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/". |
|
pure virtual |
If the parameter isId is true
, this method declares the specified attribute to be a user-determined ID attribute.
This affects the value of DOMAttr::isId
and the behavior of DOMDocument::getElementById
, but does not change any schema that may be in use, in particular this does not affect the DOMAttr::getSchemaTypeInfo
of the specified DOMAttr node. Use the value false
for the parameter isId to undeclare an attribute for being a user-determined ID attribute. To specify an DOMAttr
by local name and namespace URI, use the setIdAttributeNS method.
name | The name of the DOMAttr . |
isId | Whether the attribute is of type ID. |
DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if the specified node is not an DOMAttr of this element. |
|
pure virtual |
If the parameter isId is true
, this method declares the specified attribute to be a user-determined ID attribute.
This affects the value of DOMAttr::isId
and the behavior of DOMDocument::getElementById
, but does not change any schema that may be in use, in particular this does not affect the DOMAttr::getSchemaTypeInfo
of the specified DOMAttr node. Use the value false
for the parameter isId to undeclare an attribute for being a user-determined ID attribute.
idAttr | The DOMAttr node. |
isId | Whether the attribute is of type ID. |
DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if the specified node is not an DOMAttr of this element. |
|
pure virtual |
If the parameter isId is true
, this method declares the specified attribute to be a user-determined ID attribute.
This affects the value of DOMAttr::isId
and the behavior of DOMDocument::getElementById
, but does not change any schema that may be in use, in particular this does not affect the DOMAttr::getSchemaTypeInfo
of the specified DOMAttr node. Use the value false
for the parameter isId to undeclare an attribute for being a user-determined ID attribute.
namespaceURI | The namespace URI of the DOMAttr . |
localName | The local name of the DOMAttr . |
isId | Whether the attribute is of type ID. |
DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if the specified node is not an DOMAttr of this element. |