KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ojb > tools > mapping > reversedb2 > dnd2 > DropPasteWorkerInterface


1 package org.apache.ojb.tools.mapping.reversedb2.dnd2;
2
3 /* Copyright 2002-2005 The Apache Software Foundation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 import java.awt.Component JavaDoc;
19 import java.awt.datatransfer.DataFlavor JavaDoc;
20 import java.awt.datatransfer.Transferable JavaDoc;
21
22 /**
23  * This interface is used by DropTargetHelper to determine whether a drop
24  * can be performed and to import the data from the transferable into the
25  * model of the component.
26  * @author <a HREF="mailto:bfl@florianbruckner.com">Florian Bruckner</a>
27  * @version $Id: DropPasteWorkerInterface.java,v 1.1.2.1 2005/12/21 22:32:42 tomdz Exp $
28  */
29
30 public interface DropPasteWorkerInterface
31 {
32  
33     /**
34      * @return the DataFlavor this Worker is going to accept.
35      */
36     public DataFlavor JavaDoc getSupportedDataFlavor();
37     
38     /** Returns a bitmaks of acceptable actions for the supplied Component
39      * and DataFlavor. If more than one DataFlavor is queried, the resulting
40      * bitmask should include all possible actions for all flavors.
41      * @return a bitmask of actions this Worker can process with the supplied
42      * flavors.
43      * @param c The component that is the possible drop target.
44      * @param flavor The DataFlavours that are associate with the drop action
45      */
46     int getAcceptableActions(Component JavaDoc c, DataFlavor JavaDoc[] flavor);
47     
48     /** Returns a bitmask of acceptable actions for this component. As this
49      * method doesn't provide the DataFlavors in this action, all possible
50      * acceptable actions should be returned. All possible actions are defined
51      * in DnDWorkerConstants
52      * @return a bitmask of actions this Worker capable of.
53      * @param c The component where the drop could occur.
54      */
55     int getAcceptableActions(Component JavaDoc c);
56     
57     /** This is the method that is doing the real work. You get the Component
58      * where the drop has occurred, the Transferable with the data and the
59      * requested action.
60      * @return true if the transfer was successful, false if not. If there
61      * are more than one Workers are registered with the helper and this
62      * method returns false, the next helper is asked to do the import. If true
63      * is returned, the action is supposed to be complete and no other worker
64      * will be asked. So be careful what you return here, if you return false,
65      * no modification to the target model should have happened.
66      * @param c The component where the drop has occurred
67      * @param t The transferable that shall be imported
68      * @param action The action that should be performed.
69      */
70     boolean importData(Component JavaDoc c, Transferable JavaDoc t, int action);
71 }
72
Popular Tags