java.awt.dnd
public class: DropTargetDropEvent [javadoc |
source]
java.lang.Object
java.util.EventObject
java.awt.dnd.DropTargetEvent
java.awt.dnd.DropTargetDropEvent
All Implemented Interfaces:
Serializable
The
DropTargetDropEvent is delivered
via the
DropTargetListener drop() method.
The DropTargetDropEvent reports the source drop actions
and the user drop action that reflect the current state of the
drag-and-drop operation.
Source drop actions is a bitwise mask of DnDConstants
that represents the set of drop actions supported by the drag source for
this drag-and-drop operation.
User drop action depends on the drop actions supported by the drag
source and the drop action selected by the user. The user can select a drop
action by pressing modifier keys during the drag operation:
Ctrl + Shift -> ACTION_LINK
Ctrl -> ACTION_COPY
Shift -> ACTION_MOVE
If the user selects a drop action, the
user drop action is one of
DnDConstants that represents the selected drop action if this
drop action is supported by the drag source or
DnDConstants.ACTION_NONE if this drop action is not supported
by the drag source.
If the user doesn't select a drop action, the set of
DnDConstants that represents the set of drop actions supported
by the drag source is searched for DnDConstants.ACTION_MOVE,
then for DnDConstants.ACTION_COPY, then for
DnDConstants.ACTION_LINK and the user drop action is the
first constant found. If no constant is found the user drop action
is DnDConstants.ACTION_NONE.
| Constructor: |
public DropTargetDropEvent(DropTargetContext dtc,
Point cursorLocn,
int dropAction,
int srcActions) {
super(dtc);
if (cursorLocn == null) throw new NullPointerException("cursorLocn");
if (dropAction != DnDConstants.ACTION_NONE &&
dropAction != DnDConstants.ACTION_COPY &&
dropAction != DnDConstants.ACTION_MOVE &&
dropAction != DnDConstants.ACTION_LINK
) throw new IllegalArgumentException("dropAction = " + dropAction);
if ((srcActions & ~(DnDConstants.ACTION_COPY_OR_MOVE | DnDConstants.ACTION_LINK)) != 0) throw new IllegalArgumentException("srcActions");
location = cursorLocn;
actions = srcActions;
this.dropAction = dropAction;
}
Construct a DropTargetDropEvent 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 the current set of
actions supported by the source.
By default, this constructor
assumes that the target is not in the same virtual machine as
the source; that is, #isLocalTransfer() will
return false.
Parameters:
dtc - The DropTargetContext for this operation
cursorLocn - The location of the "Drag" Cursor's
hotspot in Component coordinates
dropAction - the user drop action.
srcActions - the source drop actions.
Throws:
< - code>NullPointerException
if cursorLocn is null
< - code>IllegalArgumentException if dropAction is not one of
DnDConstants.
< - code>IllegalArgumentException if srcActions is not
a bitwise mask of DnDConstants.
< - code>IllegalArgumentException if dtc is null.
|
public DropTargetDropEvent(DropTargetContext dtc,
Point cursorLocn,
int dropAction,
int srcActions,
boolean isLocal) {
this(dtc, cursorLocn, dropAction, srcActions);
isLocalTx = isLocal;
}
Construct a DropTargetEvent 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,
the current set of actions supported by the source,
and a boolean indicating if the source is in the same JVM
as the target.
Parameters:
dtc - The DropTargetContext for this operation
cursorLocn - The location of the "Drag" Cursor's
hotspot in Component's coordinates
dropAction - the user drop action.
srcActions - the source drop actions.
isLocal - True if the source is in the same JVM as the target
Throws:
< - code>NullPointerException if cursorLocn is
null
< - code>IllegalArgumentException if dropAction is not one of
DnDConstants.
< - code>IllegalArgumentException if srcActions is not
a bitwise mask of DnDConstants.
< - code>IllegalArgumentException if dtc is null.
|
| Method from java.awt.dnd.DropTargetDropEvent Summary: |
|---|
|
acceptDrop, dropComplete, getCurrentDataFlavors, getCurrentDataFlavorsAsList, getDropAction, getLocation, getSourceActions, getTransferable, isDataFlavorSupported, isLocalTransfer, rejectDrop |
| Methods from java.lang.Object: |
|---|
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method from java.awt.dnd.DropTargetDropEvent Detail: |
public void acceptDrop(int dropAction) {
getDropTargetContext().acceptDrop(dropAction);
}
accept the drop, using the specified action.
|
public void dropComplete(boolean success) {
getDropTargetContext().dropComplete(success);
}
This method notifies the DragSource
that the drop transfer(s) are completed.
|
public DataFlavor[] getCurrentDataFlavors() {
return getDropTargetContext().getCurrentDataFlavors();
}
This method returns the current DataFlavors.
|
public List getCurrentDataFlavorsAsList() {
return getDropTargetContext().getCurrentDataFlavorsAsList();
}
This method returns the currently available
DataFlavors as a java.util.List.
|
public int getDropAction() {
return dropAction;
}
This method returns the user drop action. |
public Point getLocation() {
return location;
}
This method returns a Point
indicating the Cursor's current
location in the Component's coordinates.
|
public int getSourceActions() {
return actions;
}
This method returns the source drop actions. |
public Transferable getTransferable() {
return getDropTargetContext().getTransferable();
}
This method returns the Transferable object
associated with the drop.
|
public boolean isDataFlavorSupported(DataFlavor df) {
return getDropTargetContext().isDataFlavorSupported(df);
}
This method returns a boolean indicating if the
specified DataFlavor is available
from the source.
|
public boolean isLocalTransfer() {
return isLocalTx;
}
This method returns an int indicating if
the source is in the same JVM as the target.
|
public void rejectDrop() {
getDropTargetContext().rejectDrop();
}
|