KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > browser > gui > api > TreeProvider


1 /*====================================================================
2
3 Objectweb Browser framework
4 Copyright (C) 2000-2003 INRIA & USTL - LIFL - GOAL
5 Contact: openccm@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Jerome Moroy.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.util.browser.gui.api;
28
29 import org.objectweb.util.browser.api.TreeView;
30 import org.objectweb.util.browser.core.common.DynamicTree;
31
32 /**
33  * Used to create new DynamicTree.
34  *
35  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jerome Moroy</a>
36  *
37  * @version 0.1
38  */
39 public interface TreeProvider {
40
41     //==================================================================
42 //
43 // No internal state.
44 //
45 //==================================================================
46
47     //==================================================================
48 //
49 // Public methods.
50 //
51 //==================================================================
52
53     /**
54      * Creates a new DynamicTree with a same configuration of one contains in the given treeView.
55      * Equivalent to a <code>createDynamicTree(treeView,true);</code> call.
56      * @param treeView The treeView containinf the configuration of the initial tree.
57      * @return The new DynamicTree.
58      * @see org.objectweb.util.browser.core.common.DynamicTree
59      */
60     public DynamicTree createDynamicTree(TreeView treeView);
61
62     /**
63      * Creates a new DynamicTree with a same configuration of one contains in the given treeView.
64      * @param treeView The treeView containinf the configuration of the initial tree.
65      * @param withData A boolean to specify if the data of the source tree have to be added into the new one. The default value is "true"
66      * @return The new DynamicTree.
67      */
68     public DynamicTree createDynamicTree(TreeView treeView, boolean withData);
69
70 }
Popular Tags