dummy_foundation/lib/XML/DOM/NodeList.pod
changeset 0 02cd6b52f378
equal deleted inserted replaced
-1:000000000000 0:02cd6b52f378
       
     1 =head1 NAME
       
     2 
       
     3 XML::DOM::NodeList - A node list as used by XML::DOM
       
     4 
       
     5 =head1 DESCRIPTION
       
     6 
       
     7 The NodeList interface provides the abstraction of an ordered
       
     8 collection of nodes, without defining or constraining how this
       
     9 collection is implemented.
       
    10 
       
    11 The items in the NodeList are accessible via an integral index,
       
    12 starting from 0.
       
    13 
       
    14 Although the DOM spec states that all NodeLists are "live" in that they
       
    15 allways reflect changes to the DOM tree, the NodeList returned by
       
    16 getElementsByTagName is not live in this implementation. See L<CAVEATS>
       
    17 for details.
       
    18 
       
    19 =head2 METHODS
       
    20 
       
    21 =over 4
       
    22 
       
    23 =item item (index)
       
    24 
       
    25 Returns the indexth item in the collection. If index is
       
    26 greater than or equal to the number of nodes in the list,
       
    27 this returns undef.
       
    28 
       
    29 =item getLength
       
    30 
       
    31 The number of nodes in the list. The range of valid child
       
    32 node indices is 0 to length-1 inclusive.
       
    33 
       
    34 =back
       
    35 
       
    36 =head2 Additional methods not in the DOM Spec
       
    37 
       
    38 =over 4
       
    39 
       
    40 =item dispose
       
    41 
       
    42 Removes all circular references in this NodeList and its descendants so the 
       
    43 objects can be claimed for garbage collection. The objects should not be used
       
    44 afterwards.
       
    45 
       
    46 =back