/* * @(#)TreeNode.java 1.23 04/07/13 * * Copyright 2004 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing.tree; import java.util.Enumeration; /** * Defines the requirements for an object that can be used as a * tree node in a JTree. * *
*
* For further information and examples of using tree nodes,
* see How to Use Tree Nodes
* in The Java Tutorial.
*
* @version 1.23 07/13/04
* @author Rob Davis
* @author Scott Violet
*/
public interface TreeNode
{
/**
* Returns the child TreeNode
at index
* childIndex
.
*/
TreeNode getChildAt(int childIndex);
/**
* Returns the number of children TreeNode
s the receiver
* contains.
*/
int getChildCount();
/**
* Returns the parent TreeNode
of the receiver.
*/
TreeNode getParent();
/**
* Returns the index of node
in the receivers children.
* If the receiver does not contain node
, -1 will be
* returned.
*/
int getIndex(TreeNode node);
/**
* Returns true if the receiver allows children.
*/
boolean getAllowsChildren();
/**
* Returns true if the receiver is a leaf.
*/
boolean isLeaf();
/**
* Returns the children of the receiver as an Enumeration
.
*/
Enumeration children();
}