|
|
Objects implementing the <code> NamedNodeMap </code> interface are used to represent collections of nodes that can be accessed by name. Note that <code> NamedNodeMap </code> does not inherit from <code> NodeList </code> ; <code> NamedNodeMap </code> s are not maintained in any particular order. Objects contained in an object implementing <code> NamedNodeMap </code> may also be accessed by an ordinal index, but this is simply to allow convenient enumeration of the contents of a <code> NamedNodeMap </code> , and does not imply that the DOM specifies an order to these Nodes.
NamedNodeMap ()
| NamedNodeMap |
NamedNodeMap (const NamedNodeMap &other)
| NamedNodeMap |
NamedNodeMap & operator = (const NamedNodeMap &other)
| operator = |
~NamedNodeMap ()
| ~NamedNodeMap |
unsigned long length ()
| length |
[const]
The number of nodes in the map. The range of valid child node indices is 0 to <code> length-1 </code> inclusive.
Node getNamedItem ( const DOMString &name )
| getNamedItem |
[const]
Retrieves a node specified by name.
Parameters:
name | Name of a node to retrieve. |
Returns: A <code> Node </code> (of any type) with the specified name, or <code> null </code> if the specified name did not identify any node in the map.
Node setNamedItem ( const Node &arg )
| setNamedItem |
Adds a node using its <code> nodeName </code> attribute.
As the <code> nodeName </code> 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.
NO_MODIFICATION_ALLOWED_ERR: Raised if this <code> NamedNodeMap </code> is readonly.
INUSE_ATTRIBUTE_ERR: Raised if <code> arg </code> is an <code> Attr </code> that is already an attribute of another <code> Element </code> object. The DOM user must explicitly clone <code> Attr </code> nodes to re-use them in other elements.
Parameters:
arg | A node to store in a named node map. The node will later be accessible using the value of the <code> nodeName </code> 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 <code> Node </code> replaces an existing node with the same name the previously existing <code> Node </code> is returned, otherwise <code> null </code> is returned.
Throws: DOMException, WRONG_DOCUMENT_ERR:, Raised, if, <code>, arg, </code>, was, created, from, a, different, document, than, the, one, that, created, the, <code>, NamedNodeMap, </code>, .
Node removeNamedItem ( const DOMString &name )
| removeNamedItem |
Removes a node specified by name. If the removed node is an <code> Attr </code> with a default value it is immediately replaced.
Parameters:
name | The name of a node to remove. |
Returns: The node removed from the map or <code> null </code> if no node with such a name exists.
Throws: DOMException, NOT_FOUND_ERR:, Raised, if, there, is, no, node, named, <code>, name, </code>, in, the, map.
Node item ( unsigned long index )
| item |
[const]
Returns the <code> index </code> th item in the map. If <code> index </code> is greater than or equal to the number of nodes in the map, this returns <code> null </code> .
Parameters:
index | Index into the map. |
Returns: The node at the <code> index </code> th position in the <code> NamedNodeMap </code> , or <code> null </code> if that is not a valid index.
NamedNodeMapImpl * handle ()
| handle |
[const]
not part of the DOM
bool isNull ()
| isNull |
[const]
NamedNodeMap ( NamedNodeMapImpl *i)
| NamedNodeMap |
[protected]
NamedNodeMapImpl * impl | impl |
[protected]
friend class Node | Node |
[protected]
friend class DocumentType | DocumentType |
[protected]
Generated by: root@daffy.perf.redhat.com on Mon Jul 14 13:28:10 2003, using kdoc 2.0a53. |