Source for javax.swing.tree.MutableTreeNode

   1: /* MutableTreeNode.java --
   2:    Copyright (C) 2002, 2004, 2005  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: package javax.swing.tree;
  39: 
  40: /**
  41:  * MutableTreeNode public interface
  42: 
  43:  * @author Andrew Selkirk
  44:  */
  45: public interface MutableTreeNode extends TreeNode
  46: {
  47:   /**
  48:    * Inserts a node as child at a given index.
  49:    *
  50:    * @param child the note to insert
  51:    * @param index the index
  52:    *
  53:    * @see #remove(int)
  54:    * @see #remove(MutableTreeNode)
  55:    * @see #setParent(MutableTreeNode)
  56:    */
  57:   void insert(MutableTreeNode child, int index);
  58: 
  59:   /**
  60:    * Removes the child node a given index.
  61:    *
  62:    * @param index the index
  63:    *
  64:    * @see #insert(MutableTreeNode,int)
  65:    * @see #remove(MutableTreeNode)
  66:    * @see #removeFromParent()
  67:    */
  68:   void remove(int index);
  69: 
  70:   /**
  71:    * Removes a given child node.
  72:    *
  73:    * @param node the node to remove
  74:    *
  75:    * @see #insert(MutableTreeNode,int)
  76:    * @see #remove(int)
  77:    * @see #removeFromParent()
  78:    */
  79:   void remove(MutableTreeNode node);
  80: 
  81:   /**
  82:    * Sets a user object, the data represented by the node.
  83:    *
  84:    * @param object the data
  85:    */
  86:   void setUserObject(Object object);
  87: 
  88:   /**
  89:    * Removes this node from its parent.
  90:    *
  91:    * @see #remove(int)
  92:    * @see #remove(MutableTreeNode)
  93:    */
  94:   void removeFromParent();
  95: 
  96:   /**
  97:    * Sets the parent of the node.
  98:    *
  99:    * @param parent the parent
 100:    *
 101:    * @see #insert(MutableTreeNode,int)
 102:    */
 103:   void setParent(MutableTreeNode parent);
 104: }