Class DragSourceDragEvent
- All Implemented Interfaces:
Serializable
DragSourceDragEvent
is
delivered from the DragSourceContextPeer
,
via the DragSourceContext
, to the DragSourceListener
registered with that DragSourceContext
and with its associated
DragSource
.
The DragSourceDragEvent
reports the target drop action
and the user drop action that reflect the current state of
the drag operation.
Target drop action is one of DnDConstants
that represents
the drop action selected by the current drop target 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.
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_MOVEIf 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
.
- Since:
- 1.2
- See Also:
-
Field Summary
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorDescriptionDragSourceDragEvent
(DragSourceContext dsc, int dropAction, int action, int modifiers) Constructs aDragSourceDragEvent
.DragSourceDragEvent
(DragSourceContext dsc, int dropAction, int action, int modifiers, int x, int y) Constructs aDragSourceDragEvent
given the specifiedDragSourceContext
, user drop action, target drop action, modifiers and coordinates. -
Method Summary
Modifier and TypeMethodDescriptionint
This method returns the logical intersection of the target drop action and the set of drop actions supported by the drag source.int
This method returns anint
representing the current state of the input device modifiers associated with the user's gesture.int
This method returns anint
representing the current state of the input device extended modifiers associated with the user's gesture.int
This method returns the target drop action.int
This method returns the user drop action.Methods inherited from class java.awt.dnd.DragSourceEvent
getDragSourceContext, getLocation, getX, getY
Methods inherited from class java.util.EventObject
getSource, toString
-
Constructor Details
-
DragSourceDragEvent
Constructs aDragSourceDragEvent
. This class is typically instantiated by theDragSourceContextPeer
rather than directly by client code. The coordinates for thisDragSourceDragEvent
are not specified, sogetLocation
will returnnull
for this event.The arguments
dropAction
andaction
should be one ofDnDConstants
that represents a single action. The argumentmodifiers
should be either a bitwise mask of oldjava.awt.event.InputEvent.*_MASK
constants or a bitwise mask of extendedjava.awt.event.InputEvent.*_DOWN_MASK
constants. This constructor does not throw any exception for invaliddropAction
,action
andmodifiers
.- Parameters:
dsc
- theDragSourceContext
that is to manage notifications for this event.dropAction
- the user drop action.action
- the target drop action.modifiers
- the modifier keys down during event (shift, ctrl, alt, meta) Either extended _DOWN_MASK or old _MASK modifiers should be used, but both models should not be mixed in one event. Use of the extended modifiers is preferred.- Throws:
IllegalArgumentException
- ifdsc
isnull
.- See Also:
-
DragSourceDragEvent
public DragSourceDragEvent(DragSourceContext dsc, int dropAction, int action, int modifiers, int x, int y) Constructs aDragSourceDragEvent
given the specifiedDragSourceContext
, user drop action, target drop action, modifiers and coordinates.The arguments
dropAction
andaction
should be one ofDnDConstants
that represents a single action. The argumentmodifiers
should be either a bitwise mask of oldjava.awt.event.InputEvent.*_MASK
constants or a bitwise mask of extendedjava.awt.event.InputEvent.*_DOWN_MASK
constants. This constructor does not throw any exception for invaliddropAction
,action
andmodifiers
.- Parameters:
dsc
- theDragSourceContext
associated with this event.dropAction
- the user drop action.action
- the target drop action.modifiers
- the modifier keys down during event (shift, ctrl, alt, meta) Either extended _DOWN_MASK or old _MASK modifiers should be used, but both models should not be mixed in one event. Use of the extended modifiers is preferred.x
- the horizontal coordinate for the cursor locationy
- the vertical coordinate for the cursor location- Throws:
IllegalArgumentException
- ifdsc
isnull
.- Since:
- 1.4
- See Also:
-
-
Method Details
-
getTargetActions
public int getTargetActions()This method returns the target drop action.- Returns:
- the target drop action.
-
getGestureModifiers
public int getGestureModifiers()This method returns anint
representing the current state of the input device modifiers associated with the user's gesture. Typically these would be mouse buttons or keyboard modifiers.If the
modifiers
passed to the constructor are invalid, this method returns them unchanged.- Returns:
- the current state of the input device modifiers
-
getGestureModifiersEx
public int getGestureModifiersEx()This method returns anint
representing the current state of the input device extended modifiers associated with the user's gesture. SeeInputEvent.getModifiersEx()
If the
modifiers
passed to the constructor are invalid, this method returns them unchanged.- Returns:
- the current state of the input device extended modifiers
- Since:
- 1.4
-
getUserAction
public int getUserAction()This method returns the user drop action.- Returns:
- the user drop action.
-
getDropAction
public int getDropAction()This method returns the logical intersection of the target drop action and the set of drop actions supported by the drag source.- Returns:
- the logical intersection of the target drop action and the set of drop actions supported by the drag source.
-