echopointng.tree.TreeNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibis-echo2 Show documentation
Echo2 bundled with Echo2_Extras, Echo2_FileTransfer and echopointing and various improvements/bugfixes
There is a newer version: 2.0.4
package echopointng.tree;
/* 
 * This file is part of the Echo Point Project.  This project is a collection
 * of Components that have extended the Echo Web Application Framework.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */

/*
* The design paradigm and class name used within have been taken directly from
* the java.swing package has been retro-fitted to work with the NextApp Echo web framework.
*
* This file was made part of the EchoPoint project on the 25/07/2002.
*
*/

import java.util.Enumeration;

/**
 * Defines the requirements for an object that can be used as a
 * tree node in a TreeModel.  Note any hierarchial 
 * data structure can be used inside a TreeModel, however TreeNode
 * can be used by the DefaultTreeModel as a pre-built TreeModel
 * implementation.
 *
 */
public interface TreeNode {
	/**
	 * Returns the children of the reciever as an Enumeration.
	 */
	public Enumeration children();
	/**
	 * Returns the Action command string associated with this node
	 */
	public String getActionCommand();
	/**
	 * Returns true if the receiver allows children.
	 */
	public boolean getAllowsChildren();
	/**
	 * Returns the child TreeNode at index 
	 * childIndex.
	 */
	public TreeNode getChildAt(int childIndex);
	/**
	 * Returns the number of children TreeNodes the receiver
	 * contains.
	 */
	public int getChildCount();

	/**
	 * Returns the index of node in the receivers children.
	 * If the receiver does not contain node, -1 will be
	 * returned.
	 */
	public int getIndex(TreeNode node);
	/**
	 * Returns the parent TreeNode of the receiver.
	 */
	public TreeNode getParent();
	/**
	 * Returns true if the receiver is a leaf.
	 */
	public boolean isLeaf();
}