java.awt.dnd
Interface DragSourceListener

All Superinterfaces:

EventListener

All Known Implementing Classes:

DragSourceContext

public interface DragSourceListener

extends EventListener

The DragSourceListener defines the event interface for originators of Drag and Drop operations to track the state of the user's gesture, and to provide appropriate "drag over" feedback to the user throughout the Drag and Drop operation.

Since:

1.2

Method Summary

void	dragDropEnd(DragSourceDropEvent dsde) This method is invoked to signify that the Drag and Drop operation is complete.
void	dragEnter(DragSourceDragEvent dsde) Called as the hotspot enters a platform dependent drop site.
void	dragExit(DragSourceEvent dse) Called as the hotspot exits a platform dependent drop site.
void	dragOver(DragSourceDragEvent dsde) Called as the hotspot moves over a platform dependent drop site.
void	dropActionChanged(DragSourceDragEvent dsde) Called when the user has modified the drop gesture.

Method Detail

dragEnter

public void dragEnter(DragSourceDragEvent dsde)

Called as the hotspot enters a platform dependent drop site. This method is invoked when the following conditions are true:

• The logical cursor's hotspot initially intersects a GUI Component's visible geometry.
• That Component has an active DropTarget associated with it.
• The DropTarget's registered DropTargetListener dragEnter() method is invoked and returns successfully.
• The registered DropTargetListener invokes the DropTargetDragEvent's acceptDrag() method to accept the drag based upon interrogation of the source's potential drop action(s) and available data types (DataFlavors).

Parameters:

dsde - the DragSourceDragEvent

dragOver

public void dragOver(DragSourceDragEvent dsde)

Called as the hotspot moves over a platform dependent drop site. This method is invoked when the following conditions are true:

• The cursor's logical hotspot has moved but still intersects the visible geometry of the Component associated with the previous dragEnter() invocation.
• That Component still has a DropTarget associated with it.
• That DropTarget is still active.
• The DropTarget's registered DropTargetListener dragOver() method is invoked and returns successfully.
• The DropTarget does not reject the drag via rejectDrag()

Parameters:

dsde - the DragSourceDragEvent

dropActionChanged

public void dropActionChanged(DragSourceDragEvent dsde)

Called when the user has modified the drop gesture. This method is invoked when the state of the input device(s) that the user is interacting with changes. Such devices are typically the mouse buttons or keyboard modifiers that the user is interacting with.

Parameters:

dsde - the DragSourceDragEvent

dragExit

public void dragExit(DragSourceEvent dse)

Called as the hotspot exits a platform dependent drop site. This method is invoked when the following conditions are true:

• The cursor's logical hotspot no longer intersects the visible geometry of the Component associated with the previous dragEnter() invocation.

OR

• The Component that the logical cursor's hotspot intersected that resulted in the previous dragEnter() invocation no longer has an active DropTarget or DropTargetListener associated with it.

OR

• The current DropTarget's DropTargetListener has invoked rejectDrag() since the last dragEnter() or dragOver() invocation.

Parameters:

dse - the DragSourceEvent

dragDropEnd

public void dragDropEnd(DragSourceDropEvent dsde)

This method is invoked to signify that the Drag and Drop operation is complete. The getDropSuccess() method of the DragSourceDropEvent can be used to determine the termination state. The getDropAction() method returns the operation that the DropTarget selected (via the DropTargetDropEvent acceptDrop() parameter) to apply to the Drop operation. Once this method is complete, the current DragSourceContext and associated resources become invalid.

Parameters:

dsde - the DragSourceDropEvent