KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > browser > plugins > fractal > api > FractalMenuItem


1 /*====================================================================
2  
3  Objectweb Browser 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.
23  Contributor(s): ______________________________________.
24  
25  ---------------------------------------------------------------------
26  $Id: FractalMenuItem.java,v 1.1 2004/04/20 16:37:28 moroy Exp $
27  ====================================================================*/
28
29 package org.objectweb.util.browser.plugins.fractal.api;
30
31 import org.objectweb.util.browser.api.MenuItemTreeView;
32 import org.objectweb.util.browser.api.TreeView;
33
34 /**
35  * Specialized menu item for entities having life cycle properties.
36  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jerome Moroy</a>
37  * @version 0.1
38  */
39 public interface FractalMenuItem
40 {
41     /**
42      * Called when the Fractal component is started.
43      * @see org.objectweb.util.browser.api.MenuItem#getStatus(org.objectweb.util.browser.api.TreeView)
44      * @param treeView A view on the tree.
45      * @return The status of the menu item.
46      */
47     public int getStartedStatus(TreeView treeView);
48
49     /**
50      * Called when the Fractal component is stopped.
51      * @see org.objectweb.util.browser.api.MenuItem#getStatus(org.objectweb.util.browser.api.TreeView)
52      * @param treeView A view on the tree.
53      * @return The status of the menu item.
54      */
55     public int getStoppedStatus(TreeView treeView);
56
57     /**
58      * Called when the Fractal component is stopped.
59      * @see org.objectweb.util.browser.api.MenuItem#actionPerformed(org.objectweb.util.browser.api.MenuItemEvent)
60      * @param menuItemEvent The event.
61      */
62     public void actionStoppedPerformed(MenuItemTreeView menuItemEvent) throws Exception JavaDoc;
63     
64     /**
65      * Called when the Fractal component is started.
66      * @see org.objectweb.util.browser.api.MenuItem#actionPerformed(org.objectweb.util.browser.api.MenuItemEvent)
67      * @param menuItemEvent The event.
68      */
69     public void actionStartedPerformed(MenuItemTreeView menuItemEvent) throws Exception JavaDoc;
70 }
Popular Tags