|
1 /* |
|
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
3 * |
|
4 * This code is free software; you can redistribute it and/or modify it |
|
5 * under the terms of the GNU General Public License version 2 only, as |
|
6 * published by the Free Software Foundation. Oracle designates this |
|
7 * particular file as subject to the "Classpath" exception as provided |
|
8 * by Oracle in the LICENSE file that accompanied this code. |
|
9 * |
|
10 * This code is distributed in the hope that it will be useful, but WITHOUT |
|
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
13 * version 2 for more details (a copy is included in the LICENSE file that |
|
14 * accompanied this code). |
|
15 * |
|
16 * You should have received a copy of the GNU General Public License version |
|
17 * 2 along with this work; if not, write to the Free Software Foundation, |
|
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
19 * |
|
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
21 * or visit www.oracle.com if you need additional information or have any |
|
22 * questions. |
|
23 */ |
|
24 |
|
25 /* |
|
26 * This file is available under and governed by the GNU General Public |
|
27 * License version 2 only, as published by the Free Software Foundation. |
|
28 * However, the following notice accompanied the original version of this |
|
29 * file and, per its terms, should not be removed: |
|
30 * |
|
31 * Copyright (c) 2000 World Wide Web Consortium, |
|
32 * (Massachusetts Institute of Technology, Institut National de |
|
33 * Recherche en Informatique et en Automatique, Keio University). All |
|
34 * Rights Reserved. This program is distributed under the W3C's Software |
|
35 * Intellectual Property License. This program is distributed in the |
|
36 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even |
|
37 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR |
|
38 * PURPOSE. See W3C License http://www.w3.org/Consortium/Legal/ for more |
|
39 * details. |
|
40 */ |
|
41 |
|
42 package org.w3c.dom.html; |
|
43 |
|
44 import org.w3c.dom.Node; |
|
45 |
|
46 /** |
|
47 * An <code>HTMLCollection</code> is a list of nodes. An individual node may |
|
48 * be accessed by either ordinal index or the node's<code>name</code> or |
|
49 * <code>id</code> attributes. Note: Collections in the HTML DOM are assumed |
|
50 * to be live meaning that they are automatically updated when the |
|
51 * underlying document is changed. |
|
52 * <p>See also the <a href='http://www.w3.org/TR/2000/CR-DOM-Level-2-20000510'>Document Object Model (DOM) Level 2 Specification</a>. |
|
53 */ |
|
54 public interface HTMLCollection { |
|
55 /** |
|
56 * This attribute specifies the length or size of the list. |
|
57 */ |
|
58 public int getLength(); |
|
59 |
|
60 /** |
|
61 * This method retrieves a node specified by ordinal index. Nodes are |
|
62 * numbered in tree order (depth-first traversal order). |
|
63 * @param index The index of the node to be fetched. The index origin is |
|
64 * 0. |
|
65 * @return The <code>Node</code> at the corresponding position upon |
|
66 * success. A value of <code>null</code> is returned if the index is |
|
67 * out of range. |
|
68 */ |
|
69 public Node item(int index); |
|
70 |
|
71 /** |
|
72 * This method retrieves a <code>Node</code> using a name. It first |
|
73 * searches for a <code>Node</code> with a matching <code>id</code> |
|
74 * attribute. If it doesn't find one, it then searches for a |
|
75 * <code>Node</code> with a matching <code>name</code> attribute, but |
|
76 * only on those elements that are allowed a name attribute. |
|
77 * @param name The name of the <code>Node</code> to be fetched. |
|
78 * @return The <code>Node</code> with a <code>name</code> or |
|
79 * <code>id</code> attribute whose value corresponds to the specified |
|
80 * string. Upon failure (e.g., no node with this name exists), returns |
|
81 * <code>null</code> . |
|
82 */ |
|
83 public Node namedItem(String name); |
|
84 |
|
85 } |