java.awt.dnd

Class DragGestureEvent

public class DragGestureEvent extends EventObject

Constructor Summary
DragGestureEvent(DragGestureRecognizer dgr, int action, Point origin, List<? extends InputEvent> events)
Constructs a new DragGestureEvent.
Method Summary
ComponentgetComponent()
Returns the Component corresponding to this.
intgetDragAction()
Gets the user's preferred action.
PointgetDragOrigin()
Returns the origin of the drag.
DragSourcegetDragSource()
Gets the DragSource corresponding to this.
DragGestureRecognizergetSourceAsDragGestureRecognizer()
Returns the source casted as a DragGestureRecognizer.
InputEventgetTriggerEvent()
Get the event that triggered this gesture.
Iterator<InputEvent>iterator()
Gets an iterator representation of the List of events.
voidstartDrag(Cursor dragCursor, Transferable trans)
Starts the drag given the initial Cursor to display, the Transferable object, and the DragSourceListener to use.
voidstartDrag(Cursor dragCursor, Transferable trans, DragSourceListener l)
Starts the drag given the initial Cursor to display, the Transferable object, and the DragSourceListener to use.
voidstartDrag(Cursor dragCursor, Image dragImage, Point imageOffset, Transferable trans, DragSourceListener l)
Starts the drag given the initial Cursor to display, the Transferable object, and the DragSourceListener to use.
Object[]toArray()
Gets an array representation of the List of events.
Object[]toArray(Object[] array)
Gets an array representation of the List of events.

Constructor Detail

DragGestureEvent

public DragGestureEvent(DragGestureRecognizer dgr, int action, Point origin, List<? extends InputEvent> events)
Constructs a new DragGestureEvent.

Parameters: dgr - DragGestureRecognizer firing this event action - user's preferred action origin - origin of the drag events - List of events that make up the gesture

Throws: IllegalArgumentException - if input parameters are null

Method Detail

getComponent

public Component getComponent()
Returns the Component corresponding to this.

Returns: the Component corresponding to this.

getDragAction

public int getDragAction()
Gets the user's preferred action.

Returns: the user's preferred action.

getDragOrigin

public Point getDragOrigin()
Returns the origin of the drag.

Returns: the origin of the drag.

getDragSource

public DragSource getDragSource()
Gets the DragSource corresponding to this.

Returns: the DragSource corresponding to this.

getSourceAsDragGestureRecognizer

public DragGestureRecognizer getSourceAsDragGestureRecognizer()
Returns the source casted as a DragGestureRecognizer.

Returns: the source casted as a DragGestureRecognizer.

getTriggerEvent

public InputEvent getTriggerEvent()
Get the event that triggered this gesture.

Returns: the event that triggered this gesture.

iterator

public Iterator<InputEvent> iterator()
Gets an iterator representation of the List of events.

Returns: an iterator representation of the List of events.

startDrag

public void startDrag(Cursor dragCursor, Transferable trans)
Starts the drag given the initial Cursor to display, the Transferable object, and the DragSourceListener to use.

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, Transferable trans, DragSourceListener l)
Starts the drag given the initial Cursor to display, the Transferable object, and the DragSourceListener to use.

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 trans, DragSourceListener l)
Starts the drag given the initial Cursor to display, the Transferable object, and the DragSourceListener to use.

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.

toArray

public Object[] toArray()
Gets an array representation of the List of events.

Returns: an array representation of the List of events.

toArray

public Object[] toArray(Object[] array)
Gets an array representation of the List of events.

Parameters: array - the array to store the events in.

Returns: an array representation of the List of events.