| |
|
| java.lang.Object
 java.awt.dnd.DragGestureRecognizer
All known Subclasses: java.awt.dnd.MouseDragGestureRecognizer,
| DragGestureRecognizer | | abstract public class DragGestureRecognizer implements Serializable(Code) | | 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 instance is obtained from the
DragSource asssociated with
a particular Component, or from the Toolkit object via its
java.awt.Toolkit.createDragGestureRecognizer 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
java.awt.dnd.DragGestureListener.dragGestureRecognized gestureRecognized() method.
When a concrete DragGestureRecognizer
instance detects a drag initiating
gesture on the Component it is associated with,
it fires 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).
author:
Laurence P. G. Cable
version:
1.28
See Also: java.awt.dnd.DragGestureListener
See Also: java.awt.dnd.DragGestureEvent
See Also: java.awt.dnd.DragSource |
| Field Summary | |
| protected Component | component
The Component
associated with this DragGestureRecognizer. | | protected transient DragGestureListener | dragGestureListener
The DragGestureListener
associated with this DragGestureRecognizer. | | protected DragSource | dragSource
The DragSource
associated with this
DragGestureRecognizer. | | protected ArrayList<InputEvent> | events
The list of events (in order) that
the DragGestureRecognizer
"recognized" as a "gesture" that triggers a drag. | | protected int | sourceActions
An int representing
the type(s) of action(s) used
in this Drag and Drop operation. |
| Constructor Summary | |
| 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. | | 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. | | 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. | | protected | DragGestureRecognizer(DragSource ds)
Construct a new DragGestureRecognizer
given the DragSource to be used in this
Drag and Drop operation. |
| Method Summary | |
| public synchronized void | addDragGestureListener(DragGestureListener dgl)
Register a new DragGestureListener. | | protected synchronized 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.
This method is used by a DragGestureRecognizer
implementation to add an InputEvent
subclass (that it believes is one in a series
of events that comprise a Drag and Drop operation)
to the array of events that this
DragGestureRecognizer maintains internally.
Parameters:
awtie - the InputEvent to add to this DragGestureRecognizer's internal array of events. | | protected synchronized void | fireDragGestureRecognized(int dragAction, Point p)
Notify the DragGestureListener that a Drag and Drop initiating
gesture has occurred. | | public synchronized Component | getComponent()
This method returns the Component
that is to be "observed" by the
DragGestureRecognizer
for drag initiating gestures. | | public DragSource | getDragSource()
This method returns the DragSource
this DragGestureRecognizer
will use in order to process the Drag and Drop
operation. | | public synchronized 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. | | abstract protected void | registerListeners()
| | public synchronized void | removeDragGestureListener(DragGestureListener dgl)
| | public void | resetRecognizer()
Reset the Recognizer, if its currently recognizing a gesture, ignore
it. | | public synchronized void | setComponent(Component c)
set the Component that the DragGestureRecognizer is associated with
registerListeners() and unregisterListeners() are called as a side
effect as appropriate. | | public synchronized void | setSourceActions(int actions)
This method sets the permitted source drag action(s)
for this Drag and Drop operation. | | abstract protected void | unregisterListeners()
|
| component | | protected Component component(Code) | | The Component
associated with this DragGestureRecognizer.
|
| dragGestureListener | | protected transient DragGestureListener dragGestureListener(Code) | | The DragGestureListener
associated with this DragGestureRecognizer.
|
| dragSource | | protected DragSource dragSource(Code) | | The DragSource
associated with this
DragGestureRecognizer.
|
| events | | protected ArrayList<InputEvent> events(Code) | | The list of events (in order) that
the DragGestureRecognizer
"recognized" as a "gesture" that triggers a drag.
|
| sourceActions | | protected int sourceActions(Code) | | An int representing
the type(s) of action(s) used
in this Drag and Drop operation.
|
| DragGestureRecognizer | | protected DragGestureRecognizer(DragSource ds, Component c, int sa, DragGestureListener dgl)(Code) | | 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.
Parameters:
ds - the DragSource this DragGestureRecognizer will use to process the Drag and Drop operation
Parameters:
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 DragGestureRecognizeris not associated with any Component.
Parameters:
sa - the set (logical OR) of the DnDConstants that this Drag and Drop operation will support
Parameters:
dgl - the DragGestureRecognizer to notify when a drag gesture is detected IllegalArgumentException if ds is null. |
| DragGestureRecognizer | | protected DragGestureRecognizer(DragSource ds, Component c, int sa)(Code) | | 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
Parameters:
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 DragGestureRecognizeris not associated with any Component.
Parameters:
sa - the set (logical OR) of the DnDConstants that this Drag and Drop operation will support IllegalArgumentException if ds is null. |
| DragGestureRecognizer | | protected DragGestureRecognizer(DragSource ds, Component c)(Code) | | 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.
Parameters:
ds - the DragSource this DragGestureRecognizer will use to process the Drag and Drop operation
Parameters:
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 DragGestureRecognizeris not associated with any Component. IllegalArgumentException if ds is null. |
| DragGestureRecognizer | | protected DragGestureRecognizer(DragSource ds)(Code) | | 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 IllegalArgumentException if ds is null. |
| appendEvent | | protected synchronized void appendEvent(InputEvent awtie)(Code) | | 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.
This method is used by a DragGestureRecognizer
implementation to add an InputEvent
subclass (that it believes is one in a series
of events that comprise a Drag and Drop operation)
to the array of events that this
DragGestureRecognizer maintains internally.
Parameters:
awtie - the InputEvent to add to this DragGestureRecognizer's internal array of events. Note that nullis not a valid value, and will be ignored. |
| fireDragGestureRecognized | | protected synchronized void fireDragGestureRecognized(int dragAction, Point p)(Code) | | Notify the DragGestureListener that a Drag and Drop initiating
gesture has occurred. Then reset the state of the Recognizer.
Parameters:
dragAction - The action initially selected by the users gesture
Parameters:
p - The point (in Component coords) where the gesture originated |
| getComponent | | public synchronized Component getComponent()(Code) | | This method returns the Component
that is to be "observed" by the
DragGestureRecognizer
for drag initiating gestures.
The Component this DragGestureRecognizer is associated with |
| getDragSource | | public DragSource getDragSource()(Code) | | This method returns the DragSource
this DragGestureRecognizer
will use in order to process the Drag and Drop
operation.
the DragSource |
| getSourceActions | | public synchronized int getSourceActions()(Code) | | This method returns an int representing the
type of action(s) this Drag and Drop
operation will support.
the currently permitted source action(s) |
| getTriggerEvent | | public InputEvent getTriggerEvent()(Code) | | This method returns the first event in the
series of events that initiated
the Drag and Drop operation.
the initial event that triggered the drag gesture |
| registerListeners | | abstract protected void registerListeners()(Code) | | register this DragGestureRecognizer's Listeners with the Component
subclasses must override this method
|
| removeDragGestureListener | | public synchronized void removeDragGestureListener(DragGestureListener dgl)(Code) | | unregister the current DragGestureListener
Parameters:
dgl - the DragGestureListener to unregister from this DragGestureRecognizer IllegalArgumentException if dgl is not (equal to) the currently registered DragGestureListener. |
| resetRecognizer | | public void resetRecognizer()(Code) | | Reset the Recognizer, if its currently recognizing a gesture, ignore
it.
|
| setComponent | | public synchronized void setComponent(Component c)(Code) | | set the Component that the DragGestureRecognizer is associated with
registerListeners() and unregisterListeners() are called as a side
effect as appropriate.
Parameters:
c - The Component or null |
| setSourceActions | | public synchronized void setSourceActions(int actions)(Code) | | This method sets the permitted source drag action(s)
for this Drag and Drop operation.
Parameters:
actions - the permitted source drag action(s) |
| unregisterListeners | | abstract protected void unregisterListeners()(Code) | | unregister this DragGestureRecognizer's Listeners with the Component
subclasses must override this method
|
|
|
|