KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > core > dnd > api > DnDDescriptions


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.dnd.api;
27
28 import org.objectweb.util.explorer.core.common.api.Description;
29
30 /**
31  *
32  *
33  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jérôme Moroy</a>,
34  * <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>.
35  *
36  * @version 0.1
37  */
38 public interface DnDDescriptions
39          extends Description
40 {
41     
42     /**
43      * Adds the given drop action into the list of available DnD actions.
44      * @param codeDesc The description of the code defining the drop action.
45      */
46     public void addDropAction(DnDDescription dndDesc);
47     
48     /**
49      * Provides the drop action corresponding to the given acion type.
50      * @param actionType The type of the action. This parameter may take
51      * the following values:
52      * <ul>
53      * <li>DnDDescription.MOVE_ACTION</li>
54      * <li>DnDDescription.COPY_ACTION</li>
55      * <li>DnDDescription.LINK_ACTION</li>
56      * </ul>
57      * @return The corresponding drop action.
58      */
59     public DnDDescription getDropAction(String JavaDoc actionType);
60     
61     /**
62      * Provides a string representation for all the available drop actions.
63      * @return An array containing the representation of the available drop actions (One drop action description per array element).
64      */
65     public String JavaDoc[] getActionsDescription();
66     
67 }
68
Popular Tags