|  | 
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members 
 DOM_Element  Class ReferenceBy far the vast majority of objects (apart from text) that authors encounter when traversing a document areDOM_Elementnodes. 
More...
#include <DOM_Element.hpp> 
Inheritance diagram for DOM_Element  [legend]Collaboration diagram for DOM_Element:  [legend]List of all members. 
 Detailed DescriptionBy far the vast majority of objects (apart from text) that authors encounter when traversing a document areDOM_Elementnodes.
Assume the following XML document:<elementExample id="demo"> <subelement1/> <subelement2><subsubelement/></subelement2> </elementExample> 
 
When represented using DOM, the top node is an DOM_Elementnode for "elementExample", which contains two childDOM_Elementnodes, one for "subelement1" and one for "subelement2". "subelement1" contains no child nodes. 
Elements may have attributes associated with them; since the DOM_Elementinterface inherits fromDOM_Node, the genericDOM_Nodeinterface methodgetAttributesmay be used to retrieve the set of all attributes for an element. There are methods on theDOM_Elementinterface to retrieve either anDOM_Attrobject by name or an attribute value by name. In XML, where an attribute value may contain entity references, anDOM_Attrobject 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. 
 
 Constructor & Destructor Documentation
 
  
    | 
        
          | DOM_Element::DOM_Element ( | ) |  |  
  
    |  | 
Default constructor for DOM_Element.
 
The resulting object does not refer to an actual Element 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 Element node. 
 
 New comment nodes are created by DOM_Document::createElement().      |  
 
  
    | 
        
          | DOM_Element::DOM_Element ( | const DOM_Element & other ) |  |  
  
    |  | 
Copy constructor.
 
Creates a new DOM_Elementthat refers to the same underlying actual element as the original. 
Parameters: 
| other | The object to be copied | 
 |  
 
  
    | 
        
          | DOM_Element::~DOM_Element ( | ) |  |  
  
    |  | 
Destructor.
 
The object being destroyed is the reference object, not the underlying Element itself.      |  
 
  
    | 
        
          | DOM_Element::DOM_Element ( | ElementImpl * impl )  [protected] |  |  
 Member Function Documentation
 
  
    |  | 
Retrieves an attribute value by name.
 
 
Parameters: 
| name | The name of the attribute to retrieve. | 
 
Returns: 
 The DOM_Attrvalue as a string, or the empty string if that attribute does not have a specified or default value.
 |  
 
  
    |  | 
Retrieves an attribute value by local name and namespace URI.
 
 
"Experimental - subject to change" 
Parameters: 
| namespaceURI | The namespace URI of the attribute to retrieve. |  | localName | The local name of the attribute to retrieve. | 
 
Returns: 
 The DOM_Attrvalue as a string, or annullif that attribute does not have a specified or default value.
 |  
 
  
    |  | 
Retrieves an DOM_Attrnode by name. 
 
Parameters: 
| name | The name ( nodeName) of the attribute to retrieve. | 
 
Returns: 
 The DOM_Attrnode with the specified name (nodeName) ornullif there is no such attribute.
 |  
 
  
    |  | 
Retrieves an DOM_Attrnode by local name and namespace URI. 
 
"Experimental - subject to change" 
Parameters: 
| namespaceURI | The namespace URI of the attribute to retrieve. |  | localName | The local name of the attribute to retrieve. | 
 
Returns: 
 The DOM_Attrnode with the specified attribute local name and namespace URI ornullif there is no such attribute.
 |  
 
  
    |  | 
Returns a NodeListof all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of theDOM_Elementtree. 
 
Parameters: 
| name | The name of the tag to match on. The special value "*" matches all tags. | 
 
Returns: 
 A list of matching DOM_Elementnodes.
 |  
 
  
    |  | 
Returns a DOM_NodeListof all theDOM_Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of theDOM_Documenttree, starting from this node. 
 
"Experimental - subject to change" 
Parameters: 
| 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. | 
 
Returns: 
 A new DOM_NodeListobject containing all the matchedDOM_Elements.
 |  
 
  
    |  | 
The name of the element.
 
For example, in: <elementExample id="demo"> ... </elementExample> , tagNamehas the value"elementExample". Note that this is case-preserving in XML, as are all of the operations of the DOM. |  
 
  
    | 
        
          | DOM_Element & DOM_Element::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 from DOM_Node.     |  
 
  
    | 
        
          | DOM_Element & DOM_Element::operator= ( | const DOM_Element & other ) |  |  
  
    |  | 
Assignment operator.
 
 
Parameters: 
| other | The object to be copied. | 
 |  
 
  
    | 
        
          | void DOM_Element::removeAttribute ( | const DOMString & name ) |  |  
  
    |  | 
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
 removeAttributeNSmethod. 
Parameters: 
| name | The name of the attribute to remove. | 
 
Exceptions: 
| DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. | 
 |  
 
  
    | 
        
          | void DOM_Element::removeAttributeNS ( | const DOMString & namespaceURI, |  
          |  | const DOMString & localName ) |  |  
  
    |  | 
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.
 
 
"Experimental - subject to change" 
Parameters: 
| namespaceURI | The namespace URI of the attribute to remove. |  | localName | The local name of the attribute to remove. | 
 
Exceptions: 
| DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. | 
 |  
 
  
    |  | 
Removes the specified attribute node.
 
If the removed DOM_Attrhas 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. 
Parameters: 
| oldAttr | The DOM_Attrnode to remove from the attribute list. | 
 
Returns: 
 The DOM_Attrnode that was removed.
 
Exceptions: 
| DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. NOT_FOUND_ERR: Raised if
 oldAttris not an attribute of the element. | 
 |  
 
  
    |  | 
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 DOM_Attrnode plus anyTextandEntityReferencenodes, build the appropriate subtree, and usesetAttributeNodeto assign it as the value of an attribute. 
Parameters: 
| name | The name of the attribute to create or alter. |  | value | Value to set in string form. | 
 
Exceptions: 
| 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 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 thevalueparameter. 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 anDOM_Attrnode plus anyDOM_TextandDOM_EntityReferencenodes, build the appropriate subtree, and usesetAttributeNodeNSorsetAttributeNodeto assign it as the value of an attribute. 
 
"Experimental - subject to change" 
Parameters: 
| 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. | 
 
Exceptions: 
| 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
 qualifiedNameis malformed, if thequalifiedNamehas a prefix and thenamespaceURIisnullor an empty string, if thequalifiedNamehas a prefix that is "xml" and thenamespaceURIis different from "http://www.w3.org/XML/1998/namespace", if thequalifiedNamehas a prefix that is "xmlns" and thenamespaceURIis different from "http://www.w3.org/2000/xmlns/", or if thequalifiedNameis "xmlns" and thenamespaceURIis different from "http://www.w3.org/2000/xmlns/". | 
 |  
 
  
    |  | 
Adds a new attribute.
 
If an attribute with that name (nodeName) is already present in the element, it is replaced by the new one. 
Parameters: 
| newAttr | The DOM_Attrnode to add to the attribute list. | 
 
Returns: 
 If the newAttrattribute replaces an existing attribute, the replacedDOM_Attrnode is returned, otherwisenullis returned.
 
Exceptions: 
| DOMException | WRONG_DOCUMENT_ERR: Raised if newAttrwas 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
 newAttris already an attribute of anotherDOM_Elementobject. The DOM user must explicitly cloneDOM_Attrnodes 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.
 
 
"Experimental - subject to change" 
Parameters: 
| newAttr | The DOM_Attrnode to add to the attribute list. | 
 
Returns: 
 If the newAttrattribute replaces an existing attribute with the same local name and namespace URI, the replacedDOM_Attrnode is returned, otherwisenullis returned.
 
Exceptions: 
| DOMException | WRONG_DOCUMENT_ERR: Raised if newAttrwas 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
 newAttris already an attribute of anotherDOM_Elementobject. The DOM user must explicitly cloneDOM_Attrnodes to re-use them in other elements. | 
 |  
 Friends And Related Function Documentation
 
 
  
    | 
        
          | class DOM_Document  [friend] |  |  
 
  
    | 
        
          | class TraverseSchema  [friend] |  |  The documentation for this class was generated from the following file:
 |