- java.lang.Object
-
- java.awt.dnd.DragGestureRecognizer
-
- All Implemented Interfaces:
- Serializable
- Direct Known Subclasses:
- MouseDragGestureRecognizer
public abstract class DragGestureRecognizer extends Object implements Serializable
TheDragGestureRecognizer
is an abstract base class for the specification of a platform-dependent listener that can be associated with a particularComponent
in order to identify platform-dependent drag initiating gestures.The appropriate
DragGestureRecognizer
subclass instance is obtained from theDragSource
asssociated with a particularComponent
, or from theToolkit
object via itscreateDragGestureRecognizer()
method.Once the
DragGestureRecognizer
is associated with a particularComponent
it will register the appropriate listener interfaces on thatComponent
in order to track the input events delivered to theComponent
.Once the
DragGestureRecognizer
identifies a sequence of events on theComponent
as a drag initiating gesture, it will notify its unicastDragGestureListener
by invoking itsgestureRecognized()
method.When a concrete
DragGestureRecognizer
instance detects a drag initiating gesture on theComponent
it is associated with, it fires aDragGestureEvent
to theDragGestureListener
registered on its unicast event source forDragGestureListener
events. ThisDragGestureListener
is responsible for causing the associatedDragSource
to start the Drag and Drop operation (if appropriate).- See Also:
DragGestureListener
,DragGestureEvent
,DragSource
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description protected Component
component
TheComponent
associated with thisDragGestureRecognizer
.protected DragGestureListener
dragGestureListener
TheDragGestureListener
associated with thisDragGestureRecognizer
.protected DragSource
dragSource
TheDragSource
associated with thisDragGestureRecognizer
.protected ArrayList<InputEvent>
events
The list of events (in order) that theDragGestureRecognizer
"recognized" as a "gesture" that triggers a drag.protected int
sourceActions
Anint
representing the type(s) of action(s) used in this Drag and Drop operation.
-
Constructor Summary
Constructors Modifier Constructor and Description protected
DragGestureRecognizer(DragSource ds)
Construct a newDragGestureRecognizer
given theDragSource
to be used in this Drag and Drop operation.protected
DragGestureRecognizer(DragSource ds, Component c)
Construct a newDragGestureRecognizer
given theDragSource
to be used in this Drag and Drop operation, and theComponent
thisDragGestureRecognizer
should "observe" for drag initiating gestures.protected
DragGestureRecognizer(DragSource ds, Component c, int sa)
Construct a newDragGestureRecognizer
given theDragSource
to be used in this Drag and Drop operation, theComponent
thisDragGestureRecognizer
should "observe" for drag initiating gestures, and the action(s) supported for this Drag and Drop operation.protected
DragGestureRecognizer(DragSource ds, Component c, int sa, DragGestureListener dgl)
Construct a newDragGestureRecognizer
given theDragSource
to be used in this Drag and Drop operation, theComponent
thisDragGestureRecognizer
should "observe" for drag initiating gestures, the action(s) supported for this Drag and Drop operation, and theDragGestureListener
to notify once a drag initiating gesture has been detected.
-
Method Summary
Methods Modifier and Type Method and Description void
addDragGestureListener(DragGestureListener dgl)
Register a newDragGestureListener
.protected 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.protected void
fireDragGestureRecognized(int dragAction, Point p)
Notify the DragGestureListener that a Drag and Drop initiating gesture has occurred.Component
getComponent()
This method returns theComponent
that is to be "observed" by theDragGestureRecognizer
for drag initiating gestures.DragSource
getDragSource()
This method returns theDragSource
thisDragGestureRecognizer
will use in order to process the Drag and Drop operation.int
getSourceActions()
This method returns an int representing the type of action(s) this Drag and Drop operation will support.InputEvent
getTriggerEvent()
This method returns the first event in the series of events that initiated the Drag and Drop operation.protected abstract void
registerListeners()
register this DragGestureRecognizer's Listeners with the Component subclasses must override this methodvoid
removeDragGestureListener(DragGestureListener dgl)
unregister the current DragGestureListenervoid
resetRecognizer()
Reset the Recognizer, if its currently recognizing a gesture, ignore it.void
setComponent(Component c)
set the Component that the DragGestureRecognizer is associated with registerListeners() and unregisterListeners() are called as a side effect as appropriate.void
setSourceActions(int actions)
This method sets the permitted source drag action(s) for this Drag and Drop operation.protected abstract void
unregisterListeners()
unregister this DragGestureRecognizer's Listeners with the Component subclasses must override this method
-
-
-
Field Detail
-
dragSource
protected DragSource dragSource
TheDragSource
associated with thisDragGestureRecognizer
.
-
component
protected Component component
TheComponent
associated with thisDragGestureRecognizer
.
-
dragGestureListener
protected transient DragGestureListener dragGestureListener
TheDragGestureListener
associated with thisDragGestureRecognizer
.
-
sourceActions
protected int sourceActions
Anint
representing the type(s) of action(s) used in this Drag and Drop operation.
-
events
protected ArrayList<InputEvent> events
The list of events (in order) that theDragGestureRecognizer
"recognized" as a "gesture" that triggers a drag.
-
-
Constructor Detail
-
DragGestureRecognizer
protected DragGestureRecognizer(DragSource ds, Component c, int sa, DragGestureListener dgl)
Construct a newDragGestureRecognizer
given theDragSource
to be used in this Drag and Drop operation, theComponent
thisDragGestureRecognizer
should "observe" for drag initiating gestures, the action(s) supported for this Drag and Drop operation, and theDragGestureListener
to notify once a drag initiating gesture has been detected.- Parameters:
ds
- theDragSource
thisDragGestureRecognizer
will use to process the Drag and Drop operationc
- theComponent
thisDragGestureRecognizer
should "observe" the event stream to, in order to detect a drag initiating gesture. If this value isnull
, theDragGestureRecognizer
is not associated with anyComponent
.sa
- the set (logical OR) of theDnDConstants
that this Drag and Drop operation will supportdgl
- theDragGestureRecognizer
to notify when a drag gesture is detected- Throws:
- if ds isIllegalArgumentException
null
.
-
DragGestureRecognizer
protected DragGestureRecognizer(DragSource ds, Component c, int sa)
Construct a newDragGestureRecognizer
given theDragSource
to be used in this Drag and Drop operation, theComponent
thisDragGestureRecognizer
should "observe" for drag initiating gestures, and the action(s) supported for this Drag and Drop operation.- Parameters:
ds
- theDragSource
thisDragGestureRecognizer
will use to process the Drag and Drop operationc
- theComponent
thisDragGestureRecognizer
should "observe" the event stream to, in order to detect a drag initiating gesture. If this value isnull
, theDragGestureRecognizer
is not associated with anyComponent
.sa
- the set (logical OR) of theDnDConstants
that this Drag and Drop operation will support- Throws:
- if ds isIllegalArgumentException
null
.
-
DragGestureRecognizer
protected DragGestureRecognizer(DragSource ds, Component c)
Construct a newDragGestureRecognizer
given theDragSource
to be used in this Drag and Drop operation, and theComponent
thisDragGestureRecognizer
should "observe" for drag initiating gestures.- Parameters:
ds
- theDragSource
thisDragGestureRecognizer
will use to process the Drag and Drop operationc
- theComponent
thisDragGestureRecognizer
should "observe" the event stream to, in order to detect a drag initiating gesture. If this value isnull
, theDragGestureRecognizer
is not associated with anyComponent
.- Throws:
- if ds isIllegalArgumentException
null
.
-
DragGestureRecognizer
protected DragGestureRecognizer(DragSource ds)
Construct a newDragGestureRecognizer
given theDragSource
to be used in this Drag and Drop operation.- Parameters:
ds
- theDragSource
thisDragGestureRecognizer
will use to process the Drag and Drop operation- Throws:
- if ds isIllegalArgumentException
null
.
-
-
Method Detail
-
registerListeners
protected abstract void registerListeners()
register this DragGestureRecognizer's Listeners with the Component subclasses must override this method
-
unregisterListeners
protected abstract void unregisterListeners()
unregister this DragGestureRecognizer's Listeners with the Component subclasses must override this method
-
getDragSource
public DragSource getDragSource()
This method returns theDragSource
thisDragGestureRecognizer
will use in order to process the Drag and Drop operation.- Returns:
- the DragSource
-
getComponent
public Component getComponent()
This method returns theComponent
that is to be "observed" by theDragGestureRecognizer
for drag initiating gestures.- Returns:
- The Component this DragGestureRecognizer is associated with
-
setComponent
public void setComponent(Component c)
set the Component that the DragGestureRecognizer is associated with registerListeners() and unregisterListeners() are called as a side effect as appropriate.- Parameters:
c
- TheComponent
ornull
-
getSourceActions
public int getSourceActions()
This method returns an int representing the type of action(s) this Drag and Drop operation will support.- Returns:
- the currently permitted source action(s)
-
setSourceActions
public void setSourceActions(int actions)
This method sets the permitted source drag action(s) for this Drag and Drop operation.- Parameters:
actions
- the permitted source drag action(s)
-
getTriggerEvent
public InputEvent getTriggerEvent()
This method returns the first event in the series of events that initiated the Drag and Drop operation.- Returns:
- the initial event that triggered the drag gesture
-
resetRecognizer
public void resetRecognizer()
Reset the Recognizer, if its currently recognizing a gesture, ignore it.
-
addDragGestureListener
public void addDragGestureListener(DragGestureListener dgl) throws TooManyListenersException
Register a newDragGestureListener
.- Parameters:
dgl
- theDragGestureListener
to register with thisDragGestureRecognizer
.- Throws:
TooManyListenersException
- if aDragGestureListener
has already been added.
-
removeDragGestureListener
public void removeDragGestureListener(DragGestureListener dgl)
unregister the current DragGestureListener- Parameters:
dgl
- theDragGestureListener
to unregister from thisDragGestureRecognizer
- Throws:
- if dgl is not (equal to) the currently registeredIllegalArgumentException
DragGestureListener
.
-
fireDragGestureRecognized
protected void fireDragGestureRecognized(int dragAction, Point p)
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 gesturep
- The point (in Component coords) where the gesture originated
-
appendEvent
protected 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 anInputEvent
subclass (that it believes is one in a series of events that comprise a Drag and Drop operation) to the array of events that thisDragGestureRecognizer
maintains internally.- Parameters:
awtie
- theInputEvent
to add to thisDragGestureRecognizer
's internal array of events. Note thatnull
is not a valid value, and will be ignored.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
26/12/2024 22:51:37 Cette version de la page est en cache (à la date du 26/12/2024 22:51:37) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 28/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/awt/dnd/DragGestureRecognizer.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.