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

DropTargetDragEvent

public class DropTargetDragEvent extends DropTargetEvent
The DropTargetDragEvent is delivered to a DropTargetListener via its dragEnter() and dragOver() methods.

The DropTargetDragEvent reports the source drop actions and the user drop action that reflect the current state of the drag 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 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.24, 05/05/04
since
1.2

Fields Summary
private static final long
serialVersionUID
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.
Constructors Summary
public DropTargetDragEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions)
Construct a DropTargetDragEvent given the DropTargetContext for this operation, the location of the "Drag" Cursor's hotspot in the Component's coordinates, the user drop action, and the source drop actions.

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;
    
Methods Summary
public voidacceptDrag(int dragOperation)
Accepts the drag. This method should be called from a DropTargetListeners dragEnter, dragOver, and dropActionChanged methods if the implementation wishes to accept an operation from the srcActions other than the one selected by the user as represented by the dropAction.

param
dragOperation the operation accepted by the target

	getDropTargetContext().acceptDrag(dragOperation);
    
public java.awt.datatransfer.DataFlavor[]getCurrentDataFlavors()
This method returns the current DataFlavors from the DropTargetContext.

return
current DataFlavors from the DropTargetContext

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

return
a java.util.List of the Current DataFlavors

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

return
the user drop action

 return dropAction; 
public java.awt.PointgetLocation()
This method returns a Point indicating the Cursor's current location within 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 that represents the data associated with the current drag operation.

return
the Transferable associated with the drag operation
throws
InvalidDnDOperationException if the data associated with the drag operation is not available
since
1.5

	return getDropTargetContext().getTransferable();
    
public booleanisDataFlavorSupported(java.awt.datatransfer.DataFlavor df)
This method returns a boolean indicating if the specified DataFlavor is supported.

param
df the DataFlavor to test

return
if a particular DataFlavor is supported

	return getDropTargetContext().isDataFlavorSupported(df);
    
public voidrejectDrag()
Rejects the drag as a result of examining either the dropAction or the available DataFlavor types.

	getDropTargetContext().rejectDrag();