DragGestureEvent (Java 2 Platform SE 5.0) (original) (raw)

java.awt.dnd

Class DragGestureEvent

java.lang.Object java.util.EventObject java.awt.dnd.DragGestureEvent

All Implemented Interfaces:

Serializable

public class DragGestureEvent

extends EventObject

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.

See Also:

DragGestureRecognizer, DragGestureListener, DragSource, Serialized Form

DragGestureEvent

public DragGestureEvent(DragGestureRecognizer dgr, int act, Point ori, List<? extends InputEvent> evs)

Construct a DragGestureEvent given theDragGestureRecognizer firing this event, an int representing the user's preferred action, a Point indicating the origin of the drag, and a List of events that comprise the gesture.

Parameters:

dgr - The DragGestureRecognizer firing this event

act - The the user's preferred action

ori - The origin of the drag

evs - The List of events that comprise the gesture

Throws:

`IllegalArgumentException` - if input parameters are null

getSourceAsDragGestureRecognizer

public DragGestureRecognizer getSourceAsDragGestureRecognizer()

Returns the source as a DragGestureRecognizer.

Returns:

the source as a DragGestureRecognizer

getComponent

public Component getComponent()

Returns the Component associated with this DragGestureEvent.

Returns:

the Component

getDragSource

public DragSource getDragSource()

Returns the DragSource.

Returns:

the DragSource

getDragOrigin

public Point getDragOrigin()

Returns a Point in the coordinates of the Component over which the drag originated.

Returns:

the Point where the drag originated in Component coords.

iterator

public Iterator<InputEvent> iterator()

Returns an Iterator for the events comprising the gesture.

Returns:

an Iterator for the events comprising the gesture

toArray

public Object[] toArray()

Returns an Object 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 of EventObject sub(types)

Returns:

an array of the events comprising the gesture

getDragAction

public int getDragAction()

Returns an int 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 the Cursor for this drag operation and the Transferable representing the source data for this drag operation.
If a null Cursor is specified no exception will be thrown and default drag cursors will be used instead.
If a null Transferable is specified NullPointerException will be thrown.

Parameters:

dragCursor - The Cursor for this drag operation

transferable - The Transferable 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 is null.

[InvalidDnDOperationException](../../../java/awt/dnd/InvalidDnDOperationException.html "class in java.awt.dnd")

Since:

1.4

startDrag

public void startDrag(Cursor dragCursor, Transferable transferable, DragSourceListener dsl) throws InvalidDnDOperationException

Starts the drag given the initial Cursor to display, the Transferable object, and the DragSourceListener to use.

Parameters:

dragCursor - The initial drag Cursor

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.

[InvalidDnDOperationException](../../../java/awt/dnd/InvalidDnDOperationException.html "class in java.awt.dnd")

startDrag

public void startDrag(Cursor dragCursor, Image dragImage, Point imageOffset, Transferable transferable, DragSourceListener dsl) throws InvalidDnDOperationException

Start the drag given the initial Cursor to display, a drag Image, the offset of the Image, the Transferable object, and the DragSourceListener to use.

Parameters:

dragCursor - The initial drag Cursor

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.

[InvalidDnDOperationException](../../../java/awt/dnd/InvalidDnDOperationException.html "class in java.awt.dnd")

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.