DragSourceDropEvent JDK 1.6)

Description

public class DragSourceDropEvent

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.

See also:

Constructors

public DragSourceDropEvent (DragSourceContext dsc)

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

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 - the DragSourceContext
Throws:
- IllegalArgumentException - if dsc is null.
See Also: DragSourceEvent.getLocation(),

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.

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 - the DragSourceContext associated with this DragSourceDropEvent
- action - the drop action
- success - a boolean indicating if the drop was successful
Throws:
- IllegalArgumentException - if dsc is null.
See Also: DragSourceEvent.getLocation(),

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 - the DragSourceContext associated with this DragSourceDropEvent
- 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 - if dsc is null.
Since: 1.4

Methods

Hide/Show inherited methods

public DragSourceContext getDragSourceContext () [Inherited From DragSourceEvent]

This method returns the DragSourceContext that originated the event.

Returns: the DragSourceContext that originated the event

public int getDropAction ()

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

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.

public boolean getDropSuccess ()

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

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.

public Point getLocation () [Inherited From DragSourceEvent]

This method returns a Point indicating the cursor location in screen coordinates at the moment this event occured, or null if the cursor location is not specified for this event.

This method returns a Point indicating the cursor
location in screen coordinates at the moment this event occured, or
null if the cursor location is not specified for this
event.
Returns: the Point indicating the cursor location or null if the cursor location is not specified
Since: 1.4

public Object getSource () [Inherited From EventObject]

The object on which the Event initially occurred.

public int getX () [Inherited From DragSourceEvent]

This method returns the horizontal coordinate of the cursor location in screen coordinates at the moment this event occured, or zero if the cursor location is not specified for this event.

public int getY () [Inherited From DragSourceEvent]

This method returns the vertical coordinate of the cursor location in screen coordinates at the moment this event occured, or zero if the cursor location is not specified for this event.

public String toString () [Inherited From EventObject]

Returns a String representation of this EventObject.