KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*====================================================================
2
3 Objectweb Browser Framework
4 Copyright (C) 2000-2003 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.browser.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="../../../../../../resources/browser_dtd.html#menu">DTD element</a> or to
34  * an <a HREF="package-summary.html#xml">XML example.</a>
35  * </p>
36  *
37  * <p>
38  * Example:
39  * <pre>
40  * public int
41  * getStatus(TreeView treeView)
42  * {
43  * // Enabled item
44  * return MenuItem.ENABLED_STATUS;
45  * }
46  *
47  * public void
48  * actionPerformed(MenuItemTreeView treeView)
49  * throws Exception
50  * {
51  * // Obtaining the name of the entry
52  * String value = (String)treeView.getSelectedEntry().getName();
53  * // Obtaining the Java Properties
54  * Properties properties = (Properties)treeView.getParentObject();
55  * // Removing the property
56  * properties.remove(value);
57  * }
58  * </pre>
59  * This action allows to remove a property from a <code>java.util.Properties<code> object.
60  * It consists of obtaining the name of the entry, obtaining the <code>java.util.Properties<code> object
61  * and removing the property entry. <br>
62  * This action is defined for <code>java.util.Properties<code> object but is available
63  * at the tree child level, because of the <code>tree-child-visible="true"</code> tag in the XML document.
64  * </p>
65  *
66  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>,
67  * <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>
68  *
69  * @version 0.2
70  */
71 public interface MenuItem
72 {
73
74     /** Indicates that a menu is enabled */
75     public static final int ENABLED_STATUS = 1;
76
77     /** Indicates that a menu is disabled */
78     public static final int DISABLED_STATUS = ENABLED_STATUS + 1;
79
80     /** Indicates that a menu is not visible */
81     public static final int NOT_VISIBLE_STATUS = DISABLED_STATUS + 1;
82
83     /**
84      * Indicates if the menu item must be enabled, disabled or not visible.
85      * <br>Possible values:
86      * <ul>
87      * <li>ENABLED_STATUS: The menu item is enabled.</li>
88      * <li>DISABLED_STATUS: The menu item is disabled.</li>
89      * <li>NOT_VISIBLE_STATUS: The menu item is not visible.</li>
90      * </ul>
91      *
92      * @param treeView A view to obtain the node to check.
93      *
94      * @return The status associated to the menu item.
95      */
96     public int
97     getStatus(TreeView treeView);
98
99     /**
100      * Invoked when an action occurs on the menu item.
101      *
102      * @param treeView The contextual MenuItemTreeView.
103      *
104      * @exception Exception The invocation may thrown every kind of exception.
105      */
106     public void
107     actionPerformed(MenuItemTreeView treeView)
108     throws Exception JavaDoc;
109     
110 }
111
Popular Tags