FileDocCategorySizeDatePackage
DropTargetDropEvent.javaAPI DocJava SE 5 API9173Fri Aug 26 14:56:48 BST 2005java.awt.dnd

DropTargetDropEvent

public class DropTargetDropEvent extends DropTargetEvent
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.

version
1.28, 05/05/04
since
1.2

Fields Summary
private static final long
serialVersionUID
private static final Point
zero
private Point
location
The location of the drag cursor's hotspot in Component coordinates.
private int
actions
The source drop actions.
private int
dropAction
The user drop action.
private boolean
isLocalTx
true if the source is in the same JVM as the target.
Constructors Summary
public DropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions)
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.


                                                                                                                                                                     

              
	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;
    
public DropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions, boolean isLocal)
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.

	this(dtc, cursorLocn, dropAction, srcActions);

	isLocalTx = isLocal;
    
Methods Summary
public voidacceptDrop(int dropAction)
accept the drop, using the specified action.

param
dropAction the specified action

	getDropTargetContext().acceptDrop(dropAction);
    
public voiddropComplete(boolean success)
This method notifies the DragSource that the drop transfer(s) are completed.

param
success a boolean indicating that the drop transfer(s) are completed.

	getDropTargetContext().dropComplete(success);
    
public java.awt.datatransfer.DataFlavor[]getCurrentDataFlavors()
This method returns the current DataFlavors.

return
current DataFlavors

	return getDropTargetContext().getCurrentDataFlavors();
    
public java.util.ListgetCurrentDataFlavorsAsList()
This method returns the currently available DataFlavors as a java.util.List.

return
the currently available DataFlavors as a java.util.List

	return getDropTargetContext().getCurrentDataFlavorsAsList();
    
public intgetDropAction()
This method returns the user drop action.

return
the user drop actions.

 return dropAction; 
public java.awt.PointgetLocation()
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.

	return location;
    
public intgetSourceActions()
This method returns the source drop actions.

return
the source drop actions.

 return actions; 
public java.awt.datatransfer.TransferablegetTransferable()
This method returns the Transferable object associated with the drop.

return
the Transferable associated with the drop

	return getDropTargetContext().getTransferable();
    
public booleanisDataFlavorSupported(java.awt.datatransfer.DataFlavor df)
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

 	return getDropTargetContext().isDataFlavorSupported(df);
    
public booleanisLocalTransfer()
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

	return isLocalTx;
    
public voidrejectDrop()
reject the Drop.

	getDropTargetContext().rejectDrop();