- java.lang.Object
-
- java.util.EventObject
-
- java.awt.dnd.DragSourceEvent
-
- java.awt.dnd.DragSourceDropEvent
-
- All Implemented Interfaces:
- Serializable
public class DragSourceDropEvent extends DragSourceEvent
TheDragSourceDropEvent
is delivered from theDragSourceContextPeer
, via theDragSourceContext
, to thedragDropEnd
method ofDragSourceListener
s registered with thatDragSourceContext
and with its associatedDragSource
. 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
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor and Description DragSourceDropEvent(DragSourceContext dsc)
Construct aDragSourceDropEvent
for a drag that does not result in a drop.DragSourceDropEvent(DragSourceContext dsc, int action, boolean success)
Construct aDragSourceDropEvent
for a drop, given theDragSourceContext
, the drop action, and aboolean
indicating if the drop was successful.DragSourceDropEvent(DragSourceContext dsc, int action, boolean success, int x, int y)
Construct aDragSourceDropEvent
for a drop, given theDragSourceContext
, the drop action, aboolean
indicating if the drop was successful, and coordinates.
-
Method Summary
Methods Modifier and Type Method and Description int
getDropAction()
This method returns anint
representing the action performed by the target on the subject of the drop.boolean
getDropSuccess()
This method returns aboolean
indicating if the drop was successful.-
Methods inherited from class java.awt.dnd.DragSourceEvent
getDragSourceContext, getLocation, getX, getY
-
-
-
-
Constructor Detail
-
DragSourceDropEvent
public DragSourceDropEvent(DragSourceContext dsc, int action, boolean success)
Construct aDragSourceDropEvent
for a drop, given theDragSourceContext
, the drop action, and aboolean
indicating if the drop was successful. The coordinates for thisDragSourceDropEvent
are not specified, sogetLocation
will returnnull
for this event.The argument
action
should be one ofDnDConstants
that represents a single action. This constructor does not throw any exception for invalidaction
.- Parameters:
dsc
- theDragSourceContext
associated with thisDragSourceDropEvent
action
- the drop actionsuccess
- a boolean indicating if the drop was successful- Throws:
- ifIllegalArgumentException
dsc
isnull
.- See Also:
DragSourceEvent.getLocation()
-
DragSourceDropEvent
public DragSourceDropEvent(DragSourceContext dsc, int action, boolean success, int x, int y)
Construct aDragSourceDropEvent
for a drop, given theDragSourceContext
, the drop action, aboolean
indicating if the drop was successful, and coordinates.The argument
action
should be one ofDnDConstants
that represents a single action. This constructor does not throw any exception for invalidaction
.- Parameters:
dsc
- theDragSourceContext
associated with thisDragSourceDropEvent
action
- the drop actionsuccess
- a boolean indicating if the drop was successfulx
- the horizontal coordinate for the cursor locationy
- the vertical coordinate for the cursor location- Throws:
- ifIllegalArgumentException
dsc
isnull
.- Since:
- 1.4
-
DragSourceDropEvent
public DragSourceDropEvent(DragSourceContext dsc)
Construct aDragSourceDropEvent
for a drag that does not result in a drop. The coordinates for thisDragSourceDropEvent
are not specified, sogetLocation
will returnnull
for this event.- Parameters:
dsc
- theDragSourceContext
- Throws:
- ifIllegalArgumentException
dsc
isnull
.- See Also:
DragSourceEvent.getLocation()
-
-
Method Detail
-
getDropSuccess
public boolean getDropSuccess()
This method returns aboolean
indicating if the drop was successful.- 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.
-
getDropAction
public int getDropAction()
This method returns anint
representing the action performed by the target on the subject of the drop.- 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
.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/awt/dnd/dragsourcedropevent.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.