khtml Library API Documentation

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:

DOM::Node DOM::HTMLElement DOM::HTMLAnchorElement DOM::HTMLAppletElement DOM::HTMLAreaElement DOM::HTMLBaseElement DOM::HTMLBaseFontElement DOM::HTMLBlockquoteElement DOM::HTMLBodyElement DOM::HTMLBRElement DOM::HTMLButtonElement DOM::HTMLDirectoryElement DOM::HTMLDivElement DOM::HTMLDListElement DOM::HTMLFieldSetElement DOM::HTMLFontElement DOM::HTMLFormElement DOM::HTMLFrameElement DOM::HTMLFrameSetElement DOM::HTMLHeadElement DOM::HTMLHeadingElement DOM::HTMLHRElement DOM::HTMLHtmlElement DOM::HTMLIFrameElement DOM::HTMLImageElement DOM::HTMLInputElement DOM::HTMLIsIndexElement DOM::HTMLLabelElement DOM::HTMLLegendElement DOM::HTMLLIElement DOM::HTMLLinkElement DOM::HTMLMapElement DOM::HTMLMenuElement DOM::HTMLMetaElement DOM::HTMLModElement DOM::HTMLObjectElement DOM::HTMLOListElement DOM::HTMLOptGroupElement DOM::HTMLOptionElement DOM::HTMLParagraphElement DOM::HTMLParamElement DOM::HTMLPreElement DOM::HTMLQuoteElement DOM::HTMLScriptElement DOM::HTMLSelectElement DOM::HTMLStyleElement DOM::HTMLTableCaptionElement DOM::HTMLTableCellElement DOM::HTMLTableColElement DOM::HTMLTableElement DOM::HTMLTableRowElement DOM::HTMLTableSectionElement DOM::HTMLTextAreaElement DOM::HTMLTitleElement DOM::HTMLUListElement List of all members.

Public Member Functions

 Element (const Node &other)
 Element (const Element &other)
Elementoperator= (const Node &other)
Elementoperator= (const Element &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.

bool isHTMLElement () const
Element form () const
 KHTML extension to DOM This method returns the associated form element.


Static Public Member Functions

bool khtmlValidAttrName (const DOMString &name)
bool khtmlValidPrefix (const DOMString &name)
bool khtmlValidQualifiedName (const DOMString &name)
bool khtmlMalformedQualifiedName (const DOMString &name)
bool khtmlMalformedPrefix (const DOMString &name)

Protected Member Functions

 Element (ElementImpl *_impl)

Friends

class Document
class HTMLDocument
class Attr

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

DOMString Element::tagName  )  const
 

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. The HTML DOM returns the tagName of an HTML element in the canonical uppercase form, regardless of the case in the source HTML document.

Definition at line 145 of file dom_element.cpp.

DOMString Element::getAttribute const DOMString name  ) 
 

Retrieves an attribute value by name.

Parameters:
name The name of the attribute to retrieve.
Returns:
The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

Definition at line 151 of file dom_element.cpp.

References getAttributeNS(), and KStdAccel::name().

void Element::setAttribute const DOMString name,
const DOMString value
 

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 Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNode to 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.
Returns:
Exceptions:
DOMException INVALID_CHARACTER_ERR: Raised if the specified name contains an invalid character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Definition at line 156 of file dom_element.cpp.

References KStdAccel::name(), and setAttributeNS().

void Element::removeAttribute const DOMString name  ) 
 

Removes an attribute by name.

If the removed attribute has a default value it is immediately replaced.

Parameters:
name The name of the attribute to remove.
Returns:
Exceptions:
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Definition at line 161 of file dom_element.cpp.

References KStdAccel::name(), and removeAttributeNS().

Attr Element::getAttributeNode const DOMString name  ) 
 

Retrieves an Attr node by name.

Parameters:
name The name of the attribute to retrieve.
Returns:
The Attr node with the specified attribute name or null if there is no such attribute.

Definition at line 166 of file dom_element.cpp.

References getAttributeNodeNS(), and KStdAccel::name().

Attr Element::setAttributeNode const Attr newAttr  ) 
 

Adds a new attribute.

If an attribute with that name is already present in the element, it is replaced by the new one.

Parameters:
newAttr The Attr node to add to the attribute list.
Returns:
If the newAttr attribute replaces an existing attribute with the same name, the previously existing Attr node is returned, otherwise null is returned.
Exceptions:
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 Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

Definition at line 171 of file dom_element.cpp.

References setAttributeNodeNS().

Attr Element::removeAttributeNode const Attr oldAttr  ) 
 

Removes the specified attribute.

Parameters:
oldAttr The Attr node to remove from the attribute list. If the removed Attr has a default value it is immediately replaced.
Returns:
The Attr node that was removed.
Exceptions:
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.

Definition at line 176 of file dom_element.cpp.

References DOM::Node::handle(), DOM::Node::isNull(), and DOM::Attr::ownerElement().

NodeList Element::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.

Parameters:
name The name of the tag to match on. The special value "*" matches all tags.
Returns:
A list of matching Element nodes.

Definition at line 192 of file dom_element.cpp.

References getElementsByTagNameNS(), and KStdAccel::name().

NodeList Element::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.

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 NodeList object containing all the matched Elements.

Definition at line 199 of file dom_element.cpp.

References DOM::DOMString::implementation().

Referenced by getElementsByTagName().

DOMString Element::getAttributeNS const DOMString namespaceURI,
const DOMString localName
 

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.

Parameters:
namespaceURI The namespace URI of the attribute to retrieve.
localName The local name of the attribute to retrieve.
Returns:
The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

Definition at line 207 of file dom_element.cpp.

References DOM::DOMString::implementation().

Referenced by getAttribute().

void Element::setAttributeNS const DOMString namespaceURI,
const DOMString qualifiedName,
const DOMString value
 

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.

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 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 218 of file dom_element.cpp.

References DOM::DOMString::find(), DOM::DOMString::implementation(), DOM::Node::localName(), and DOM::DOMString::remove().

Referenced by setAttribute().

void Element::removeAttributeNS const DOMString namespaceURI,
const DOMString localName
 

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.

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.

Definition at line 241 of file dom_element.cpp.

References DOM::DOMString::implementation().

Referenced by removeAttribute().

Attr Element::getAttributeNodeNS const DOMString namespaceURI,
const DOMString localName
 

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.

Parameters:
namespaceURI The namespace URI of the attribute to retrieve.
localName The local name of the attribute to retrieve.
Returns:
The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.

Definition at line 256 of file dom_element.cpp.

References DOM::DOMString::implementation().

Referenced by getAttributeNode().

Attr Element::setAttributeNodeNS const Attr newAttr  ) 
 

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.

Parameters:
newAttr The Attr node to add to the attribute list.
Returns:
If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the replaced Attr node is returned, otherwise null is returned.
Exceptions:
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 Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

Definition at line 271 of file dom_element.cpp.

References DOM::Node::handle(), and DOM::Node::isNull().

Referenced by setAttributeNode().

bool Element::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.

Introduced in DOM Level 2.

Parameters:
name The name of the attribute to look for.
Returns:
true if an attribute with the given name is specified on this element or has a default value, false otherwise.

Definition at line 285 of file dom_element.cpp.

References hasAttributeNS(), and KStdAccel::name().

bool Element::hasAttributeNS const DOMString namespaceURI,
const DOMString localName
 

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.

Parameters:
namespaceURI The namespace URI of the attribute to look for.
localName The local name of the attribute to look for.
Returns:
true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise.

Definition at line 290 of file dom_element.cpp.

References DOM::DOMString::implementation().

Referenced by hasAttribute().

CSSStyleDeclaration Element::style  ) 
 

Introduced in DOM Level 2 This method is from the CSSStyleDeclaration interface.

The style attribute

Definition at line 315 of file dom_element.cpp.

Element Element::form  )  const
 

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 309 of file dom_element.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.4.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sun Feb 27 22:16:43 2005 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001