1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
/* * @(#)DropTargetDropEvent.java 1.29 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.awt.dnd; import java.awt.Point; import java.awt.datatransfer.DataFlavor; import java.awt.datatransfer.Transferable; import java.util.List; /** * The <code>DropTargetDropEvent</code> is delivered * via the <code>DropTargetListener</code> drop() method. * <p> * The <code>DropTargetDropEvent</code> reports the <i>source drop actions</i> * and the <i>user drop action</i> that reflect the current state of the * drag-and-drop operation. * <p> * <i>Source drop actions</i> is a bitwise mask of <code>DnDConstants</code> * that represents the set of drop actions supported by the drag source for * this drag-and-drop operation. * <p> * <i>User drop action</i> 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: * <pre> * Ctrl + Shift -> ACTION_LINK * Ctrl -> ACTION_COPY * Shift -> ACTION_MOVE * </pre> * If the user selects a drop action, the <i>user drop action</i> is one of * <code>DnDConstants</code> that represents the selected drop action if this * drop action is supported by the drag source or * <code>DnDConstants.ACTION_NONE</code> if this drop action is not supported * by the drag source. * <p> * If the user doesn't select a drop action, the set of * <code>DnDConstants</code> that represents the set of drop actions supported * by the drag source is searched for <code>DnDConstants.ACTION_MOVE</code>, * then for <code>DnDConstants.ACTION_COPY</code>, then for * <code>DnDConstants.ACTION_LINK</code> and the <i>user drop action</i> is the * first constant found. If no constant is found the <i>user drop action</i> * is <code>DnDConstants.ACTION_NONE</code>. * * @version 1.29, 11/17/05 * @since 1.2 */ public class DropTargetDropEvent extends DropTargetEvent { private static final long serialVersionUID = -1721911170440459322L; /** * Construct a <code>DropTargetDropEvent</code> given * the <code>DropTargetContext</code> for this operation, * the location of the drag <code>Cursor</code>'s * hotspot in the <code>Component</code>'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 <code>false</code>. * <P> * @param dtc The <code>DropTargetContext</code> for this operation * @param cursorLocn The location of the "Drag" Cursor's * hotspot in <code>Component</code> coordinates * @param dropAction the user drop action. * @param srcActions the source drop actions. * * @throws <code>NullPointerException</code> * if cursorLocn is <code>null</code> * @throws <code>IllegalArgumentException</code> if dropAction is not one of * <code>DnDConstants</code>. * @throws <code>IllegalArgumentException</code> if srcActions is not * a bitwise mask of <code>DnDConstants</code>. * @throws <code>IllegalArgumentException</code> if dtc is <code>null</code>. */ 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 <code>DropTargetEvent</code> given the * <code>DropTargetContext</code> for this operation, * the location of the drag <code>Cursor</code>'s hotspot * in the <code>Component</code>'s * coordinates, the currently selected user drop action, * the current set of actions supported by the source, * and a <code>boolean</code> indicating if the source is in the same JVM * as the target. * <P> * @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 <code>NullPointerException</code> if cursorLocn is * <code>null</code> * @throws <code>IllegalArgumentException</code> if dropAction is not one of * <code>DnDConstants</code>. * @throws <code>IllegalArgumentException</code> if srcActions is not * a bitwise mask of <code>DnDConstants</code>. * @throws <code>IllegalArgumentException</code> if dtc is <code>null</code>. */ public DropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions, boolean isLocal) { this(dtc, cursorLocn, dropAction, srcActions); isLocalTx = isLocal; } /** * This method returns a <code>Point</code> * indicating the <code>Cursor</code>'s current * location in the <code>Component</code>'s coordinates. * <P> * @return the current <code>Cursor</code> location in Component's coords. */ public Point getLocation() { return location; } /** * This method returns the current DataFlavors. * <P> * @return current DataFlavors */ public DataFlavor[] getCurrentDataFlavors() { return getDropTargetContext().getCurrentDataFlavors(); } /** * This method returns the currently available * <code>DataFlavor</code>s as a <code>java.util.List</code>. * <P> * @return the currently available DataFlavors as a java.util.List */ public List<DataFlavor> getCurrentDataFlavorsAsList() { return getDropTargetContext().getCurrentDataFlavorsAsList(); } /** * This method returns a <code>boolean</code> indicating if the * specified <code>DataFlavor</code> is available * from the source. * <P> * @param df the <code>DataFlavor</code> to test * <P> * @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 <code>Transferable</code> object * associated with the drop. * <P> * @return the <code>Transferable</code> associated with the drop */ public Transferable getTransferable() { return getDropTargetContext().getTransferable(); } /** * accept the drop, using the specified action. * <P> * @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 <code>DragSource</code> * that the drop transfer(s) are completed. * <P> * @param success a <code>boolean</code> indicating that the drop transfer(s) are completed. */ public void dropComplete(boolean success) { getDropTargetContext().dropComplete(success); } /** * This method returns an <code>int</code> indicating if * the source is in the same JVM as the target. * <P> * @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; /** * <code>true</code> if the source is in the same JVM as the target. * * @serial */ private boolean isLocalTx = false; }