KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > core > panel > api > PanelDescription


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 package org.objectweb.util.explorer.core.panel.api;
27
28 import org.objectweb.util.explorer.core.code.api.CodeDescription;
29 import org.objectweb.util.explorer.core.common.api.Description;
30
31 /**
32  *
33  *
34  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>,
35  * <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>.
36  *
37  * @version 0.1
38  */
39 public interface PanelDescription
40          extends Description
41 {
42
43     /** The different kind of panels. */
44     public static final String JavaDoc PANEL = "panel";
45     public static final String JavaDoc TABLE = "table";
46     public static final String JavaDoc COMPOSITE_PANEL = "composite";
47
48     /**
49      * Provides the type of panel
50      * @return
51      */
52     public String JavaDoc getPanelType();
53     
54     /**
55      * Returns the code associated to this panel.
56      * The returned value may be null in the case of a composite panel.
57      */
58     public CodeDescription getCodeDescription();
59     
60     /**
61      * Fixes the code associated to this panel.
62      * @param codeDesc The associated code description.
63      */
64     public void setCodeDescription(CodeDescription codeDesc);
65     
66     /**
67      * Fixes the inheritTypePanel value.
68      * @param inheritTypePanel true if this panel has to inherit panel
69      * from parents at the java type inheritance level and false otherwise.
70      */
71     public void setInheritTypePanel(boolean inheritTypePanel);
72     
73     /**
74      * Indicates if this panel has to inherit panel from parents
75      * at the java type inheritance level.
76      */
77     public boolean inheritTypePanel();
78     
79 }
80
Popular Tags