ElementRef Interface

Table 15-14 summarizes the methods of available through ElementRef interface.

ElementRef

Class constructor.

ElementRef(
   const NodeRef< Node>& node_ref,
   Node* nptr);

ElementRef(
   const ElementRef< Node>& node_ref);

node_ref

nptr

(ElementRef) Node reference object

getAttribute

Returns the value of an element's attribute (specified by name). Note that an attribute may have the empty string as its value, but cannot be NULL.

oratext* getAttribute(
   oratext* name) const;

name

(oratext*) named attribute's value (in data encoding)

getAttributeNS

Returns the value of an element's attribute (specified by URI and local name). Note that an attribute may have the empty string as its value, but cannot be NULL.

oratext* getAttributeNS(
   oratext* namespaceURI,
   oratext* localName);

namespaceURI

localName

(oratext *) named attribute's value (in data encoding)

getAttributeNode

Returns the attribute node given its name.

Node* getAttributeNode(
   oratext* name) const;

name

(Node*) the attribute node

getElementsByTagName

Returns a list of all elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the subtree. The tag name should be in the data encoding. The special name "*" matches all tag names; a NULL name matches nothing. Tag names are case sensitive. This function is not namespace aware; the full tag names are compared. The returned list should be freed by the user.

NodeList< Node>* getElementsByTagName(
   oratext* name);

name

(NodeList< Node>*) the list of elements

getTagName

Returns the tag name of an element node which is supposed to have the same value as the node name from the node interface

oratext* getTagName() const;

(oratext*) element's name [in data encoding]

hasAttribute

Determines if an element has a attribute with the given name

boolean hasAttribute(
   oratext* name);

name

(boolean) TRUE if element has attribute with given name

hasAttributeNS

Determines if an element has a attribute with the given URI and local name

boolean hasAttributeNS(
   oratext* namespaceURI,
   oratext* localName);

namespaceURI

localName

(boolean) TRUE if element has such attribute

removeAttribute

Removes an attribute specified by name. The attribute is removed from the element's list of attributes, but the attribute node itself is not destroyed.

void removeAttribute(
   oratext* name) throw (DOMException);

name

removeAttributeNS

Removes an attribute specified by URI and local name. The attribute is removed from the element's list of attributes, but the attribute node itself is not destroyed.

void removeAttributeNS(
   oratext* namespaceURI,
   oratext* localName)
throw (DOMException);

namespaceURI

localName

removeAttributeNode

Removes an attribute from an element. Returns a pointer to the removed attribute or NULL

Node* removeAttributeNode(
   AttrRef< Node>& oldAttr)
throw (DOMException);

oldAttr

(Node*) the attribute node (old) or NULL

setAttribute

Creates a new attribute for an element with the given name and value (which should be in the data encoding). If the named attribute already exists, its value is simply replaced. The name and value are not verified, converted, or checked. The value is not parsed, so entity references will not be expanded.

void setAttribute( 
   oratext* name, 
   oratext* value)
throw (DOMException);

name

value

setAttributeNS

Creates a new attribute for an element with the given URI, local name and value (which should be in the data encoding). If the named attribute already exists, its value is simply replaced. The name and value are not verified, converted, or checked. The value is not parsed, so entity references will not be expanded.

void setAttributeNS( 
   oratext* namespaceURI,
   oratext* qualifiedName, 
   oratext* value)
throw (DOMException);

namespaceURI

qualifiedName

value

setAttributeNode

Adds a new attribute to an element. If an attribute with the given name already exists, it is replaced and a pointer to the old attribute returned. If the attribute is new, it is added to the element's list and a pointer to the new attribute is returned.

Node* setAttributeNode( 
   AttrRef< Node>& newAttr)
throw (DOMException);

newAttr

(Node*) the attribute node (old or new)

~ElementRef

This is the default destructor.

~ElementRef();