Serializable
public class DropTargetDropEvent extends DropTargetEvent
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
.
context
source
Constructor | Description |
---|---|
DropTargetDropEvent |
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. |
DropTargetDropEvent |
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. |
Modifier and Type | Method | Description |
---|---|---|
void |
acceptDrop |
accept the drop, using the specified action. |
void |
dropComplete |
This method notifies the DragSource that the drop transfer(s) are completed. |
DataFlavor[] |
getCurrentDataFlavors() |
This method returns the current DataFlavors. |
List |
getCurrentDataFlavorsAsList() |
This method returns the currently available DataFlavor s as a java.util.List . |
int |
getDropAction() |
This method returns the user drop action. |
Point |
getLocation() |
This method returns a Point indicating the Cursor 's current location in the Component 's coordinates. |
int |
getSourceActions() |
This method returns the source drop actions. |
Transferable |
getTransferable() |
This method returns the Transferable object associated with the drop. |
boolean |
isDataFlavorSupported |
This method returns a boolean indicating if the specified DataFlavor is available from the source. |
boolean |
isLocalTransfer() |
This method returns an int indicating if the source is in the same JVM as the target. |
void |
rejectDrop() |
reject the Drop. |
getDropTargetContext
getSource, toString
public DropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions)
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, isLocalTransfer()
will return false
.dtc
- The DropTargetContext
for this operationcursorLocn
- The location of the "Drag" Cursor's hotspot in Component
coordinatesdropAction
- the user drop action.srcActions
- the source drop actions.NullPointerException
- if cursorLocn is null
IllegalArgumentException
- if dropAction is not one of DnDConstants
.IllegalArgumentException
- if srcActions is not a bitwise mask of DnDConstants
.IllegalArgumentException
- if dtc is null
.public DropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions, boolean isLocal)
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.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 targetNullPointerException
- if cursorLocn is null
IllegalArgumentException
- if dropAction is not one of DnDConstants
.IllegalArgumentException
- if srcActions is not a bitwise mask of DnDConstants
.IllegalArgumentException
- if dtc is null
.public Point getLocation()
Point
indicating the Cursor
's current location in the Component
's coordinates.Cursor
location in Component's coords.public DataFlavor[] getCurrentDataFlavors()
public List<DataFlavor> getCurrentDataFlavorsAsList()
DataFlavor
s as a java.util.List
.public boolean isDataFlavorSupported(DataFlavor df)
boolean
indicating if the specified DataFlavor
is available from the source.df
- the DataFlavor
to testpublic int getSourceActions()
public int getDropAction()
public Transferable getTransferable()
Transferable
object associated with the drop.Transferable
associated with the droppublic void acceptDrop(int dropAction)
dropAction
- the specified actionpublic void rejectDrop()
public void dropComplete(boolean success)
DragSource
that the drop transfer(s) are completed.success
- a boolean
indicating that the drop transfer(s) are completed.public boolean isLocalTransfer()
int
indicating if the source is in the same JVM as the target.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/dnd/DropTargetDropEvent.html