|
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
IDOM_NamedNodeMap Class ReferenceNamedNodeMap s are used to represent collections of nodes that can be accessed by name.
More...
#include <IDOM_NamedNodeMap.hpp>
List of all members.
Detailed Description
NamedNodeMap s are used to represent collections of nodes that can be accessed by name.
Note that NamedNodeMap does not inherit from NodeList ; NamedNodeMap s are not maintained in any particular order. Nodes contained in a NamedNodeMap may also be accessed by an ordinal index, but this is simply to allow convenient enumeration of the contents, and does not imply that the DOM specifies an order to these Nodes.
Constructor & Destructor Documentation
IDOM_NamedNodeMap::IDOM_NamedNodeMap (
|
) [protected]
|
|
IDOM_NamedNodeMap::IDOM_NamedNodeMap (
|
const IDOM_NamedNodeMap & other ) [protected]
|
|
IDOM_NamedNodeMap::~IDOM_NamedNodeMap (
|
) [virtual]
|
|
Member Function Documentation
unsigned int IDOM_NamedNodeMap::getLength (
|
) const [pure virtual]
|
|
|
The number of nodes in the map.
The range of valid child node indices is 0 to length-1 inclusive. |
IDOM_Node * IDOM_NamedNodeMap::getNamedItem (
|
const XMLCh * name ) const [pure virtual]
|
|
|
Retrieves a node specified by name.
-
Parameters:
-
name
|
The nodeName of a node to retrieve. |
-
Returns:
-
A
IDOM_Node (of any type) with the specified nodeName , or null if it does not identify any node in the map. |
IDOM_Node * IDOM_NamedNodeMap::getNamedItemNS (
|
const XMLCh * namespaceURI,
|
|
const XMLCh * localName ) const [pure virtual]
|
|
|
Retrieves a node specified by local name and namespace URI.
-
Parameters:
-
namespaceURI
|
The namespace URI of the node to retrieve. |
localName
|
The local name of the node to retrieve. |
-
Returns:
-
A
IDOM_Node (of any type) with the specified local name and namespace URI, or null if they do not identify any node in the map. |
IDOM_Node * IDOM_NamedNodeMap::item (
|
unsigned int index ) const [pure virtual]
|
|
|
Returns the index th item in the map.
If index is greater than or equal to the number of nodes in the map, this returns null . -
Parameters:
-
index
|
Index into the map. |
-
Returns:
-
The node at the
index th position in the NamedNodeMap , or null if that is not a valid index. |
IDOM_NamedNodeMap & IDOM_NamedNodeMap::operator= (
|
const IDOM_NamedNodeMap & other ) [protected]
|
|
IDOM_Node * IDOM_NamedNodeMap::removeNamedItem (
|
const XMLCh * name ) [pure virtual]
|
|
|
Removes a node specified by name.
If the removed node is an Attr with a default value it is immediately replaced. -
Parameters:
-
name
|
The nodeName of a node to remove. |
-
Returns:
-
The node removed from the map or
null if no node with such a name exists.
-
Exceptions:
-
DOMException
|
NOT_FOUND_ERR: Raised if there is no node named name in the map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this NamedNodeMap is readonly. |
|
IDOM_Node * IDOM_NamedNodeMap::removeNamedItemNS (
|
const XMLCh * namespaceURI,
|
|
const XMLCh * localName ) [pure virtual]
|
|
|
Removes a node specified by local name and namespace URI.
-
Parameters:
-
namespaceURI
|
The namespace URI of the node to remove. |
localName
|
The local name of the node to remove. When this IDOM_NamedNodeMap contains the attributes attached to an element, as returned by the attributes attribute of the IDOM_Node interface, 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. |
-
Returns:
-
The node removed from the map if a node with such a local name and namespace URI exists.
-
Exceptions:
-
DOMException
|
NOT_FOUND_ERR: Raised if there is no node named name in the map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this IDOM_NamedNodeMap is readonly. |
|
|
Adds a node using its nodeName attribute.
As the nodeName attribute is used to derive the name which the node must be stored under, multiple nodes of certain types (those that have a "special" string value) cannot be stored as the names would clash. This is seen as preferable to allowing nodes to be aliased. -
Parameters:
-
arg
|
A node to store in a named node map. The node will later be accessible using the value of the nodeName attribute of the node. If a node with that name is already present in the map, it is replaced by the new one. |
-
Returns:
-
If the new
Node replaces an existing node the replaced Node is returned, otherwise null is returned.
-
Exceptions:
-
DOMException
|
WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created the NamedNodeMap .
NO_MODIFICATION_ALLOWED_ERR: Raised if this NamedNodeMap is readonly.
INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements. |
|
|
Adds a node using its namespaceURI and localName .
-
Parameters:
-
arg
|
A node to store in a named node map. The node will later be accessible using the value of the namespaceURI and localName attribute of the node. If a node with those namespace URI and local name is already present in the map, it is replaced by the new one. |
-
Returns:
-
If the new
IDOM_Node replaces an existing node the replaced IDOM_Node is returned, otherwise null is returned.
-
Exceptions:
-
DOMException
|
WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created the IDOM_NamedNodeMap .
NO_MODIFICATION_ALLOWED_ERR: Raised if this vNamedNodeMap is readonly.
INUSE_ATTRIBUTE_ERR: Raised if arg is an DOM_Attr that is already an attribute of another DOM_Element object. The DOM user must explicitly clone DOM_Attr nodes to re-use them in other elements. |
|
The documentation for this class was generated from the following file:
|