001/* MutableTreeNode.java -- 002 Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038package javax.swing.tree; 039 040/** 041 * MutableTreeNode public interface 042 043 * @author Andrew Selkirk 044 */ 045public interface MutableTreeNode extends TreeNode 046{ 047 /** 048 * Inserts a node as child at a given index. 049 * 050 * @param child the note to insert 051 * @param index the index 052 * 053 * @see #remove(int) 054 * @see #remove(MutableTreeNode) 055 * @see #setParent(MutableTreeNode) 056 */ 057 void insert(MutableTreeNode child, int index); 058 059 /** 060 * Removes the child node a given index. 061 * 062 * @param index the index 063 * 064 * @see #insert(MutableTreeNode,int) 065 * @see #remove(MutableTreeNode) 066 * @see #removeFromParent() 067 */ 068 void remove(int index); 069 070 /** 071 * Removes a given child node. 072 * 073 * @param node the node to remove 074 * 075 * @see #insert(MutableTreeNode,int) 076 * @see #remove(int) 077 * @see #removeFromParent() 078 */ 079 void remove(MutableTreeNode node); 080 081 /** 082 * Sets a user object, the data represented by the node. 083 * 084 * @param object the data 085 */ 086 void setUserObject(Object object); 087 088 /** 089 * Removes this node from its parent. 090 * 091 * @see #remove(int) 092 * @see #remove(MutableTreeNode) 093 */ 094 void removeFromParent(); 095 096 /** 097 * Sets the parent of the node. 098 * 099 * @param parent the parent 100 * 101 * @see #insert(MutableTreeNode,int) 102 */ 103 void setParent(MutableTreeNode parent); 104}