KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > browser > plugin > java > CollectionRemoveObjectAction


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): Philippe Merle, Jerome Moroy.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.util.browser.plugin.java;
28
29 import java.util.Collection JavaDoc;
30
31 import org.objectweb.util.browser.api.MenuItem;
32 import org.objectweb.util.browser.api.MenuItemTreeView;
33 import org.objectweb.util.browser.api.TreeView;
34
35 /**
36  * This action removes an element from a <code>java.util.Collection</code> object.
37  *
38  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>,
39  * <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>
40  *
41  * @version 0.1
42  */
43 public class CollectionRemoveObjectAction
44     implements MenuItem {
45
46     //==================================================================
47 //
48 // No internal state.
49 //
50 //==================================================================
51
52     //==================================================================
53 //
54 // No constructor.
55 //
56 //==================================================================
57
58     //==================================================================
59 //
60 // No internal method.
61 //
62 //==================================================================
63
64     //==================================================================
65 //
66 // Public methods for MenuItem.
67 //
68 //==================================================================
69
70     /**
71      * Indicates if the menu item must be enabled, disabled or not visible.
72      * <br>Possible values:
73      * <ul>
74      * <li>ENABLED_STATUS: The menu item is enabled.</li>
75      * <li>DISABLED_STATUS: The menu item is disabled.</li>
76      * <li>NOT_VISIBLE_STATUS: The menu item is not visible.</li>
77      * </ul>
78      *
79      * @param treeView A view to obtain the node to check.
80      *
81      * @return The status associated to the menu item.
82      */
83     public int
84     getStatus(TreeView treeView) {
85         return MenuItem.ENABLED_STATUS;
86     }
87
88     /**
89      * Invoked when an action occurs on the menu item.
90      *
91      * @param treeView The contextual MenuItemTreeView.
92      *
93      * @exception Exception The invocation may thrown every kind of exception.
94      */
95     public void
96     actionPerformed(MenuItemTreeView treeView)
97     throws Exception JavaDoc {
98         Collection JavaDoc collection = (Collection JavaDoc)treeView.getParentObject();
99         Object JavaDoc objectToRemove = treeView.getSelectedObject();
100         collection.remove(objectToRemove);
101     }
102         
103 }
Popular Tags