KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > api > TreeView


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.api;
28
29 /**
30  * Offers a contextual view on the tree.
31  *
32  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>,
33  * <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>
34  *
35  * @version 0.2
36  */
37 public interface TreeView
38 {
39
40     /**
41      * Returns the current selected Entry.
42      */
43     public Entry
44     getSelectedEntry();
45
46     /**
47      * Returns the parent entry of the current selected entry.
48      */
49     public Entry
50     getParentEntry();
51
52     /**
53      * Returns the value of the current selected Entry.
54      * Equivalent to <code>getSelectedEntry().getValue()</code>.
55      */
56     public Object JavaDoc
57     getSelectedObject();
58
59     /**
60      * Returns the value of the parent entry.
61      * Equivalent to <code>getParentEntry().getValue()</code>.
62      */
63     public Object JavaDoc
64     getParentObject();
65     
66     /**
67      * Returns an object to manipulate the Tree.
68      */
69     public Tree
70     getTree();
71     
72 }
73
Popular Tags