01 /*
02 * Copyright 1997-2005 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.swing.tree;
27
28 import java.util.Enumeration;
29
30 /**
31 * Defines the requirements for an object that can be used as a
32 * tree node in a JTree.
33 * <p>
34 * Implementations of <code>TreeNode</code> that override <code>equals</code>
35 * will typically need to override <code>hashCode</code> as well. Refer
36 * to {@link javax.swing.tree.TreeModel} for more information.
37 *
38 * For further information and examples of using tree nodes,
39 * see <a
40 href="http://java.sun.com/docs/books/tutorial/uiswing/components/tree.html">How to Use Tree Nodes</a>
41 * in <em>The Java Tutorial.</em>
42 *
43 * @version 1.31 05/05/07
44 * @author Rob Davis
45 * @author Scott Violet
46 */
47
48 public interface TreeNode {
49 /**
50 * Returns the child <code>TreeNode</code> at index
51 * <code>childIndex</code>.
52 */
53 TreeNode getChildAt(int childIndex);
54
55 /**
56 * Returns the number of children <code>TreeNode</code>s the receiver
57 * contains.
58 */
59 int getChildCount();
60
61 /**
62 * Returns the parent <code>TreeNode</code> of the receiver.
63 */
64 TreeNode getParent();
65
66 /**
67 * Returns the index of <code>node</code> in the receivers children.
68 * If the receiver does not contain <code>node</code>, -1 will be
69 * returned.
70 */
71 int getIndex(TreeNode node);
72
73 /**
74 * Returns true if the receiver allows children.
75 */
76 boolean getAllowsChildren();
77
78 /**
79 * Returns true if the receiver is a leaf.
80 */
81 boolean isLeaf();
82
83 /**
84 * Returns the children of the receiver as an <code>Enumeration</code>.
85 */
86 Enumeration children();
87 }
|