Source for javax.swing.tree.TreeNode

   1: /* TreeNode.java --
   2:    Copyright (C) 2002, 2006, Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.swing.tree;
  40: 
  41: import java.util.Enumeration;
  42: 
  43: /**
  44:  * A tree node.
  45:  * 
  46:  * @author Andrew Selkirk
  47:  */
  48: public interface TreeNode {
  49: 
  50:   /**
  51:    * Returns the parent node for this tree node, or <code>null</code> if this
  52:    * node has no parent.
  53:    * 
  54:    * @return The parent node (possibly <code>null</code>).
  55:    */
  56:   TreeNode getParent();
  57: 
  58:   /**
  59:    * Returns the index of the specified child node, or -1 if the node is not
  60:    * in fact a child of this node.
  61:    * 
  62:    * @param node  the node (<code>null</code> not permitted).
  63:    * 
  64:    * @return The index of the specified child node, or -1.
  65:    * 
  66:    * @throws IllegalArgumentException if <code>node</code> is <code>null</code>.
  67:    */
  68:   int getIndex(TreeNode node);
  69: 
  70:   /**
  71:    * Returns the child node at the given index.
  72:    * 
  73:    * @param index  the index (in the range <code>0</code> to 
  74:    *     <code>getChildCount() - 1</code>).
  75:    *     
  76:    * @return The child node at the given index.
  77:    */
  78:   TreeNode getChildAt(int index);
  79: 
  80:   /**
  81:    * Returns the number of children for this node.
  82:    * 
  83:    * @return The number of children for this node.
  84:    */
  85:   int getChildCount();
  86: 
  87:   /**
  88:    * Returns <code>true</code> if this node allows children, and 
  89:    * <code>false</code> otherwise.
  90:    * 
  91:    * @return A boolean.
  92:    */
  93:   boolean getAllowsChildren();
  94: 
  95:   /**
  96:    * Returns <code>true</code> if this node is a leaf node, and 
  97:    * <code>false</code> otherwise.
  98:    * 
  99:    * @return A boolean.
 100:    */
 101:   boolean isLeaf();
 102: 
 103:   /**
 104:    * Returns an enumeration of the children of this node, or an empty 
 105:    * enumeration if this node has no children.
 106:    * 
 107:    * @return An enumeration of the children of this node.
 108:    */
 109:   Enumeration children();
 110: 
 111: }