KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > swing > gui > api > TreeProvider


1 /*====================================================================
2
3 Objectweb Explorer Framework
4 Copyright (C) 2000-2004 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, Philippe Merle.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.util.explorer.swing.gui.api;
28
29 import org.objectweb.util.explorer.api.Tree;
30
31 /**
32  * Used to create new DynamicTree.
33  *
34  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jerome Moroy</a>
35  *
36  * @version 0.1
37  */
38 public interface TreeProvider {
39
40     //==================================================================
41 //
42 // No internal state.
43 //
44 //==================================================================
45
46     //==================================================================
47 //
48 // Public methods.
49 //
50 //==================================================================
51
52     //TODO: Maybe obsolete ... might be removed ...
53
54     /**
55      * Creates a new Tree instance with a same configuration of one contains in the explorer component.
56      * Equivalent to a <code>duplicate(true);</code> call.
57      * @return The new Tree instance.
58      * @see org.objectweb.util.explorer.api.Tree
59      * @see TreeProvider#duplicate(boolean)
60      */
61     public Tree duplicate();
62
63     /**
64      * Creates a new Tree instance with a same configuration of one contains in the explorer component.
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 Tree instance.
67      * @see org.objectweb.util.explorer.api.Tree
68      */
69     public Tree duplicate(boolean withData);
70
71 }
Popular Tags