org.w3c.dom.html.HTMLCollection Maven / Gradle / Ivy
// Copyright (c) 1998 by W3C
//
// DOM is a trademark of W3C
// The DOM level 1 specification, from which this
// source is derived, is copyright by W3C.
// See: http://www.w3.org/TR/REC-DOM-Level-1/
//
package org.w3c.dom.html;
import org.w3c.dom.*;
/**
An
HTMLCollection is a list of nodes. An individual node may be accessed by either ordinal index or the node's
name or
id attributes.
Note:
Collections in the HTML DOM are assumed to be
live meaning that they are automatically updated when the underlying document is changed.
Property Summary
length
getLength
This attribute specifies the length or
size of the list.
*/
public interface HTMLCollection
{
/**
* Returns the value of the length property.
*/
int getLength ();
/**
This method retrieves a node specified by ordinal index. Nodes are numbered in tree order (depth-first traversal order).
@return The
Node at the corresponding position upon success. A value of
null is returned if the index is out of range.
@param index
The index of the node to be fetched. The index origin is 0.
*/
Node item (int index);
/**
This method retrieves a
Node using a name. It first searches for a
Node with a matching
id attribute. If it doesn't find one, it then searches for a
Node with a matching
name attribute, but only on those elements that are allowed a name attribute.
@return The
Node with a
name or
id attribute whose value corresponds to the specified string. Upon failure (e.g., no node with this name exists), returns
null.
@param name
The name of the
Node to be fetched.
*/
Node namedItem (String name);
}