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
The DragSourceDropEvent
is delivered from the DragSourceContextPeer
, via the DragSourceContext
, to the dragDropEnd
method of DragSourceListener
s 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
- See Also:
- Serialized Form
Field Summary
Fields declared in class java.util.EventObject
source
Constructor Summary
Constructor | Description |
---|---|
DragSourceDropEvent(DragSourceContext dsc) | Construct a |
DragSourceDropEvent(DragSourceContext dsc,
int action,
boolean success) | Construct a |
DragSourceDropEvent(DragSourceContext dsc,
int action,
boolean success,
int x,
int y) | Construct a |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
int | getDropAction() | This method returns an |
boolean | getDropSuccess() | This method returns a |
Methods declared in class java.awt.dnd.DragSourceEvent
getDragSourceContext, getLocation, getX, getY
Methods declared in class java.util.EventObject
getSource, toString
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Constructor Detail
DragSourceDropEvent
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
- 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 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
- 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 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
- theDragSourceContext
- Throws:
-
IllegalArgumentException
- ifdsc
isnull
. - See Also:
DragSourceEvent.getLocation()
Method Detail
getDropSuccess
public boolean getDropSuccess()
This method returns a boolean
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 an int
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
.