JavaTM 2 Platform
Standard Ed. 5.0

java.awt.dnd
Interface DragSourceListener

All Superinterfaces:
EventListener
All Known Implementing Classes:
DragSourceAdapter, 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.

The drop site is associated with the previous dragEnter() invocation if the latest invocation of dragEnter() on this listener:

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 cursor's hotspot enters a platform-dependent drop site.
 void dragExit(DragSourceEvent dse)
          Called as the cursor's hotspot exits a platform-dependent drop site.
 void dragOver(DragSourceDragEvent dsde)
          Called as the cursor's hotspot moves over a platform-dependent drop site.
 void dropActionChanged(DragSourceDragEvent dsde)
          Called when the user has modified the drop gesture.
 

Method Detail

dragEnter

void dragEnter(DragSourceDragEvent dsde)
Called as the cursor's hotspot enters a platform-dependent drop site. This method is invoked when all the following conditions are true:

Parameters:
dsde - the DragSourceDragEvent

dragOver

void dragOver(DragSourceDragEvent dsde)
Called as the cursor's hotspot moves over a platform-dependent drop site. This method is invoked when all the following conditions are true:

Parameters:
dsde - the DragSourceDragEvent

dropActionChanged

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

void dragExit(DragSourceEvent dse)
Called as the cursor's hotspot exits a platform-dependent drop site. This method is invoked when any of the following conditions are true: OR OR

Parameters:
dse - the DragSourceEvent

dragDropEnd

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 drop site selected to apply to the Drop operation. Once this method is complete, the current DragSourceContext and associated resources become invalid.

Parameters:
dsde - the DragSourceDropEvent

JavaTM 2 Platform
Standard Ed. 5.0

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.