DOM::Element

DOM::Element Class Reference

#include <DOM.hpp>

Inheritance diagram for DOM::Element:

DOM::Node List of all members.

Detailed Description

The element class is here.


Public Member Functions

const Node * appendChild (const Node *newNode)
 Append a child to the children list.
virtual const NamedNodeMap * attributes () const
 Get the attributes (if this node is an Element).
NodeList * childNodes () const
 Get the child nodes.
virtual Node * Clone (bool deepCopy) const throw ()
 The clone implementation.
Node * cloneNode (bool deepCloning) const throw ()
 Clone this node This methods returns a duplicate for this node, but the returned node has no parent.
 Element (HTML::Elements::Element *el)
 Default constructor.
const Node * firstChild () const
 Get the first child pointer.
const Node * firstChildOfType (const NodeType::Type type) const
 Get the first child pointer of the given type.
DOMString getAttribute (const DOMString &name) const
 Get an attribute value.
const Attr * getAttributeNode (const DOMString &name) const
 Get an attribute node.
NodeList * getChildrenByTag (const HTML::GenericElement::ElementID tag) const throw ()
 Get a list of all direct children element that match the given tag ID.
const uint32 getChildrenCount () const throw ()
 Get the children count.
HTML::Elements::Element * getElement () const
 Access the element type.
NodeList * getElementsByTagName (const DOMString &name) const throw ()
 Get a list of all descendant element that match the given tag name.
const Element * getFirstParentOfType (const HTML::GenericElement::ElementID tag) const throw ()
 Get the first parent in the hierarchy of the given tag ID.
const uint16 getNodeType () const
 Get the node type as the DOM 2.0 standard requires it.
const Element * getParentOfFirstChildOfType (const HTML::GenericElement::ElementID tag) const throw ()
 Get the parent of the first child that match the given tag ID.
bool hasAttribute (const DOMString &name) const throw ()
 Check if this element has the given attribute.
bool hasAttributes () const throw ()
 Does this node has attribute ?
bool hasChildNodes () const throw ()
 Does this node has children ?
const Node * insertBefore (const Node *newNode, const Node *refNode)
 Insert a node before the given node.
const Node * lastChild () const
 Get the last child pointer.
virtual DOMString localName () const
 Get the local name.
virtual DOMString namespaceURI () const
 Get the namespace URI (if specified).
const Node * nextSibling () const
 Get the next node in the same current child level.
virtual DOMString nodeName () const
 Get the node name.
virtual void nodeValue (const DOMString &newValue)
 Set the node value.
virtual DOMString nodeValue () const
 Get the node value.
void normalize () throw ()
 Normalize this tree so that the tree will never have 2 adjacent Text child, or an empty Text child This is used to the tree structure is kept as minimal (normalized).
const DOM::Document * ownerDocument () const
 Get the owner document.
const Node * parentNode () const
 Get the parent node.
void prefix (const DOMString &) const
 Set the prefix.
virtual DOMString prefix () const
 Get the prefix.
const Node * previousSibling () const
 Get the previous node in the same current child level.
void removeAttribute (const DOMString &name)
 Remove an attribute.
const Attr * removeAttributeNode (const Attr *node)
 Remove an attribute node.
const Node * removeChild (const Node *oldNode)
 Remove a child.
const Node * replaceChild (const Node *newNode, const Node *oldNode)
 Replace a child node by another node.
virtual void returnToAllocator (const volatile HTML::Elements::Allocators::BaseAllocator *allocator)
 Return this node to the allocator.
void setAttribute (const DOMString &name, const DOMString &value)
 Set an attribute value.
const Attr * setAttributeNode (const Attr *node)
 Set an attribute node.
void setElement (HTML::Elements::Element *newEl)
 Set the element type.
void setTreeNode (DOMTree::Node *newTreeNode) const
 Set the reference correctly.
void Suicide ()
 Make this node commit suicide itself.
DOMString tagName () const
 Get the tagName.

Static Public Member Functions

static bool isSupported (const DOMString &feature, const DOMString &version)
 Tell if the given features is supported.

Public Attributes

friend Document
 Allow Document to access our tree node.
const NodeType::Type nodeType
 The node type.

Protected Member Functions

const DOMTree::Node * getTreeNode () const
 Get the underlying tree node.
DOMTree::Node * getTreeNode ()
 Get the underlying tree node.

Constructor & Destructor Documentation

DOM::Element::Element ( HTML::Elements::Element *  el  )  [inline]

Default constructor.

Member Function Documentation

const Node* DOM::Node::appendChild ( const Node *  newNode  )  [inline, inherited]

Append a child to the children list.

Parameters:
newNode the new node to append to the list
Returns:
the node added

virtual const NamedNodeMap* DOM::Element::attributes (  )  const [inline, virtual]

Get the attributes (if this node is an Element).

Returns:
0 if this node is not an element, or the NamedNodeMap pointer else

Reimplemented from DOM::Node.

NodeList* DOM::Node::childNodes (  )  const [inline, inherited]

Get the child nodes.

Returns:
a pointer on a newly created NodeList object that can be used to access the child nodes

Node * DOM::Element::Clone ( bool  deepCopy  )  const throw () [virtual]

The clone implementation.

Reimplemented from DOM::Node.

Node* DOM::Node::cloneNode ( bool  deepCloning  )  const throw () [inline, inherited]

Clone this node This methods returns a duplicate for this node, but the returned node has no parent.

This is a very long process.

Warning:
Cloning is Node type dependent, please refer to http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/core.html for implication
Parameters:
deepCloning Does the cloning should also clone childrens
Returns:
the cloned node

const Node* DOM::Node::firstChild (  )  const [inline, inherited]

Get the first child pointer.

Returns:
the first child Node pointer or 0 if no child is available

const Node* DOM::Node::firstChildOfType ( const NodeType::Type  type  )  const [inline, inherited]

Get the first child pointer of the given type.

Parameters:
type The child type to look for
Returns:
the first child Node pointer of the given type or 0 if no child of this type is available

DOMString DOM::Element::getAttribute ( const DOMString &  name  )  const [inline]

Get an attribute value.

Parameters:
name the attribute name
Returns:
empty DOMString if not found, or the textual representation if found

const Attr* DOM::Element::getAttributeNode ( const DOMString &  name  )  const [inline]

Get an attribute node.

Parameters:
name the attribute name
Returns:
0 if not found, or the attribute pointer if found

NodeList * DOM::Element::getChildrenByTag ( const HTML::GenericElement::ElementID  tag  )  const throw ()

Get a list of all direct children element that match the given tag ID.

The difference with getElementsByTagName() method is that only the first level child are searched

Parameters:
tag the element tag identifier to select
Returns:
A pointer on a newly created node list that must be deleted

const uint32 DOM::Node::getChildrenCount (  )  const throw () [inline, inherited]

Get the children count.

Returns:
the number of children if known

HTML::Elements::Element* DOM::Element::getElement (  )  const [inline]

Access the element type.

NodeList * DOM::Element::getElementsByTagName ( const DOMString &  name  )  const throw ()

Get a list of all descendant element that match the given tag name.

Parameters:
name the element tag's name to select
Returns:
A pointer on a newly created node list that must be deleted

const Element * DOM::Element::getFirstParentOfType ( const HTML::GenericElement::ElementID  tag  )  const throw ()

Get the first parent in the hierarchy of the given tag ID.

Parameters:
tag the element tag identifier to select
Returns:
A pointer on a the immediate parent element node for any child with matching tag ID if found, or 0 else

const uint16 DOM::Node::getNodeType (  )  const [inline, inherited]

Get the node type as the DOM 2.0 standard requires it.

const Element * DOM::Element::getParentOfFirstChildOfType ( const HTML::GenericElement::ElementID  tag  )  const throw ()

Get the parent of the first child that match the given tag ID.

Parameters:
tag the element tag identifier to select
Returns:
A pointer on a the immediate parent element node for any child with matching tag ID if found, or 0 else

const DOMTree::Node* DOM::Node::getTreeNode (  )  const [inline, protected, inherited]

Get the underlying tree node.

DOMTree::Node* DOM::Node::getTreeNode (  )  [inline, protected, inherited]

Get the underlying tree node.

bool DOM::Element::hasAttribute ( const DOMString &  name  )  const throw () [inline]

Check if this element has the given attribute.

Parameters:
name the attribute name to check
Returns:
true if the attribute exists

bool DOM::Node::hasAttributes (  )  const throw () [inline, inherited]

Does this node has attribute ?

Returns:
true if this node is an Element with attributes

bool DOM::Node::hasChildNodes (  )  const throw () [inline, inherited]

Does this node has children ?

Returns:
true if this node is parent

const Node* DOM::Node::insertBefore ( const Node *  newNode,
const Node *  refNode 
) [inline, inherited]

Insert a node before the given node.

Parameters:
newNode the new node pointer to insert before refNode
refNode the reference node to find. If refNode is 0, the newNode is appended, otherwise it Exception::NotFound is thrown
Returns:
the Node being inserted
Exceptions:
Exceptions::NotFound if the given node is not found

static bool DOM::Node::isSupported ( const DOMString &  feature,
const DOMString &  version 
) [inline, static, inherited]

Tell if the given features is supported.

Parameters:
feature the feature name
version the version number ("1.0", "2.0" etc...)
Returns:
true if the given feature is supported with the given version

const Node* DOM::Node::lastChild (  )  const [inline, inherited]

Get the last child pointer.

Returns:
the last child Node pointer or 0 if no child is available

virtual DOMString DOM::Node::localName (  )  const [inline, virtual, inherited]

Get the local name.

Todo:
implement this once I understand what it means for HTML

virtual DOMString DOM::Node::namespaceURI (  )  const [inline, virtual, inherited]

Get the namespace URI (if specified).

Todo:
implement this once I understand what it means for HTML

const Node* DOM::Node::nextSibling (  )  const [inline, inherited]

Get the next node in the same current child level.

Returns:
0 if no next Node are linked to us, or the next Node pointer else

virtual DOMString DOM::Element::nodeName (  )  const [inline, virtual]

Get the node name.

Returns:
the node name if known or "Unknown" else

Reimplemented from DOM::Node.

virtual void DOM::Node::nodeValue ( const DOMString &  newValue  )  [inline, virtual, inherited]

Set the node value.

Exceptions:
Exceptions::NoModificationAllowed exception if not supported

Reimplemented in DOM::CharacterData, and DOM::Attr.

virtual DOMString DOM::Node::nodeValue (  )  const [inline, virtual, inherited]

Get the node value.

Returns:
the node value if known or empty string else

Reimplemented in DOM::CharacterData, and DOM::Attr.

void DOM::Node::normalize (  )  throw () [inline, inherited]

Normalize this tree so that the tree will never have 2 adjacent Text child, or an empty Text child This is used to the tree structure is kept as minimal (normalized).

Todo:
Perform this structure check here, the parser should never create such strange documents anyway

const DOM::Document* DOM::Node::ownerDocument (  )  const [inline, inherited]

Get the owner document.

Returns:
0 if no owner is set, or a pointer on the Document instance

const Node* DOM::Node::parentNode (  )  const [inline, inherited]

Get the parent node.

Returns:
0 if no parent are set for this node

void DOM::Node::prefix ( const DOMString &   )  const [inline, inherited]

Set the prefix.

Exceptions:
Exceptions::NoModificationAllowed exception if not supported

virtual DOMString DOM::Node::prefix (  )  const [inline, virtual, inherited]

Get the prefix.

Todo:
implement this once I understand what it means for HTML

const Node* DOM::Node::previousSibling (  )  const [inline, inherited]

Get the previous node in the same current child level.

Returns:
0 if no previous Node are linked to us, or the previous Node pointer else

void DOM::Element::removeAttribute ( const DOMString &  name  )  [inline]

Remove an attribute.

Parameters:
name the attribute name
Todo:
use allocator here to return the potential existing node

const Attr* DOM::Element::removeAttributeNode ( const Attr *  node  )  [inline]

Remove an attribute node.

Parameters:
node the attribute node to remove
Returns:
the node that was removed
Todo:
use allocator here to return the potential existing node

const Node* DOM::Node::removeChild ( const Node *  oldNode  )  [inline, inherited]

Remove a child.

Parameters:
oldNode the old node to remove
Exceptions:
Exceptions::NotFound if the oldNode can't be found in the child list
Returns:
the old Node being removed

const Node* DOM::Node::replaceChild ( const Node *  newNode,
const Node *  oldNode 
) [inline, inherited]

Replace a child node by another node.

Parameters:
newNode the new node pointer to replace oldNode with (if newNode is already in the child list, it is removed first)
oldNode the old node to remove
Exceptions:
Exceptions::NotFound if the oldNode can't be found in the child list
Returns:
the old Node being replaced

void DOM::Element::returnToAllocator ( const volatile HTML::Elements::Allocators::BaseAllocator *  allocator  )  [virtual]

Return this node to the allocator.

Parameters:
allocator The allocator to return this node to

Reimplemented from DOM::Node.

void DOM::Element::setAttribute ( const DOMString &  name,
const DOMString &  value 
) [inline]

Set an attribute value.

Parameters:
name the attribute name
value the attribute value
Todo:
use allocator here to return the potential existing node

const Attr* DOM::Element::setAttributeNode ( const Attr *  node  )  [inline]

Set an attribute node.

Parameters:
node the attribute node to set
Returns:
The replaced attribute node if found

void DOM::Element::setElement ( HTML::Elements::Element *  newEl  )  [inline]

Set the element type.

void DOM::Node::setTreeNode ( DOMTree::Node *  newTreeNode  )  const [inline, inherited]

Set the reference correctly.

void DOM::Node::Suicide (  )  [inline, inherited]

Make this node commit suicide itself.

Warning:
After calling this method, the pointer you might have on the node is invalidated.

Only call this method for unreachable nodes (like duplicate attribute, and removed or replaced child, and so on)...

DOMString DOM::Element::tagName (  )  const [inline]

Get the tagName.

Member Data Documentation

friend DOM::Element::Document

Allow Document to access our tree node.

const NodeType::Type DOM::Node::nodeType [inherited]

The node type.

The documentation for this class was generated from the following files:

(C) An X-Ryl669 project 2007

This document describes Unlimited Zooming Interface source code. UZI stands for Unlimited Zooming Interface, and source code license is