KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > core > common > api > Description


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.common.api;
27
28 /**
29  *
30  *
31  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>,
32  * <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>.
33  *
34  * @version 0.1
35  */
36 public interface Description {
37     
38     /** The list of available properties. */
39     public static final String JavaDoc CODE_DESCRIPTION = "code";
40     public static final String JavaDoc ICON_DESCRIPTION = "icon";
41     public static final String JavaDoc MENU_DESCRIPTION = "menu";
42     public static final String JavaDoc ROLE_DESCRIPTION = "role";
43     public static final String JavaDoc ROOT_DESCRIPTION = "root";
44     public static final String JavaDoc ITEM_DESCRIPTION = "item";
45     public static final String JavaDoc ACCELERATOR_DESCRIPTION = "accelerator";
46     public static final String JavaDoc MNEMONIC_DESCRIPTION = "mnemonic";
47     public static final String JavaDoc SEPARATOR_DESCRIPTION = "separator";
48     public static final String JavaDoc DND_DESCRIPTION = "dnd";
49     public static final String JavaDoc PANEL_DESCRIPTION = "panel";
50     
51     /**
52      * Provides the type of the description.
53      * The available types are:
54      * <ul>
55      * <li>CODE_DESCRIPTION for defining code.</li>
56      * <li>ICON_DESCRIPTION for defining icon.</li>
57      * <li>MENU_DESCRIPTION for defining menu.</li>
58      * <li>ROLE_DESCRIPTION for defining role.</li>
59      * <li>...</li>
60      * </ul>
61      * @return The type of the description.
62      */
63     public String JavaDoc getDescriptionType();
64     
65     /**
66      * Indicates if an Object is considered as null.
67      * For instance, a object may be considered as null
68      * if its attributes are null.
69      * @return true if the object is considered as null.
70      */
71     public boolean isEmpty();
72     
73     // TODO: Need to be defined (i.e.: toString, equals, hashCode)
74
75 }
76
Popular Tags