KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > browser > core > api > BrowserProperty


1 /*===========================================================================
2
3 ObjectWeb Browser Framework
4 Copyright (C) 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.
23 Contributor(s): ______________________________________.
24
25 ===========================================================================*/
26
27 package org.objectweb.util.browser.core.api;
28
29 /** The console's imports */
30 import org.objectweb.util.browser.api.Entry;
31 import org.objectweb.util.browser.core.common.ExtendedBoolean;
32
33 /**
34  * Interface which allow to try to load a new property concerning an object (icon, panel, menu, wrapper)
35  * It looks for the id in its context which contains all the node property.
36  *
37  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jerome Moroy</a>
38  * @version 0.1
39  */
40 public interface BrowserProperty {
41
42     /**
43      * Fixes the context property to use to constructs the wrappers
44      * @param properties The context property to use
45      */
46     public void setContextProperty(ContextProperty properties);
47
48     /**
49      * Provides the TypeSystem to use in order to find appropriate key.
50      * @return The TypeSystem to use.
51      */
52     public TypeSystem getTypeSystem();
53
54     /**
55      * Provides the entry to add into the icon property context or null.
56      * @param id The research key
57      * @return The entry to add or null
58      */
59     public Entry getIcon(String JavaDoc id, Role role, ExtendedBoolean nodeFound);
60
61     /**
62      * Provides the entry to add into the panel property context or null.
63      * @param id The research key
64      * @return The entry to add or null
65      */
66     public Entry getPanel(String JavaDoc id, Role role, ExtendedBoolean nodeFound);
67
68     /**
69      * Provides the entry to add into the menu property context or null.
70      * @param id The research key (a class name)
71      * @param role The associated role
72      * @param nodeFound Indicates if a node has been found or not.
73      * @return The entry to add or null
74      */
75     public Entry getMenu(String JavaDoc id, Role role, ExtendedBoolean nodeFound);
76
77     /**
78      * Provides the entry to add into the wrapper property context or null.
79      * @param id The research key
80      * @return The entry to add or null
81      */
82     public Entry getWrapper(String JavaDoc id, Role role, ExtendedBoolean nodeFound);
83     
84     /**
85      * Provides the entry to add into the dropaction property context or null.
86      * @param id The research key
87      * @return The entry to add or null
88      */
89     public Entry getDropAction(String JavaDoc id, Role role, ExtendedBoolean nodeFound);
90
91     /**
92      * Provides the entry to add into the info property context or null.
93      * @param id The research key
94      * @return The associated entry or null
95      */
96     public Entry getInfo(String JavaDoc id, Role role, ExtendedBoolean nodeFound);
97
98     /**
99      * Provides the initial context factory for the given role.
100      */
101     public RootFactory getRoot(Role role);
102   
103     /**
104      * Provides the inherited roles of the current role. If no inherited node is defined, an empty array is return.
105      * @param role The role.
106      * @return An array containing the inherited roles for the current role.
107      */
108     public Role[] getInheritedRoles();
109     
110 }
111
Popular Tags