APIdia Launch Partner
Top Description Fields Constructors Methods
java.awt.dnd

public Class DragSourceDropEvent

extends DragSourceEvent
Class Inheritance
Imports
java.io.Serial
The DragSourceDropEvent is delivered from the DragSourceContextPeer, via the DragSourceContext, to the dragDropEnd method of DragSourceListeners registered with that DragSourceContext and with its associated DragSource. It contains sufficient information for the originator of the operation to provide appropriate feedback to the end user when the operation completes.
Since
1.2

Field Summary

Modifier and TypeField and Description
private int
dropAction

The drop action.

private boolean
dropSuccess

true if the drop was successful.

private static final long
serialVersionUID

Hides java.awt.dnd.DragSourceEvent.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

AccessConstructor and Description
public
DragSourceDropEvent(DragSourceContext
the DragSourceContext associated with this DragSourceDropEvent
dsc, int
the drop action
action, boolean
a boolean indicating if the drop was successful
success)

Construct a DragSourceDropEvent for a drop, given the DragSourceContext, the drop action, and a boolean indicating if the drop was successful.

public
DragSourceDropEvent(DragSourceContext
the DragSourceContext associated with this DragSourceDropEvent
dsc, int
the drop action
action, boolean
a boolean indicating if the drop was successful
success, int
the horizontal coordinate for the cursor location
x, int
the vertical coordinate for the cursor location
y)

Construct a DragSourceDropEvent for a drop, given the DragSourceContext, the drop action, a boolean indicating if the drop was successful, and coordinates.

public
DragSourceDropEvent(DragSourceContext
the DragSourceContext
dsc)

Construct a DragSourceDropEvent for a drag that does not result in a drop.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the action performed by the target on the subject of the drop if the drop target accepted the drop and the target drop action is supported by the drag source; otherwise, DnDConstants.ACTION_NONE.
getDropAction()

This method returns an int representing the action performed by the target on the subject of the drop.

public boolean

Returns:

true if the drop target accepted the drop and successfully performed a drop action; false if the drop target rejected the drop or if the drop target accepted the drop, but failed to perform a drop action.
getDropSuccess()

This method returns a boolean indicating if the drop was successful.

Inherited from java.awt.dnd.DragSourceEvent:
getDragSourceContextgetLocationgetXgetY

Field Detail

dropActionback to summary
private int dropAction

The drop action.

dropSuccessback to summary
private boolean dropSuccess

true if the drop was successful.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.awt.dnd.DragSourceEvent.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial

Constructor Detail

DragSourceDropEventback to summary
public DragSourceDropEvent(DragSourceContext dsc, int action, boolean success)

Construct a DragSourceDropEvent for a drop, given the DragSourceContext, the drop action, and a boolean indicating if the drop was successful. The coordinates for this DragSourceDropEvent are not specified, so getLocation will return null for this event.

The argument action should be one of DnDConstants that represents a single action. This constructor does not throw any exception for invalid action.

Parameters
dsc:DragSourceContext

the DragSourceContext associated with this DragSourceDropEvent

action:int

the drop action

success:boolean

a boolean indicating if the drop was successful

Exceptions
IllegalArgumentException:
if dsc is null.
See Also
DragSourceEvent#getLocation
DragSourceDropEventback to summary
public DragSourceDropEvent(DragSourceContext dsc, int action, boolean success, int x, int y)

Construct a DragSourceDropEvent for a drop, given the DragSourceContext, the drop action, a boolean indicating if the drop was successful, and coordinates.

The argument action should be one of DnDConstants that represents a single action. This constructor does not throw any exception for invalid action.

Parameters
dsc:DragSourceContext

the DragSourceContext associated with this DragSourceDropEvent

action:int

the drop action

success:boolean

a boolean indicating if the drop was successful

x:int

the horizontal coordinate for the cursor location

y:int

the vertical coordinate for the cursor location

Exceptions
IllegalArgumentException:
if dsc is null.
Since
1.4
DragSourceDropEventback to summary
public DragSourceDropEvent(DragSourceContext dsc)

Construct a DragSourceDropEvent for a drag that does not result in a drop. The coordinates for this DragSourceDropEvent are not specified, so getLocation will return null for this event.

Parameters
dsc:DragSourceContext

the DragSourceContext

Exceptions
IllegalArgumentException:
if dsc is null.
See Also
DragSourceEvent#getLocation

Method Detail

getDropActionback to summary
public int getDropAction()

This method returns an int representing the action performed by the target on the subject of the drop.

Returns:int

the action performed by the target on the subject of the drop if the drop target accepted the drop and the target drop action is supported by the drag source; otherwise, DnDConstants.ACTION_NONE.

getDropSuccessback to summary
public boolean getDropSuccess()

This method returns a boolean indicating if the drop was successful.

Returns:boolean

true if the drop target accepted the drop and successfully performed a drop action; false if the drop target rejected the drop or if the drop target accepted the drop, but failed to perform a drop action.