KickJava   Java API By Example, From Geeks To Geeks.

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


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  * <p>
31  * Defines an menu item in a popup menu. <br>
32  * In order to define a menu item, you can have a look to the corresponding
33  * <a HREF="explorer-dtd.html#menu">DTD element</a> or to
34  * an <a HREF="package-summary.html#xml">XML example.</a>
35  * </p>
36  *
37  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>,
38  * <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>
39  *
40  * @version 0.2
41  */
42 public interface MenuItem
43 {
44
45     /** Indicates that a menu is enabled */
46     public static final int ENABLED_STATUS = 1;
47
48     /** Indicates that a menu is disabled */
49     public static final int DISABLED_STATUS = ENABLED_STATUS + 1;
50
51     /** Indicates that a menu is not visible */
52     public static final int NOT_VISIBLE_STATUS = DISABLED_STATUS + 1;
53
54     /**
55      * Indicates if the menu item must be enabled, disabled or not visible.
56      * <br>Possible values:
57      * <ul>
58      * <li>ENABLED_STATUS: The menu item is enabled.</li>
59      * <li>DISABLED_STATUS: The menu item is disabled.</li>
60      * <li>NOT_VISIBLE_STATUS: The menu item is not visible.</li>
61      * </ul>
62      *
63      * @param treeView A view to obtain the node to check.
64      *
65      * @return The status associated to the menu item.
66      */
67     public int
68     getStatus(TreeView treeView);
69
70     /**
71      * Invoked when an action occurs on the menu item.
72      *
73      * @param treeView The contextual MenuItemTreeView.
74      *
75      * @exception Exception The invocation may thrown every kind of exception.
76      */
77     public void
78     actionPerformed(MenuItemTreeView treeView)
79     throws Exception JavaDoc;
80     
81 }
82
Popular Tags