Class DragSourceDropEvent
- 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
All Methods Instance Methods Concrete 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
-
Methods inherited from class java.util.EventObject
getSource, toString
-
-
-
-
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 action -
success
- a boolean indicating if the drop was successful - Throws:
-
IllegalArgumentException
- ifdsc
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 action -
success
- a boolean indicating if the drop was successful -
x
- the horizontal coordinate for the cursor location -
y
- the vertical coordinate for the cursor location - Throws:
-
IllegalArgumentException
- ifdsc
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:
-
IllegalArgumentException
- ifdsc
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
.
-
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.