java.awt.dnd
Class DragGestureEvent
- java.lang.Object
-
- java.util.EventObject
-
- java.awt.dnd.DragGestureEvent
-
- All Implemented Interfaces:
- Serializable
public class DragGestureEvent extends EventObject
ADragGestureEvent
is passed toDragGestureListener
's dragGestureRecognized() method when a particularDragGestureRecognizer
detects that a platform dependent drag initiating gesture has occurred on theComponent
that it is tracking. Theaction
field of anyDragGestureEvent
instance should take one of the following values:DnDConstants.ACTION_COPY
DnDConstants.ACTION_MOVE
DnDConstants.ACTION_LINK
-
-
Field Summary
-
Fields inherited from class java.util.EventObject
source
-
-
Constructor Summary
Constructors Constructor and Description DragGestureEvent(DragGestureRecognizer dgr, int act, Point ori, List<? extends InputEvent> evs)
Constructs aDragGestureEvent
object given by theDragGestureRecognizer
instance firing this event, anact
parameter representing the user's preferred action, anori
parameter indicating the origin of the drag, and aList
of events that comprise the gesture(evs
parameter).
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description Component
getComponent()
Returns theComponent
associated with thisDragGestureEvent
.int
getDragAction()
Returns anint
representing the action selected by the user.Point
getDragOrigin()
Returns aPoint
in the coordinates of theComponent
over which the drag originated.DragSource
getDragSource()
Returns theDragSource
.DragGestureRecognizer
getSourceAsDragGestureRecognizer()
Returns the source as aDragGestureRecognizer
.InputEvent
getTriggerEvent()
Returns the initial event that triggered the gesture.Iterator<InputEvent>
iterator()
Returns anIterator
for the events comprising the gesture.void
startDrag(Cursor dragCursor, Image dragImage, Point imageOffset, Transferable transferable, DragSourceListener dsl)
Start the drag given the initialCursor
to display, a dragImage
, the offset of theImage
, theTransferable
object, and theDragSourceListener
to use.void
startDrag(Cursor dragCursor, Transferable transferable)
Starts the drag operation given theCursor
for this drag operation and theTransferable
representing the source data for this drag operation.void
startDrag(Cursor dragCursor, Transferable transferable, DragSourceListener dsl)
Starts the drag given the initialCursor
to display, theTransferable
object, and theDragSourceListener
to use.Object[]
toArray()
Returns anObject
array of the events comprising the drag gesture.Object[]
toArray(Object[] array)
Returns an array of the events comprising the drag gesture.-
Methods inherited from class java.util.EventObject
getSource, toString
-
-
-
-
Constructor Detail
DragGestureEvent
public DragGestureEvent(DragGestureRecognizer dgr, int act, Point ori, List<? extends InputEvent> evs)
Constructs aDragGestureEvent
object given by theDragGestureRecognizer
instance firing this event, anact
parameter representing the user's preferred action, anori
parameter indicating the origin of the drag, and aList
of events that comprise the gesture(evs
parameter).- Parameters:
-
dgr
- TheDragGestureRecognizer
firing this event -
act
- The user's preferred action. For information on allowable values, see the class description forDragGestureEvent
-
ori
- The origin of the drag -
evs
- TheList
of events that comprise the gesture - Throws:
-
IllegalArgumentException
- if any parameter equalsnull
-
IllegalArgumentException
- if the act parameter does not comply with the values given in the class description forDragGestureEvent
- See Also:
-
DnDConstants
-
Method Detail
getSourceAsDragGestureRecognizer
public DragGestureRecognizer getSourceAsDragGestureRecognizer()
Returns the source as aDragGestureRecognizer
.- Returns:
-
the source as a
DragGestureRecognizer
getComponent
public Component getComponent()
Returns theComponent
associated with thisDragGestureEvent
.- Returns:
- the Component
getDragSource
public DragSource getDragSource()
Returns theDragSource
.- Returns:
-
the
DragSource
getDragOrigin
public Point getDragOrigin()
Returns aPoint
in the coordinates of theComponent
over which the drag originated.- Returns:
- the Point where the drag originated in Component coords.
iterator
public Iterator<InputEvent> iterator()
Returns anIterator
for the events comprising the gesture.- Returns:
- an Iterator for the events comprising the gesture
toArray
public Object[] toArray()
Returns anObject
array of the events comprising the drag gesture.- Returns:
- an array of the events comprising the gesture
toArray
public Object[] toArray(Object[] array)
Returns an array of the events comprising the drag gesture.- Parameters:
-
array
- the array ofEventObject
sub(types) - Returns:
- an array of the events comprising the gesture
getDragAction
public int getDragAction()
Returns anint
representing the action selected by the user.- Returns:
- the action selected by the user
getTriggerEvent
public InputEvent 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 theCursor
for this drag operation and theTransferable
representing the source data for this drag operation.
If anull
Cursor
is specified no exception will be thrown and default drag cursors will be used instead.
If anull
Transferable
is specifiedNullPointerException
will be thrown.- Parameters:
-
dragCursor
- The initialCursor
for this drag operation ornull
for the default cursor handling; see DragSourceContext for more details on the cursor handling mechanism during drag and drop -
transferable
- TheTransferable
representing 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 theTransferable
isnull
- Since:
- 1.4
startDrag
public void startDrag(Cursor dragCursor, Transferable transferable, DragSourceListener dsl) throws InvalidDnDOperationException
Starts the drag given the initialCursor
to display, theTransferable
object, and theDragSourceListener
to use.- Parameters:
-
dragCursor
- The initialCursor
for this drag operation ornull
for the default cursor handling; see DragSourceContext for more details on the cursor handling mechanism during drag and drop -
transferable
- The source's Transferable -
dsl
- 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 initialCursor
to display, a dragImage
, the offset of theImage
, theTransferable
object, and theDragSourceListener
to use.- Parameters:
-
dragCursor
- The initialCursor
for this drag operation ornull
for the default cursor handling; see DragSourceContext for more details on the cursor handling mechanism during drag and drop -
dragImage
- The source's dragImage -
imageOffset
- The dragImage's offset -
transferable
- The source's Transferable -
dsl
- 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.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.