Class DragGestureEvent
java.lang.Object
java.util.EventObject
java.awt.dnd.DragGestureEvent
- All Implemented Interfaces:
Serializable
A
DragGestureEvent is passed
to DragGestureListener's
dragGestureRecognized() method
when a particular DragGestureRecognizer detects that a
platform dependent drag initiating gesture has occurred
on the Component that it is tracking.
The action field of any DragGestureEvent instance should take one of the following
values:
-
DnDConstants.ACTION_COPY -
DnDConstants.ACTION_MOVE -
DnDConstants.ACTION_LINK
- See Also:
-
Field Summary
Fields declared in class java.util.EventObject
source -
Constructor Summary
ConstructorsConstructorDescriptionDragGestureEvent(DragGestureRecognizer dgr, int act, Point ori, List<? extends InputEvent> evs) Constructs aDragGestureEventobject given by theDragGestureRecognizerinstance firing this event, anactparameter representing the user's preferred action, anoriparameter indicating the origin of the drag, and aListof events that comprise the gesture(evsparameter). -
Method Summary
Modifier and TypeMethodDescriptionReturns theComponentassociated with thisDragGestureEvent.intReturns anintrepresenting the action selected by the user.Returns aPointin the coordinates of theComponentover which the drag originated.Returns theDragSource.Returns the source as aDragGestureRecognizer.Returns the initial event that triggered the gesture.iterator()Returns anIteratorfor the events comprising the gesture.voidstartDrag(Cursor dragCursor, Transferable transferable) Starts the drag operation given theCursorfor this drag operation and theTransferablerepresenting the source data for this drag operation.voidstartDrag(Cursor dragCursor, Transferable transferable, DragSourceListener dsl) Starts the drag given the initialCursorto display, theTransferableobject, and theDragSourceListenerto use.voidstartDrag(Cursor dragCursor, Image dragImage, Point imageOffset, Transferable transferable, DragSourceListener dsl) Start the drag given the initialCursorto display, a dragImage, the offset of theImage, theTransferableobject, and theDragSourceListenerto use.Object[]toArray()Returns anObjectarray of the events comprising the drag gesture.Object[]Returns an array of the events comprising the drag gesture.Methods declared in class java.util.EventObject
getSource, toString
-
Constructor Details
-
DragGestureEvent
public DragGestureEvent(DragGestureRecognizer dgr, int act, Point ori, List<? extends InputEvent> evs) Constructs aDragGestureEventobject given by theDragGestureRecognizerinstance firing this event, anactparameter representing the user's preferred action, anoriparameter indicating the origin of the drag, and aListof events that comprise the gesture(evsparameter).- Parameters:
dgr- TheDragGestureRecognizerfiring this eventact- The user's preferred action. For information on allowable values, see the class description forDragGestureEventori- The origin of the dragevs- TheListof events that comprise the gesture- Throws:
IllegalArgumentException- if any parameter equalsnullIllegalArgumentException- if the act parameter does not comply with the values given in the class description forDragGestureEvent- See Also:
-
-
Method Details
-
getSourceAsDragGestureRecognizer
Returns the source as aDragGestureRecognizer.- Returns:
- the source as a
DragGestureRecognizer
-
getComponent
Returns theComponentassociated with thisDragGestureEvent.- Returns:
- the Component
-
getDragSource
-
getDragOrigin
Returns aPointin the coordinates of theComponentover which the drag originated.- Returns:
- the Point where the drag originated in Component coords.
-
iterator
Returns anIteratorfor the events comprising the gesture.- Returns:
- an Iterator for the events comprising the gesture
-
toArray
Returns anObjectarray of the events comprising the drag gesture.- Returns:
- an array of the events comprising the gesture
-
toArray
-
getDragAction
public int getDragAction()Returns anintrepresenting the action selected by the user.- Returns:
- the action selected by the user
-
getTriggerEvent
Returns the initial event that triggered the gesture.- Returns:
- the first "triggering" event in the sequence of the gesture
-
startDrag
public void startDrag(Cursor dragCursor, Transferable transferable) throws InvalidDnDOperationException Starts the drag operation given theCursorfor this drag operation and theTransferablerepresenting the source data for this drag operation.
If anull Cursoris specified no exception will be thrown and default drag cursors will be used instead.
If anull Transferableis specifiedNullPointerExceptionwill be thrown.- Parameters:
dragCursor- The initialCursorfor this drag operation ornullfor the default cursor handling; see DragSourceContext for more details on the cursor handling mechanism during drag and droptransferable- TheTransferablerepresenting the source data for this drag operation.- Throws:
InvalidDnDOperationException- if the Drag and Drop system is unable to initiate a drag operation, or if the user attempts to start a drag while an existing drag operation is still executing.NullPointerException- if theTransferableisnull- Since:
- 1.4
-
startDrag
public void startDrag(Cursor dragCursor, Transferable transferable, DragSourceListener dsl) throws InvalidDnDOperationException Starts the drag given the initialCursorto display, theTransferableobject, and theDragSourceListenerto use.- Parameters:
dragCursor- The initialCursorfor this drag operation ornullfor the default cursor handling; see DragSourceContext for more details on the cursor handling mechanism during drag and droptransferable- The source's Transferabledsl- The source's DragSourceListener- Throws:
InvalidDnDOperationException- if the Drag and Drop system is unable to initiate a drag operation, or if the user attempts to start a drag while an existing drag operation is still executing.
-
startDrag
public void startDrag(Cursor dragCursor, Image dragImage, Point imageOffset, Transferable transferable, DragSourceListener dsl) throws InvalidDnDOperationException Start the drag given the initialCursorto display, a dragImage, the offset of theImage, theTransferableobject, and theDragSourceListenerto use.- Parameters:
dragCursor- The initialCursorfor this drag operation ornullfor the default cursor handling; see DragSourceContext for more details on the cursor handling mechanism during drag and dropdragImage- The source's dragImageimageOffset- The dragImage's offsettransferable- The source's Transferabledsl- The source's DragSourceListener- Throws:
InvalidDnDOperationException- if the Drag and Drop system is unable to initiate a drag operation, or if the user attempts to start a drag while an existing drag operation is still executing.
-