1 /*
   2  * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.awt.dnd.peer;
  27 
  28 import java.awt.datatransfer.DataFlavor;
  29 import java.awt.datatransfer.Transferable;
  30 import java.awt.dnd.DropTarget;
  31 import java.awt.dnd.InvalidDnDOperationException;
  32 
  33 /**
  34  * <p>
  35  * This interface is exposed by the underlying window system platform to
  36  * enable control of platform DnD operations
  37  * </p>
  38  *
  39  * @since 1.2
  40  *
  41  */
  42 
  43 public interface DropTargetContextPeer {
  44 
  45     /**
  46      * update the peer's notion of the Target's actions
  47      * @param actions the actions
  48      */
  49 
  50     void setTargetActions(int actions);
  51 
  52     /**
  53      * get the current Target actions
  54      * @return the current Target actions
  55      */
  56 
  57     int getTargetActions();
  58 
  59     /**
  60      * get the DropTarget associated with this peer
  61      * @return the DropTarget associated with this peer
  62      */
  63 
  64     DropTarget getDropTarget();
  65 
  66     /**
  67      * get the (remote) DataFlavors from the peer
  68      * @return the (remote) DataFlavors from the peer
  69      */
  70 
  71     DataFlavor[] getTransferDataFlavors();
  72 
  73     /**
  74      * get an input stream to the remote data
  75      * @return an input stream to the remote data
  76      */
  77 
  78     Transferable getTransferable() throws InvalidDnDOperationException;
  79 
  80     /**
  81      * Return whether or not the DragSource Transferable is in the
  82      * same JVM as the Target.
  83      * @return if the DragSource Transferable is in the same JVM as the Target
  84      */
  85 
  86     boolean isTransferableJVMLocal();
  87 
  88     /**
  89      * accept the Drag
  90      * @param dragAction the drag action
  91      */
  92 
  93     void acceptDrag(int dragAction);
  94 
  95     /**
  96      * reject the Drag
  97      */
  98 
  99     void rejectDrag();
 100 
 101     /**
 102      * accept the Drop
 103      * @param dropAction the drop action
 104      */
 105 
 106     void acceptDrop(int dropAction);
 107 
 108     /**
 109      * reject the Drop
 110      */
 111 
 112     void rejectDrop();
 113 
 114     /**
 115      * signal complete
 116      * @param success the signal
 117      */
 118 
 119     void dropComplete(boolean success);
 120 
 121 }