/* * Copyright (c) 1997, 2004, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package java.awt.dnd; import java.awt.Point; import java.awt.datatransfer.DataFlavor; import java.awt.datatransfer.Transferable; import java.util.List; /** * The DropTargetDropEvent is delivered * via the DropTargetListener drop() method. *

* The DropTargetDropEvent reports the source drop actions * and the user drop action that reflect the current state of the * drag-and-drop operation. *

* Source drop actions is a bitwise mask of DnDConstants * that represents the set of drop actions supported by the drag source for * this drag-and-drop operation. *

* User drop action depends on the drop actions supported by the drag * source and the drop action selected by the user. The user can select a drop * action by pressing modifier keys during the drag operation: *

 *   Ctrl + Shift -> ACTION_LINK
 *   Ctrl         -> ACTION_COPY
 *   Shift        -> ACTION_MOVE
 * 
* If the user selects a drop action, the user drop action is one of * DnDConstants that represents the selected drop action if this * drop action is supported by the drag source or * DnDConstants.ACTION_NONE if this drop action is not supported * by the drag source. *

* If the user doesn't select a drop action, the set of * DnDConstants that represents the set of drop actions supported * by the drag source is searched for DnDConstants.ACTION_MOVE, * then for DnDConstants.ACTION_COPY, then for * DnDConstants.ACTION_LINK and the user drop action is the * first constant found. If no constant is found the user drop action * is DnDConstants.ACTION_NONE. * * @since 1.2 */ public class DropTargetDropEvent extends DropTargetEvent { private static final long serialVersionUID = -1721911170440459322L; /** * Construct a DropTargetDropEvent given * the DropTargetContext for this operation, * the location of the drag Cursor's * hotspot in the Component's coordinates, * the currently * selected user drop action, and the current set of * actions supported by the source. * By default, this constructor * assumes that the target is not in the same virtual machine as * the source; that is, {@link #isLocalTransfer()} will * return false. *

* @param dtc The DropTargetContext for this operation * @param cursorLocn The location of the "Drag" Cursor's * hotspot in Component coordinates * @param dropAction the user drop action. * @param srcActions the source drop actions. * * @throws NullPointerException * if cursorLocn is null * @throws IllegalArgumentException if dropAction is not one of * DnDConstants. * @throws IllegalArgumentException if srcActions is not * a bitwise mask of DnDConstants. * @throws IllegalArgumentException if dtc is null. */ public DropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions) { super(dtc); if (cursorLocn == null) throw new NullPointerException("cursorLocn"); if (dropAction != DnDConstants.ACTION_NONE && dropAction != DnDConstants.ACTION_COPY && dropAction != DnDConstants.ACTION_MOVE && dropAction != DnDConstants.ACTION_LINK ) throw new IllegalArgumentException("dropAction = " + dropAction); if ((srcActions & ~(DnDConstants.ACTION_COPY_OR_MOVE | DnDConstants.ACTION_LINK)) != 0) throw new IllegalArgumentException("srcActions"); location = cursorLocn; actions = srcActions; this.dropAction = dropAction; } /** * Construct a DropTargetEvent given the * DropTargetContext for this operation, * the location of the drag Cursor's hotspot * in the Component's * coordinates, the currently selected user drop action, * the current set of actions supported by the source, * and a boolean indicating if the source is in the same JVM * as the target. *

* @param dtc The DropTargetContext for this operation * @param cursorLocn The location of the "Drag" Cursor's * hotspot in Component's coordinates * @param dropAction the user drop action. * @param srcActions the source drop actions. * @param isLocal True if the source is in the same JVM as the target * * @throws NullPointerException if cursorLocn is * null * @throws IllegalArgumentException if dropAction is not one of * DnDConstants. * @throws IllegalArgumentException if srcActions is not * a bitwise mask of DnDConstants. * @throws IllegalArgumentException if dtc is null. */ public DropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions, boolean isLocal) { this(dtc, cursorLocn, dropAction, srcActions); isLocalTx = isLocal; } /** * This method returns a Point * indicating the Cursor's current * location in the Component's coordinates. *

* @return the current Cursor location in Component's coords. */ public Point getLocation() { return location; } /** * This method returns the current DataFlavors. *

* @return current DataFlavors */ public DataFlavor[] getCurrentDataFlavors() { return getDropTargetContext().getCurrentDataFlavors(); } /** * This method returns the currently available * DataFlavors as a java.util.List. *

* @return the currently available DataFlavors as a java.util.List */ public List getCurrentDataFlavorsAsList() { return getDropTargetContext().getCurrentDataFlavorsAsList(); } /** * This method returns a boolean indicating if the * specified DataFlavor is available * from the source. *

* @param df the DataFlavor to test *

* @return if the DataFlavor specified is available from the source */ public boolean isDataFlavorSupported(DataFlavor df) { return getDropTargetContext().isDataFlavorSupported(df); } /** * This method returns the source drop actions. * * @return the source drop actions. */ public int getSourceActions() { return actions; } /** * This method returns the user drop action. * * @return the user drop actions. */ public int getDropAction() { return dropAction; } /** * This method returns the Transferable object * associated with the drop. *

* @return the Transferable associated with the drop */ public Transferable getTransferable() { return getDropTargetContext().getTransferable(); } /** * accept the drop, using the specified action. *

* @param dropAction the specified action */ public void acceptDrop(int dropAction) { getDropTargetContext().acceptDrop(dropAction); } /** * reject the Drop. */ public void rejectDrop() { getDropTargetContext().rejectDrop(); } /** * This method notifies the DragSource * that the drop transfer(s) are completed. *

* @param success a boolean indicating that the drop transfer(s) are completed. */ public void dropComplete(boolean success) { getDropTargetContext().dropComplete(success); } /** * This method returns an int indicating if * the source is in the same JVM as the target. *

* @return if the Source is in the same JVM */ public boolean isLocalTransfer() { return isLocalTx; } /* * fields */ static final private Point zero = new Point(0,0); /** * The location of the drag cursor's hotspot in Component coordinates. * * @serial */ private Point location = zero; /** * The source drop actions. * * @serial */ private int actions = DnDConstants.ACTION_NONE; /** * The user drop action. * * @serial */ private int dropAction = DnDConstants.ACTION_NONE; /** * true if the source is in the same JVM as the target. * * @serial */ private boolean isLocalTx = false; }