java.awt.dnd
Class DragGestureEvent

java.lang.Object
  extended by java.util.EventObject
      extended by java.awt.dnd.DragGestureEvent
All Implemented Interfaces:
Serializable

public class DragGestureEvent
extends EventObject

See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
DragGestureEvent(DragGestureRecognizer dgr, int action, Point origin, List<? extends InputEvent> events)
          Constructs a new DragGestureEvent.
 
Method Summary
 Component getComponent()
          Returns the Component corresponding to this.
 int getDragAction()
          Gets the user's preferred action.
 Point getDragOrigin()
          Returns the origin of the drag.
 DragSource getDragSource()
          Gets the DragSource corresponding to this.
 DragGestureRecognizer getSourceAsDragGestureRecognizer()
          Returns the source casted as a DragGestureRecognizer.
 InputEvent getTriggerEvent()
          Get the event that triggered this gesture.
 Iterator<InputEvent> iterator()
          Gets an iterator representation of the List of events.
 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.
 void startDrag(Cursor dragCursor, Transferable trans)
          Starts the drag given the initial Cursor to display, the Transferable object, and the DragSourceListener to use.
 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.
 Object[] toArray()
          Gets an array representation of the List of events.
 Object[] toArray(Object[] array)
          Gets an array representation of the List of events.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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

getSourceAsDragGestureRecognizer

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

Returns:
the source casted as a DragGestureRecognizer.

getComponent

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

Returns:
the Component corresponding to this.

getDragSource

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

Returns:
the DragSource corresponding to this.

getDragOrigin

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

Returns:
the origin of the drag.

iterator

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

Returns:
an iterator representation of the List of events.

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.

getDragAction

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

Returns:
the user's preferred action.

getTriggerEvent

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

Returns:
the event that triggered this gesture.

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.