Class DropTargetDropEvent
- java.lang.Object
-
- java.util.EventObject
-
- java.awt.dnd.DropTargetEvent
-
- java.awt.dnd.DropTargetDropEvent
-
- All Implemented Interfaces:
- Serializable
public class DropTargetDropEvent extends DropTargetEvent
TheDropTargetDropEvent
is delivered via theDropTargetListener
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 ofDnDConstants
that represents the selected drop action if this drop action is supported by the drag source orDnDConstants.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 forDnDConstants.ACTION_MOVE
, then forDnDConstants.ACTION_COPY
, then forDnDConstants.ACTION_LINK
and the user drop action is the first constant found. If no constant is found the user drop action isDnDConstants.ACTION_NONE
.- Since:
- 1.2
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class java.awt.dnd.DropTargetEvent
context
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor and Description DropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions)
Construct aDropTargetDropEvent
given theDropTargetContext
for 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 aDropTargetEvent
given theDropTargetContext
for 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 aboolean
indicating if the source is in the same JVM as the target.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description void
acceptDrop(int dropAction)
accept the drop, using the specified action.void
dropComplete(boolean success)
This method notifies theDragSource
that the drop transfer(s) are completed.DataFlavor[]
getCurrentDataFlavors()
This method returns the current DataFlavors.List<DataFlavor>
getCurrentDataFlavorsAsList()
This method returns the currently availableDataFlavor
s as ajava.util.List
.int
getDropAction()
This method returns the user drop action.Point
getLocation()
This method returns aPoint
indicating theCursor
's current location in theComponent
's coordinates.int
getSourceActions()
This method returns the source drop actions.Transferable
getTransferable()
This method returns theTransferable
object associated with the drop.boolean
isDataFlavorSupported(DataFlavor df)
This method returns aboolean
indicating if the specifiedDataFlavor
is available from the source.boolean
isLocalTransfer()
This method returns anint
indicating if the source is in the same JVM as the target.void
rejectDrop()
reject the Drop.-
Methods inherited from class java.awt.dnd.DropTargetEvent
getDropTargetContext
-
Methods inherited from class java.util.EventObject
getSource, toString
-
-
-
-
Constructor Detail
DropTargetDropEvent
public DropTargetDropEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions)
Construct aDropTargetDropEvent
given theDropTargetContext
for 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
- TheDropTargetContext
for this operation -
cursorLocn
- The location of the "Drag" Cursor's hotspot inComponent
coordinates -
dropAction
- the user drop action. -
srcActions
- the source drop actions. - Throws:
-
NullPointerException
- if cursorLocn isnull
-
IllegalArgumentException
- 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 aDropTargetEvent
given theDropTargetContext
for 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 aboolean
indicating if the source is in the same JVM as the target.- Parameters:
-
dtc
- The DropTargetContext for this operation -
cursorLocn
- The location of the "Drag" Cursor's hotspot in Component's coordinates -
dropAction
- 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 isnull
-
IllegalArgumentException
- if dropAction is not one ofDnDConstants
. -
IllegalArgumentException
- if srcActions is not a bitwise mask ofDnDConstants
. -
IllegalArgumentException
- if dtc isnull
.
-
Method Detail
getLocation
public Point getLocation()
This method returns aPoint
indicating theCursor
's current location in theComponent
's coordinates.- Returns:
-
the current
Cursor
location in Component's coords.
getCurrentDataFlavors
public DataFlavor[] getCurrentDataFlavors()
This method returns the current DataFlavors.- Returns:
- current DataFlavors
getCurrentDataFlavorsAsList
public List<DataFlavor> getCurrentDataFlavorsAsList()
This method returns the currently availableDataFlavor
s as ajava.util.List
.- Returns:
- the currently available DataFlavors as a java.util.List
isDataFlavorSupported
public boolean isDataFlavorSupported(DataFlavor df)
This method returns aboolean
indicating if the specifiedDataFlavor
is available from the source.- Parameters:
-
df
- theDataFlavor
to test - Returns:
- if the DataFlavor specified is available from the source
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
public Transferable getTransferable()
This method returns theTransferable
object associated with the drop.- Returns:
-
the
Transferable
associated 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 theDragSource
that the drop transfer(s) are completed.- Parameters:
-
success
- aboolean
indicating that the drop transfer(s) are completed.
isLocalTransfer
public boolean isLocalTransfer()
This method returns anint
indicating if the source is in the same JVM as the target.- Returns:
- if the Source is in the same JVM
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.