DOM::Element Class Reference
By far the vast majority of objects (apart from text) that authors encounter when traversing a document are Element
nodes.
More...
#include <dom_element.h>
Inheritance diagram for DOM::Element:

Public Methods | |
Element & | operator= (const Node &other) |
DOMString | tagName () const |
The name of the element. | |
DOMString | getAttribute (const DOMString &name) |
Retrieves an attribute value by name. | |
void | setAttribute (const DOMString &name, const DOMString &value) |
Adds a new attribute. | |
void | removeAttribute (const DOMString &name) |
Removes an attribute by name. | |
Attr | getAttributeNode (const DOMString &name) |
Retrieves an Attr node by name. | |
Attr | setAttributeNode (const Attr &newAttr) |
Adds a new attribute. | |
Attr | removeAttributeNode (const Attr &oldAttr) |
Removes the specified attribute. | |
NodeList | getElementsByTagName (const DOMString &name) |
Returns a NodeList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the Element tree. | |
NodeList | getElementsByTagNameNS (const DOMString &namespaceURI, const DOMString &localName) |
Introduced in DOM Level 2 Returns a NodeList of all the descendant Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of this Element tree. | |
DOMString | getAttributeNS (const DOMString &namespaceURI, const DOMString &localName) |
Introduced in DOM Level 2. | |
void | setAttributeNS (const DOMString &namespaceURI, const DOMString &qualifiedName, const DOMString &value) |
Introduced in DOM Level 2. | |
void | removeAttributeNS (const DOMString &namespaceURI, const DOMString &localName) |
Introduced in DOM Level 2. | |
Attr | getAttributeNodeNS (const DOMString &namespaceURI, const DOMString &localName) |
Introduced in DOM Level 2. | |
Attr | setAttributeNodeNS (const Attr &newAttr) |
Introduced in DOM Level 2. | |
bool | hasAttribute (const DOMString &name) |
Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. | |
bool | hasAttributeNS (const DOMString &namespaceURI, const DOMString &localName) |
Introduced in DOM Level 2. | |
CSSStyleDeclaration | style () |
Introduced in DOM Level 2 This method is from the CSSStyleDeclaration interface. | |
Element | form () const |
KHTML extension to DOM This method returns the associated form element. |
Detailed Description
By far the vast majority of objects (apart from text) that authors encounter when traversing a document are Element
nodes.
Assume the following XML document: <elementExample id="demo"> <subelement1/> <subelement2><subsubelement/></subelement2> </elementExample>
When represented using DOM, the top node is an Element
node for "elementExample", which contains two child Element
nodes, one for "subelement1" and one for "subelement2". "subelement1" contains no child nodes.
Elements may have attributes associated with them; since the Element
interface inherits from Node
, the generic Node
interface method getAttributes
may be used to retrieve the set of all attributes for an element. There are methods on the Element
interface to retrieve either an Attr
object by name or an attribute value by name. In XML, where an attribute value may contain entity references, an Attr
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.
Definition at line 207 of file dom_element.h.
Member Function Documentation
|
The name of the element.
For example, in: <elementExample id="demo"> ... </elementExample> , Definition at line 144 of file dom_element.cpp. |
|
Retrieves an attribute value by name.
Definition at line 150 of file dom_element.cpp. References getAttributeNS(). |
|
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
Definition at line 155 of file dom_element.cpp. References setAttributeNS(). |
|
Removes an attribute by name. If the removed attribute has a default value it is immediately replaced.
Definition at line 160 of file dom_element.cpp. References removeAttributeNS(). |
|
Retrieves an
Definition at line 165 of file dom_element.cpp. References getAttributeNodeNS(). |
|
Adds a new attribute. If an attribute with that name is already present in the element, it is replaced by the new one.
INUSE_ATTRIBUTE_ERR: Raised if Definition at line 170 of file dom_element.cpp. References setAttributeNodeNS(). |
|
Removes the specified attribute.
oldAttr is not an attribute of the element.
Definition at line 175 of file dom_element.cpp. References DOM::Node::handle(), DOM::Node::isNull(), and DOM::Attr::ownerElement(). |
|
Returns a
Definition at line 189 of file dom_element.cpp. References getElementsByTagNameNS(), and DOM::DOMString::implementation(). |
|
Introduced in DOM Level 2 Returns a NodeList of all the descendant Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of this Element tree.
Definition at line 196 of file dom_element.cpp. References DOM::DOMString::implementation(). Referenced by getElementsByTagName(). |
|
Introduced in DOM Level 2. No Exceptions. Retrieves an attribute value by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.
Definition at line 204 of file dom_element.cpp. References DOM::DOMString::implementation(). Referenced by getAttribute(). |
|
Introduced in DOM Level 2. 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 Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNodeNS or setAttributeNode to assign it as the value of an attribute. HTML-only DOM implementations do not need to implement this method.
NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix and the namespaceURI is null, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from "http://www.w3.org/XML/1998/namespace", or if the qualifiedName is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/". Definition at line 214 of file dom_element.cpp. References DOM::DOMString::find(), DOM::DOMString::implementation(), DOM::Node::localName(), and DOM::DOMString::remove(). Referenced by setAttribute(). |
|
Introduced in DOM Level 2. 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. HTML-only DOM implementations do not need to implement this method.
Definition at line 234 of file dom_element.cpp. References DOM::DOMString::implementation(). Referenced by removeAttribute(). |
|
Introduced in DOM Level 2. Retrieves an Attr node by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.
Definition at line 248 of file dom_element.cpp. References DOM::DOMString::implementation(). Referenced by getAttributeNode(). |
|
Introduced in DOM Level 2. Adds a new attribute. If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one. HTML-only DOM implementations do not need to implement this method.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements. Definition at line 262 of file dom_element.cpp. References DOM::Node::handle(), DOM::Node::isNull(), and DOM::Attr::ownerElement(). Referenced by setAttributeNode(). |
|
Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. Introduced in DOM Level 2.
Definition at line 279 of file dom_element.cpp. References hasAttributeNS(). |
|
Introduced in DOM Level 2. 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.
Definition at line 284 of file dom_element.cpp. References DOM::DOMString::implementation(). Referenced by hasAttribute(). |
|
Introduced in DOM Level 2 This method is from the CSSStyleDeclaration interface. The style attribute Definition at line 308 of file dom_element.cpp. |
|
KHTML extension to DOM This method returns the associated form element. returns null if this element is not a form-like element or if this elment is not in the scope of a form element. Reimplemented in DOM::HTMLButtonElement, DOM::HTMLFieldSetElement, DOM::HTMLInputElement, DOM::HTMLLegendElement, DOM::HTMLSelectElement, DOM::HTMLTextAreaElement, DOM::HTMLOptionElement, DOM::HTMLIsIndexElement, and DOM::HTMLObjectElement. Definition at line 302 of file dom_element.cpp. |
The documentation for this class was generated from the following files: