TreeConfiguration


1   /*===========================================================================
2   
3   ObjectWeb Naming Context Framework
4   Copyright (C) 2002 USTL - LIFL - GOAL
5   Contact: architecture@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): Philippe Merle, Jerome Moroy.
23  Contributor(s):  ______________________________________.
24  
25  ===========================================================================*/
26  
27  package org.objectweb.util.browser.core.api;
28  
29  import org.objectweb.util.browser.api.Context;
30  import org.objectweb.util.browser.core.common.AdminCustomization;
31  
32  /**
33   * Interface which allows to configure the dynamic tree
34   *
35   * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jerome Moroy</a>
36   * @version 0.1
37   */
38  public interface TreeConfiguration {
39  
40      /** 
41       * Creates a new browser property with the given fileName.
42       * The given files can be found in a Jar archive loaded in the ClassLoader
43       * or on the file system.
44       * @param files The properties files to parse and to apply
45       */
46      public void setNewBrowserProperty(String  [] files);
47  
48      /** 
49       * Sets a new browser property.
50       * @param properties The properties to apply
51       */
52      public void setNewBrowserProperty(BrowserProperty properties);
53  
54      /**
55       * Adds the new properties to the existing configuration.
56       * The given files can be found in a Jar archive loaded in the ClassLoader
57       * or on the file system.
58       * @param file The properties files to add
59       */
60      public void addBrowserProperty(String  [] file);
61  
62      /**
63       * Gives the current BrowserProperty. 
64       * @return The current BrowserProperty
65       */
66      public BrowserProperty getBrowserProperty();
67  
68      /**
69       * Creates a new context property with the given fileName
70       * The given files can be found in a Jar archive loaded in the ClassLoader
71       * or on the file system.
72       * @param file The properties files to parse and to apply
73       */
74      public void setNewContextProperty(String   file);
75  
76      /**
77       * Sets a new context property
78       * @param properties The properties to apply 
79       */
80      public void setNewContextProperty(ContextProperty properties);
81  
82      /**
83       * Gives the current ContextProperty.
84       * @return The current ContextProperty
85       */
86      public ContextProperty getContextProperty();
87  
88      /**
89       * Gives the initial context 
90       * @return The initial context
91       */
92      public Context getInitialContext();
93  
94      /**
95       * Returns true if this initial context contains an entry for the specified id.
96       * @param id Key whose presence in this initial context is to be tested.
97       * @return True if this initial context contains an entry for the specified id.
98       */
99      public boolean containsEntry(String   id);
100 
101     /**
102      * Fixes the target panel for the tree (Where the associated panels will be displayed).
103      * @param targetPanel The panel to use to display associated panels
104      */
105     public void setTargetPanel(ViewPanel targetPanel);
106 
107     /**
108      * Fixes the status bar for the tree (Where info will be displayed)
109      * @param statusField
110      */
111     public void setStatusBar(StatusBar statusBar);
112 
113     /**
114      * Indicates if the popup are enabled or not. By default, the popup menus are enabled.
115      * @param popupEnabled True if the popup menu have to be enabled, false either.
116      */
117     public void setPopupEnabled(boolean popupEnabled);
118     
119     /**
120      * Returns true if the popup menus are enabled.
121      * @return true if the popup menus are enabled.
122      */
123     public boolean isPopupEnabled();
124      
125     /**
126      * Indicates if the Drag and Drop is enabled or not. By default, the Drag and Drop is available.
127      * @param dndEnabled True if the popup menu have to be enabled, false either.
128      */
129     public void setDragAndDropEnabled(boolean dndEnabled);
130         
131     /**
132      * Returns true if the Drag and Drop is enabled.
133      * @return true if the Drag and Drop is enabled.
134      */
135     public boolean isDragAndDropEnabled();
136  
137     /**
138      * Indicates if the application allows the selection of several roles at the same time (the default value is false).
139      * @param multipleRolesEnabled True if the application allows the selection of several roles at the same time, false either.
140      */
141     public void setMultipleRolesEnabled(boolean multipleRolesEnabled);
142     
143     /**
144      * Returns true if the application allows the selection of several roles at the same time.
145      * @return true if the application allows the selection of several roles at the same time, false either.
146      */
147     public boolean isMultipleRolesEnabled();
148  
149     /**
150      * Provides the customizations to use for the dynamic tree.
151      * @return The AdminCustomization to use.
152      */
153     public AdminCustomization getAdminCustomization();
154     
155     /**
156      * Fixes the menu bar to use
157      * @param jMenuBar The menu bar to use
158      */
159     public void setJMenuBar(javax.swing.JMenuBar   jMenuBar);
160     
161     /**
162      * Fixes the toolBar to use
163      * @param jToolBar The toolBar to use
164      */
165     public void setJToolBar(javax.swing.JToolBar   jToolBar);
166       
167 }
168
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags