Class DropTargetDropEvent
- All Implemented Interfaces:
Serializable
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_MOVEIf 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
- See Also:
-
Field Summary
Fields declared in class java.awt.dnd.DropTargetEvent
contextFields declared in class java.util.EventObject
source -
Constructor Summary
ConstructorsConstructorDescriptionDropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions) Construct aDropTargetDropEventgiven theDropTargetContextfor this operation, the location of the dragCursor's hotspot in theComponent's coordinates, the currently selected user drop action, and the current set of actions supported by the source.DropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions, boolean isLocal) Construct aDropTargetEventgiven theDropTargetContextfor this operation, the location of the dragCursor's hotspot in theComponent's coordinates, the currently selected user drop action, the current set of actions supported by the source, and abooleanindicating if the source is in the same JVM as the target. -
Method Summary
Modifier and TypeMethodDescriptionvoidacceptDrop(int dropAction) accept the drop, using the specified action.voiddropComplete(boolean success) This method notifies theDragSourcethat the drop transfer(s) are completed.This method returns the current DataFlavors.This method returns the currently availableDataFlavors as ajava.util.List.intThis method returns the user drop action.This method returns aPointindicating theCursor's current location in theComponent's coordinates.intThis method returns the source drop actions.This method returns theTransferableobject associated with the drop.booleanThis method returns abooleanindicating if the specifiedDataFlavoris available from the source.booleanThis method returns abooleanindicating if the source is in the same JVM as the target.voidreject the Drop.Methods declared in class java.awt.dnd.DropTargetEvent
getDropTargetContextMethods declared in class java.util.EventObject
getSource, toString
-
Constructor Details
-
DropTargetDropEvent
Construct aDropTargetDropEventgiven theDropTargetContextfor this operation, the location of the dragCursor's hotspot in theComponent'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,isLocalTransfer()will returnfalse.- Parameters:
dtc- TheDropTargetContextfor this operationcursorLocn- The location of the "Drag" Cursor's hotspot inComponentcoordinatesdropAction- the user drop action.srcActions- the source drop actions.- Throws:
NullPointerException- if cursorLocn isnullIllegalArgumentException- if dropAction is not one ofDnDConstants.IllegalArgumentException- if srcActions is not a bitwise mask ofDnDConstants.IllegalArgumentException- if dtc isnull.
-
DropTargetDropEvent
public DropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions, boolean isLocal) Construct aDropTargetEventgiven theDropTargetContextfor this operation, the location of the dragCursor's hotspot in theComponent's coordinates, the currently selected user drop action, the current set of actions supported by the source, and abooleanindicating if the source is in the same JVM as the target.- Parameters:
dtc- The DropTargetContext for this operationcursorLocn- The location of the "Drag" Cursor's hotspot in Component's coordinatesdropAction- the user drop action.srcActions- the source drop actions.isLocal- True if the source is in the same JVM as the target- Throws:
NullPointerException- if cursorLocn isnullIllegalArgumentException- if dropAction is not one ofDnDConstants.IllegalArgumentException- if srcActions is not a bitwise mask ofDnDConstants.IllegalArgumentException- if dtc isnull.
-
-
Method Details
-
getLocation
This method returns aPointindicating theCursor's current location in theComponent's coordinates.- Returns:
- the current
Cursorlocation in Component's coords.
-
getCurrentDataFlavors
This method returns the current DataFlavors.- Returns:
- current DataFlavors
-
getCurrentDataFlavorsAsList
This method returns the currently availableDataFlavors as ajava.util.List.- Returns:
- the currently available DataFlavors as a java.util.List
-
isDataFlavorSupported
This method returns abooleanindicating if the specifiedDataFlavoris available from the source.- Parameters:
df- theDataFlavorto test- Returns:
trueif theDataFlavorspecified is available from the source, otherwisefalse
-
getSourceActions
public int getSourceActions()This method returns the source drop actions.- Returns:
- the source drop actions.
-
getDropAction
public int getDropAction()This method returns the user drop action.- Returns:
- the user drop actions.
-
getTransferable
This method returns theTransferableobject associated with the drop.- Returns:
- the
Transferableassociated with the drop
-
acceptDrop
public void acceptDrop(int dropAction) accept the drop, using the specified action.- Parameters:
dropAction- the specified action
-
rejectDrop
public void rejectDrop()reject the Drop. -
dropComplete
public void dropComplete(boolean success) This method notifies theDragSourcethat the drop transfer(s) are completed.- Parameters:
success- abooleanindicating that the drop transfer(s) are completed.
-
isLocalTransfer
public boolean isLocalTransfer()This method returns abooleanindicating if the source is in the same JVM as the target.- Returns:
trueif the Source is in the same JVM, otherwisefalse
-