Java™ Platform
Standard Ed. 6

java.awt.dnd
Class DragSourceAdapter

java.lang.Object
  extended by java.awt.dnd.DragSourceAdapter
All Implemented Interfaces:
DragSourceListener, DragSourceMotionListener, EventListener

public abstract class DragSourceAdapter
extends Object
implements DragSourceListener, DragSourceMotionListener

An abstract adapter class for receiving drag source events. The methods in this class are empty. This class exists only as a convenience for creating listener objects.

Extend this class to create a DragSourceEvent listener and override the methods for the events of interest. (If you implement the DragSourceListener interface, you have to define all of the methods in it. This abstract class defines null methods for them all, so you only have to define methods for events you care about.)

Create a listener object using the extended class and then register it with a DragSource. When the drag enters, moves over, or exits a drop site, when the drop action changes, and when the drag ends, the relevant method in the listener object is invoked, and the DragSourceEvent is passed to it.

The drop site is associated with the previous dragEnter() invocation if the latest invocation of dragEnter() on this adapter corresponds to that drop site and is not followed by a dragExit() invocation on this adapter.

Since:
1.4
See Also:
DragSourceEvent, DragSourceListener, DragSourceMotionListener

Constructor Summary
DragSourceAdapter()
           
 
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 dragMouseMoved(DragSourceDragEvent dsde)
          Called whenever the mouse is moved during a drag operation.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DragSourceAdapter

public DragSourceAdapter()
Method Detail

dragEnter

public 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:

Specified by:
dragEnter in interface DragSourceListener
Parameters:
dsde - the DragSourceDragEvent

dragOver

public 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:

Specified by:
dragOver in interface DragSourceListener
Parameters:
dsde - the DragSourceDragEvent

dragMouseMoved

public void dragMouseMoved(DragSourceDragEvent dsde)
Called whenever the mouse is moved during a drag operation.

Specified by:
dragMouseMoved in interface DragSourceMotionListener
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.

Specified by:
dropActionChanged in interface DragSourceListener
Parameters:
dsde - the DragSourceDragEvent

dragExit

public 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

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

Specified by:
dragDropEnd in interface DragSourceListener
Parameters:
dsde - the DragSourceDropEvent

Java™ Platform
Standard Ed. 6

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

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