~ubuntu-branches/ubuntu/karmic/libjaxp1.3-java/karmic

« back to all changes in this revision

Viewing changes to org/w3c/dom/html/HTMLCollection.java

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Vandyck
  • Date: 2006-08-03 10:30:58 UTC
  • Revision ID: james.westby@ubuntu.com-20060803103058-7jwwiqv9g8w9094d
Tags: upstream-1.3.03
ImportĀ upstreamĀ versionĀ 1.3.03

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * Copyright (c) 1998 World Wide Web Consortium, (Massachusetts Institute of
 
3
 * Technology, Institut National de Recherche en Informatique et en
 
4
 * Automatique, Keio University).
 
5
 * All Rights Reserved. http://www.w3.org/Consortium/Legal/
 
6
 */
 
7
 
 
8
package org.w3c.dom.html;
 
9
 
 
10
import org.w3c.dom.*;
 
11
 
 
12
/**
 
13
 * An <code>HTMLCollection</code> is a list of nodes. An individual nodemay be 
 
14
 * accessed by either ordinal index or the node's<code>name</code> or 
 
15
 * <code>id</code> attributes. Note:Collections in the HTML DOM are assumed 
 
16
 * to be live meaningthat they are automatically updated when the underlying 
 
17
 * document ischanged. 
 
18
 */
 
19
public interface HTMLCollection {
 
20
  /**
 
21
   * This attribute specifies the length or size of the list. 
 
22
   */
 
23
  public int                getLength();
 
24
  /**
 
25
   * This method retrieves a node specified by ordinal index. Nodes are 
 
26
   * numbered in tree order (depth-first traversal order).
 
27
   * @param index The index of the node to be fetched. The index origin is 0.
 
28
   * @return The <code>Node</code> at the corresponding position upon success. 
 
29
   *   A value of <code>null</code> is returned if the index is out of range. 
 
30
   */
 
31
  public Node               item(int index);
 
32
  /**
 
33
   * This method retrieves a <code>Node</code> using a name. It first searches 
 
34
   * for a <code>Node</code> with a matching <code>id</code> attribute. If it 
 
35
   * doesn't find one, it then searches for a <code>Node</code> with a 
 
36
   * matching <code>name</code> attribute, but only on those elements that 
 
37
   * are allowed a name attribute. 
 
38
   * @param name The name of the <code>Node</code> to be fetched.
 
39
   * @return The <code>Node</code> with a <code>name</code> or <code>id</code> 
 
40
   *   attribute whose value corresponds to the specified string. Upon 
 
41
   *   failure (e.g., no node with this name exists), returns 
 
42
   *   <code>null</code>.
 
43
   */
 
44
  public Node               namedItem(String name);
 
45
}
 
46