1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.myfaces.custom.tree;
20
21 /**
22 * Defines the requirements for a tree node object that can change -- by adding or removing
23 * child nodes, or by changing the contents of a user object stored in the node.
24 * (inspired by javax.swing.tree.MutableTreeNode).
25 *
26 * @author <a href="mailto:oliver@rossmueller.com">Oliver Rossmueller</a>
27 * @version $Revision: 472638 $ $Date: 2006-11-08 15:54:13 -0500 (Wed, 08 Nov 2006) $
28 */
29 public interface MutableTreeNode
30 extends TreeNode
31 {
32
33 /**
34 * Add the given child to the children of this node.
35 * This will set this node as the parent of the child using {#setParent}.
36 */
37 void insert(MutableTreeNode child);
38
39
40 /**
41 * Add the given child to the children of this node at index.
42 * This will set this node as the parent of the child using {#setParent}.
43 */
44 void insert(MutableTreeNode child, int index);
45
46
47 /**
48 * Remove the child at the given index.
49 */
50 void remove(int index);
51
52
53 /**
54 * Remove the given node.
55 */
56 void remove(MutableTreeNode node);
57
58
59 /**
60 * Sets the user object of this node.
61 */
62 void setUserObject(Object object);
63
64
65 /**
66 * Remove this node from its parent.
67 */
68 void removeFromParent();
69
70
71 /**
72 * Set the parent node.
73 */
74 void setParent(MutableTreeNode parent);
75 }