OpenJDK 27 · java.awt.dnd.DropTargetDragEvent · APIdia, the JavaDoc alternative

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.

Modifier and Type	Field and Description
private int	actions The source drop actions.
private int	dropAction The user drop action.
private Point	location The location of the drag cursor's hotspot in Component coordinates.
private static final long	serialVersionUID Hides java.awt.dnd.DropTargetEvent.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	DropTargetDragEvent(DropTargetContext The DropTargetContext for this operation dtc, Point The location of the "Drag" Cursor's hotspot in Component coordinates cursorLocn, int The user drop action dropAction, int The source drop actions 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.

public

DropTargetDragEvent(DropTargetContext

The DropTargetContext for this operation

dtc, Point

The location of the "Drag" Cursor's hotspot in Component coordinates

cursorLocn, int

The user drop action

dropAction, int

The source drop actions

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.

Method Summary

Modifier and Type	Method and Description
public void	acceptDrag(int the operation accepted by the target dragOperation) Accepts the drag.
public DataFlavor[]	Returns: current DataFlavors from the DropTargetContext getCurrentDataFlavors() This method returns the current `DataFlavor`s from the `DropTargetContext`.
public List<DataFlavor>	Returns: a `java.util.List` of the Current `DataFlavor`s getCurrentDataFlavorsAsList() This method returns the current `DataFlavor`s as a `java.util.List`
public int	Returns: the user drop action getDropAction() This method returns the user drop action.
public Point	Returns: the current cursor location in `Component`'s coords. getLocation() This method returns a `Point` indicating the `Cursor`'s current location within the `Component'`s coordinates.
public int	Returns: the source drop actions getSourceActions() This method returns the source drop actions.
public Transferable	Returns: the Transferable associated with the drag operation getTransferable() This method returns the Transferable object that represents the data associated with the current drag operation.
public boolean	Returns: `true` if a particular `DataFlavor` is supported, otherwise `false` isDataFlavorSupported(DataFlavor the `DataFlavor` to test df) This method returns a `boolean` indicating if the specified `DataFlavor` is supported.
public void	rejectDrag() Rejects the drag as a result of examining either the `dropAction` or the available `DataFlavor` types.

Inherited from java.awt.dnd.DropTargetEvent:: getDropTargetContext

Field Detail

actions	back to summary
private int actions The source drop actions.

dropAction	back to summary
private int dropAction The user drop action.

location	back to summary
private Point location The location of the drag cursor's hotspot in Component coordinates.

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.awt.dnd.DropTargetEvent.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability. Annotations @Serial

serialVersionUID

back to summary

private static final long serialVersionUID

Hides java.awt.dnd.DropTargetEvent.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations

@Serial

Constructor Detail

DropTargetDragEvent back to summary

DropTargetDragEvent	back to 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. Parameters dtc:DropTargetContext The DropTargetContext for this operation cursorLocn:Point The location of the "Drag" Cursor's hotspot in Component coordinates dropAction:int The user drop action srcActions:int The source drop actions Exceptions NullPointerException: if cursorLocn is null IllegalArgumentException: if dropAction is not one of `DnDConstants`. if srcActions is not a bitwise mask of `DnDConstants`. if dtc is `null`.

public DropTargetDragEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions)

Parameters

dtc:DropTargetContext: The DropTargetContext for this operation
cursorLocn:Point: The location of the "Drag" Cursor's hotspot in Component coordinates
dropAction:int: The user drop action
srcActions:int: The source drop actions

Exceptions

NullPointerException:

if cursorLocn is null

IllegalArgumentException:

if dropAction is not one of DnDConstants.
if srcActions is not a bitwise mask of DnDConstants.
if dtc is null.

Method Detail

acceptDrag back to summary

acceptDrag	back to summary
public void acceptDrag(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`. Parameters dragOperation:int the operation accepted by the target

public void acceptDrag(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.

Parameters

dragOperation:int: the operation accepted by the target

getCurrentDataFlavors back to summary

getCurrentDataFlavors	back to summary
public DataFlavor[] getCurrentDataFlavors() This method returns the current `DataFlavor`s from the `DropTargetContext`. Returns:DataFlavor[] current DataFlavors from the DropTargetContext

public DataFlavor[] getCurrentDataFlavors()

This method returns the current DataFlavors from the DropTargetContext.

Returns:DataFlavor[]: current DataFlavors from the DropTargetContext

getCurrentDataFlavorsAsList back to summary

getCurrentDataFlavorsAsList	back to summary
public List<DataFlavor> getCurrentDataFlavorsAsList() This method returns the current `DataFlavor`s as a `java.util.List` Returns:List<DataFlavor> a `java.util.List` of the Current `DataFlavor`s

public List<DataFlavor> getCurrentDataFlavorsAsList()

This method returns the current DataFlavors as a java.util.List

Returns:List<DataFlavor>: a java.util.List of the Current DataFlavors

getDropAction	back to summary
public int getDropAction() This method returns the user drop action. Returns:int the user drop action

getDropAction

back to summary

public int getDropAction()

This method returns the user drop action.

Returns:int: the user drop action

getLocation back to summary

getLocation	back to summary
public Point getLocation() This method returns a `Point` indicating the `Cursor`'s current location within the `Component'`s coordinates. Returns:Point the current cursor location in `Component`'s coords.

public Point getLocation()

This method returns a Point indicating the Cursor's current location within the Component's coordinates.

Returns:Point: the current cursor location in Component's coords.

getSourceActions	back to summary
public int getSourceActions() This method returns the source drop actions. Returns:int the source drop actions

getSourceActions

back to summary

public int getSourceActions()

This method returns the source drop actions.

Returns:int: the source drop actions

getTransferable	back to summary
public Transferable getTransferable() This method returns the Transferable object that represents the data associated with the current drag operation. Returns:Transferable the Transferable associated with the drag operation Exceptions InvalidDnDOperationException: if the data associated with the drag operation is not available Since 1.5

getTransferable

back to summary

public Transferable getTransferable()

This method returns the Transferable object that represents the data associated with the current drag operation.

Returns:Transferable

the Transferable associated with the drag operation

Exceptions

InvalidDnDOperationException:: if the data associated with the drag operation is not available

Since

1.5

isDataFlavorSupported back to summary

isDataFlavorSupported	back to summary
public boolean isDataFlavorSupported(DataFlavor df) This method returns a `boolean` indicating if the specified `DataFlavor` is supported. Parameters df:DataFlavor the `DataFlavor` to test Returns:boolean `true` if a particular `DataFlavor` is supported, otherwise `false`

public boolean isDataFlavorSupported(DataFlavor df)

This method returns a boolean indicating if the specified DataFlavor is supported.

Parameters

df:DataFlavor: the DataFlavor to test

Returns:boolean

true if a particular DataFlavor is supported, otherwise false

rejectDrag	back to summary
public void rejectDrag() Rejects the drag as a result of examining either the `dropAction` or the available `DataFlavor` types.

public Class DropTargetDragEvent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail