JavaTM 2 Platform
Std. Ed. v1.3.1

java.awt.dnd
Class DropTargetDragEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--java.awt.dnd.DropTargetEvent
              |
              +--java.awt.dnd.DropTargetDragEvent
All Implemented Interfaces:
Serializable

public class DropTargetDragEvent
extends DropTargetEvent

The DropTargetDragEvent is delivered to a DropTargetListener via its dragEnter() and dragOver() methods.

Since:
1.2
See Also:
Serialized Form

Fields inherited from class java.awt.dnd.DropTargetEvent
context
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
DropTargetDragEvent(DropTargetContext dtc, Point cursorLocn, int dropAction, int srcActions)
          Construct a DropTargetDragEvent given the DropTargetContext for this operation, the location of the "Drag" Cursor's hotspot in the Component's coordinates, the currently selected user drop action, and current set of actions supported by the source.
 
Method Summary
 void acceptDrag(int dragOperation)
          Accept the drag This method should be called from a DropTargetListeners dragEnter(), dragOver() and dragActionChanged() methods if the implementation wishes to accept an operation from the srcActions other than the one selected by the user as represented by the dropAction.
 DataFlavor[] getCurrentDataFlavors()
          This method returns the current DataFlavors from the DropTargetContext.
 List getCurrentDataFlavorsAsList()
          This method returns the current DataFlavors as a java.util.List
 int getDropAction()
          This method returns an int representing the currently selected drop action.
 Point getLocation()
          This method returns a Point indicating the Cursor's current location within the Component's coordinates.
 int getSourceActions()
          This method returns an int representing set of actions supported by the source.
 boolean isDataFlavorSupported(DataFlavor df)
          This method returns a boolean indicating if the specified DataFlavor is supported.
 void rejectDrag()
          Reject the drag as a result of examining either the dropAction or the available DataFlavor types.
 
Methods inherited from class java.awt.dnd.DropTargetEvent
getDropTargetContext
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DropTargetDragEvent

public DropTargetDragEvent(DropTargetContext dtc,
                           Point cursorLocn,
                           int dropAction,
                           int srcActions)
Construct a DropTargetDragEvent given the DropTargetContext for this operation, the location of the "Drag" Cursor's hotspot in the Component's coordinates, the currently selected user drop action, and current set of actions supported by the source.

Parameters:
dtc - The DropTargetContext for this operation
cursorLocn - The location of the "Drag" Cursor's hotspot in Component coordinates
dropAction - The currently selected user drop action
srcActions - The current set of actions supported by the source

Throws:
NullPointerException - if cursorLocn is null
IllegalArgumentException - if the dropAction or srcActions are illegal values, or if dtc is null
Method Detail

getLocation

public Point getLocation()
This method returns a Point indicating the Cursor's current location within the Component's coordinates.

Returns:
the current cursor location in Component's coords.

getCurrentDataFlavors

public DataFlavor[] getCurrentDataFlavors()
This method returns the current DataFlavors from the DropTargetContext.

Returns:
current DataFlavors from the DropTargetContext

getCurrentDataFlavorsAsList

public List getCurrentDataFlavorsAsList()
This method returns the current DataFlavors as a java.util.List

Returns:
a java.util.List of the Current DataFlavors

isDataFlavorSupported

public boolean isDataFlavorSupported(DataFlavor df)
This method returns a boolean indicating if the specified DataFlavor is supported.

Parameters:
df - the DataFlavor to test

Returns:
if a particular DataFlavor is supported

getSourceActions

public int getSourceActions()
This method returns an int representing set of actions supported by the source.

Returns:
source actions

getDropAction

public int getDropAction()
This method returns an int representing the currently selected drop action.

Returns:
currently selected drop action

acceptDrag

public void acceptDrag(int dragOperation)
Accept the drag This method should be called from a DropTargetListeners dragEnter(), dragOver() and dragActionChanged() methods if the implementation wishes to accept an operation from the srcActions other than the one selected by the user as represented by the dropAction.

Parameters:
dragOperation - the operation accepted by the target

rejectDrag

public void rejectDrag()
Reject the drag as a result of examining either the dropAction or the available DataFlavor types.

JavaTM 2 Platform
Std. Ed. v1.3.1

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.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Oracle and/or its affiliates, in the US and other countries.
Copyright © 1995, 2010 Oracle and/or its affiliates. All rights reserved.