DragGestureRecognizer JDK 1.6)

Description

publicabstract abstract class DragGestureRecognizer

The DragGestureRecognizer is an abstract base class for the specification of a platform-dependent listener that can be associated with a particular Component in order to identify platform-dependent drag initiating gestures.

The appropriate DragGestureRecognizer subclass is obtained from the DragSource asssociated with a particular Component, or from the Toolkit object via its createDragGestureRecognizer() method.

Once the DragGestureRecognizer is associated with a particular Component it will register the appropriate listener interfaces on that Component in order to track the input events delivered to the Component.

Once the DragGestureRecognizer identifies a sequence of events on the Component as a drag initiating gesture, it will notify its unicast DragGestureListener by invoking its gestureRecognized() method.

When a concrete DragGestureRecognizer instance detects a drag initiating gesture on the Component it is associated with, it will fire a DragGestureEvent to the DragGestureListener registered on its unicast event source for DragGestureListener events. This DragGestureListener is responsible for causing the associated DragSource to start the Drag and Drop operation (if appropriate).

See also: DragGestureListener DragGestureEvent DragSource

Constructors

protected DragGestureRecognizer (DragSource ds)

Construct a new DragGestureRecognizer given the DragSource to be used in this Drag and Drop operation.

Parameters:
- ds - the DragSource this DragGestureRecognizer will use to process the Drag and Drop operation

Throws:
- IllegalArgumentException - if ds is null.

protected DragGestureRecognizer (DragSource ds, Component c)

Construct a new DragGestureRecognizer given the DragSource to be used in this Drag and Drop operation, and the Component this DragGestureRecognizer should "observe" for drag initiating gestures.

Throws:
- IllegalArgumentException - if ds is null.

protected DragGestureRecognizer (DragSource ds, Component c, int sa)

Construct a new DragGestureRecognizer given the DragSource to be used in this Drag and Drop operation, the Component this DragGestureRecognizer should "observe" for drag initiating gestures, and the action(s) supported for this Drag and Drop operation.

Parameters:
- ds - the DragSource this DragGestureRecognizer will use to process the Drag and Drop operation
- c - the Component this DragGestureRecognizer should "observe" the event stream to, in order to detect a drag initiating gesture. If this value is null, the DragGestureRecognizer is not associated with any Component.
- sa - the set (logical OR) of the DnDConstants that this Drag and Drop operation will support

Throws:
- IllegalArgumentException - if ds is null.

protected DragGestureRecognizer (DragSource ds, Component c, int sa, DragGestureListener dgl)

Construct a new DragGestureRecognizer given the DragSource to be used in this Drag and Drop operation, the Component this DragGestureRecognizer should "observe" for drag initiating gestures, the action(s) supported for this Drag and Drop operation, and the DragGestureListener to notify once a drag initiating gesture has been detected.

Throws:
- IllegalArgumentException - if ds is null.

Methods

Hide/Show inherited methods

publicsynchronized void addDragGestureListener (DragGestureListener dgl) throws TooManyListenersException

Parameters:
- dgl - the DragGestureListener to register with this DragGestureRecognizer.

Throws:
- java.util.TooManyListenersException - if a DragGestureListener has already been added.

protectedsynchronized void appendEvent (InputEvent awtie)

Listeners registered on the Component by this Recognizer shall record all Events that are recognized as part of the series of Events that go to comprise a Drag and Drop initiating gesture via this API.

protectedsynchronized void fireDragGestureRecognized (int dragAction, Point p)

Notify the DragGestureListener that a Drag and Drop initiating gesture has occurred.

publicsynchronized Component getComponent ()

This method returns the Component that is to be "observed" by the DragGestureRecognizer for drag initiating gestures.

Returns: The Component this DragGestureRecognizer is associated with

public DragSource getDragSource ()

This method returns the DragSource this DragGestureRecognizer will use in order to process the Drag and Drop operation.

Returns: the DragSource

publicsynchronized int getSourceActions ()

This method returns an int representing the type of action(s) this Drag and Drop operation will support.

public InputEvent getTriggerEvent ()

This method returns the first event in the series of events that initiated the Drag and Drop operation.

protectedabstract void registerListeners ()

publicsynchronized void removeDragGestureListener (DragGestureListener dgl)

unregister the current DragGestureListener

public void resetRecognizer ()

Reset the Recognizer, if its currently recognizing a gesture, ignore it.

publicsynchronized void setComponent (Component c)

set the Component that the DragGestureRecognizer is associated with registerListeners() and unregisterListeners() are called as a side effect as appropriate.

publicsynchronized void setSourceActions (int actions)

This method sets the permitted source drag action(s) for this Drag and Drop operation.

protectedabstract void unregisterListeners ()

unregister this DragGestureRecognizer's Listeners with the Component subclasses must override this method