< prev index next >

src/java.desktop/share/classes/javax/swing/tree/MutableTreeNode.java

Print this page




  23  * questions.
  24  */
  25 
  26 package javax.swing.tree;
  27 
  28 /**
  29  * Defines the requirements for a tree node object that can change --
  30  * by adding or removing child nodes, or by changing the contents
  31  * of a user object stored in the node.
  32  *
  33  * @see DefaultMutableTreeNode
  34  * @see javax.swing.JTree
  35  *
  36  * @author Rob Davis
  37  * @author Scott Violet
  38  */
  39 
  40 public interface MutableTreeNode extends TreeNode
  41 {
  42     /**
  43      * Adds <code>child</code> to the receiver at <code>index</code>.
  44      * <code>child</code> will be messaged with <code>setParent</code>.
  45      *
  46      * @param child node to be added
  47      * @param index index of the receiver
  48      */
  49     void insert(MutableTreeNode child, int index);
  50 
  51     /**
  52      * Removes the child at <code>index</code> from the receiver.
  53      *
  54      * @param index index of child to be removed
  55      */
  56     void remove(int index);
  57 
  58     /**
  59      * Removes <code>node</code> from the receiver. <code>setParent</code>
  60      * will be messaged on <code>node</code>.
  61      *
  62      * @param node node to be removed from the receiver
  63      */
  64     void remove(MutableTreeNode node);
  65 
  66     /**
  67      * Resets the user object of the receiver to <code>object</code>.
  68      *
  69      * @param object object to be set as a receiver
  70      */
  71     void setUserObject(Object object);
  72 
  73     /**
  74      * Removes the receiver from its parent.
  75      */
  76     void removeFromParent();
  77 
  78     /**
  79      * Sets the parent of the receiver to <code>newParent</code>.
  80      *
  81      * @param newParent node to be set as parent of the receiver
  82      */
  83     void setParent(MutableTreeNode newParent);
  84 }


  23  * questions.
  24  */
  25 
  26 package javax.swing.tree;
  27 
  28 /**
  29  * Defines the requirements for a tree node object that can change --
  30  * by adding or removing child nodes, or by changing the contents
  31  * of a user object stored in the node.
  32  *
  33  * @see DefaultMutableTreeNode
  34  * @see javax.swing.JTree
  35  *
  36  * @author Rob Davis
  37  * @author Scott Violet
  38  */
  39 
  40 public interface MutableTreeNode extends TreeNode
  41 {
  42     /**
  43      * Adds {@code child} to the receiver at {@code index}.
  44      * {@code child} will be messaged with {@code setParent}.
  45      *
  46      * @param child node to be added
  47      * @param index index of the receiver
  48      */
  49     void insert(MutableTreeNode child, int index);
  50 
  51     /**
  52      * Removes the child at {@code index} from the receiver.
  53      *
  54      * @param index index of child to be removed
  55      */
  56     void remove(int index);
  57 
  58     /**
  59      * Removes {@code node} from the receiver. {@code setParent}
  60      * will be messaged on {@code node}.
  61      *
  62      * @param node node to be removed from the receiver
  63      */
  64     void remove(MutableTreeNode node);
  65 
  66     /**
  67      * Resets the user object of the receiver to {@code object}.
  68      *
  69      * @param object object to be set as a receiver
  70      */
  71     void setUserObject(Object object);
  72 
  73     /**
  74      * Removes the receiver from its parent.
  75      */
  76     void removeFromParent();
  77 
  78     /**
  79      * Sets the parent of the receiver to {@code newParent}.
  80      *
  81      * @param newParent node to be set as parent of the receiver
  82      */
  83     void setParent(MutableTreeNode newParent);
  84 }
< prev index next >