javax.swing.tree

Interface TreeNode

Known Subinterfaces:
MutableTreeNode
Known Implementing Classes:
AbstractDocument.AbstractElement, AbstractDocument.BranchElement, AbstractDocument.LeafElement, DefaultMutableTreeNode, DefaultStyledDocument.SectionElement, HTMLDocument.BlockElement, HTMLDocument.RunElement, JTree.DynamicUtilTreeNode

public interface TreeNode

A tree node.

Method Summary

Enumeration<E>
children()
Returns an enumeration of the children of this node, or an empty enumeration if this node has no children.
boolean
getAllowsChildren()
Returns true if this node allows children, and false otherwise.
TreeNode
getChildAt(int index)
Returns the child node at the given index.
int
getChildCount()
Returns the number of children for this node.
int
getIndex(TreeNode node)
Returns the index of the specified child node, or -1 if the node is not in fact a child of this node.
TreeNode
getParent()
Returns the parent node for this tree node, or null if this node has no parent.
boolean
isLeaf()
Returns true if this node is a leaf node, and false otherwise.

Method Details

children

public Enumeration<E> children()
Returns an enumeration of the children of this node, or an empty enumeration if this node has no children.
Returns:
An enumeration of the children of this node.

getAllowsChildren

public boolean getAllowsChildren()
Returns true if this node allows children, and false otherwise.
Returns:
A boolean.

getChildAt

public TreeNode getChildAt(int index)
Returns the child node at the given index.
Parameters:
index - the index (in the range 0 to getChildCount() - 1).
Returns:
The child node at the given index.

getChildCount

public int getChildCount()
Returns the number of children for this node.
Returns:
The number of children for this node.

getIndex

public int getIndex(TreeNode node)
Returns the index of the specified child node, or -1 if the node is not in fact a child of this node.
Parameters:
node - the node (null not permitted).
Returns:
The index of the specified child node, or -1.
Throws:
IllegalArgumentException - if node is null.

getParent

public TreeNode getParent()
Returns the parent node for this tree node, or null if this node has no parent.
Returns:
The parent node (possibly null).

isLeaf

public boolean isLeaf()
Returns true if this node is a leaf node, and false otherwise.
Returns:
A boolean.

TreeNode.java -- Copyright (C) 2002, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.