- java.lang.Object
-
- java.awt.dnd.DragSource
-
- All Implemented Interfaces:
- Serializable
public class DragSource extends Object implements Serializable
TheDragSource
is the entity responsible for the initiation of the Drag and Drop operation, and may be used in a number of scenarios:- 1 default instance per JVM for the lifetime of that JVM.
- 1 instance per class of potential Drag Initiator object (e.g TextField). [implementation dependent]
- 1 per instance of a particular
Component
, or application specific object associated with aComponent
instance in the GUI. [implementation dependent] - Some other arbitrary association. [implementation dependent]
DragSource
is obtained, aDragGestureRecognizer
should also be obtained to associate theDragSource
with a particularComponent
.The initial interpretation of the user's gesture, and the subsequent starting of the drag operation are the responsibility of the implementing
Component
, which is usually implemented by aDragGestureRecognizer
.When a drag gesture occurs, the
DragSource
's startDrag() method shall be invoked in order to cause processing of the user's navigational gestures and delivery of Drag and Drop protocol notifications. ADragSource
shall only permit a single Drag and Drop operation to be current at any one time, and shall reject any further startDrag() requests by throwing anIllegalDnDOperationException
until such time as the extant operation is complete.The startDrag() method invokes the createDragSourceContext() method to instantiate an appropriate
DragSourceContext
and associate theDragSourceContextPeer
with that.If the Drag and Drop System is unable to initiate a drag operation for some reason, the startDrag() method throws a
java.awt.dnd.InvalidDnDOperationException
to signal such a condition. Typically this exception is thrown when the underlying platform system is either not in a state to initiate a drag, or the parameters specified are invalid.Note that during the drag, the set of operations exposed by the source at the start of the drag operation may not change until the operation is complete. The operation(s) are constant for the duration of the operation with respect to the
DragSource
.- Since:
- 1.2
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static Cursor
DefaultCopyDrop
The defaultCursor
to use with a copy operation indicating that a drop is currently allowed.static Cursor
DefaultCopyNoDrop
The defaultCursor
to use with a copy operation indicating that a drop is currently not allowed.static Cursor
DefaultLinkDrop
The defaultCursor
to use with a link operation indicating that a drop is currently allowed.static Cursor
DefaultLinkNoDrop
The defaultCursor
to use with a link operation indicating that a drop is currently not allowed.static Cursor
DefaultMoveDrop
The defaultCursor
to use with a move operation indicating that a drop is currently allowed.static Cursor
DefaultMoveNoDrop
The defaultCursor
to use with a move operation indicating that a drop is currently not allowed.
-
Constructor Summary
Constructors Constructor and Description DragSource()
Creates a newDragSource
.
-
Method Summary
Methods Modifier and Type Method and Description void
addDragSourceListener(DragSourceListener dsl)
Adds the specifiedDragSourceListener
to thisDragSource
to receive drag source events during drag operations intiated with thisDragSource
.void
addDragSourceMotionListener(DragSourceMotionListener dsml)
Adds the specifiedDragSourceMotionListener
to thisDragSource
to receive drag motion events during drag operations intiated with thisDragSource
.DragGestureRecognizer
createDefaultDragGestureRecognizer(Component c, int actions, DragGestureListener dgl)
Creates a newDragGestureRecognizer
that implements the default abstract subclass ofDragGestureRecognizer
for thisDragSource
, and sets the specifiedComponent
andDragGestureListener
on the newly created object.<T extends DragGestureRecognizer>
TcreateDragGestureRecognizer(Class<T> recognizerAbstractClass, Component c, int actions, DragGestureListener dgl)
Creates a newDragGestureRecognizer
that implements the specified abstract subclass ofDragGestureRecognizer
, and sets the specifiedComponent
andDragGestureListener
on the newly created object.protected DragSourceContext
createDragSourceContext(java.awt.dnd.peer.DragSourceContextPeer dscp, DragGestureEvent dgl, Cursor dragCursor, Image dragImage, Point imageOffset, Transferable t, DragSourceListener dsl)
Creates theDragSourceContext
to handle the current drag operation.static DragSource
getDefaultDragSource()
Gets theDragSource
object associated with the underlying platform.DragSourceListener[]
getDragSourceListeners()
Gets all theDragSourceListener
s registered with thisDragSource
.DragSourceMotionListener[]
getDragSourceMotionListeners()
Gets all of theDragSourceMotionListener
s registered with thisDragSource
.static int
getDragThreshold()
Returns the drag gesture motion threshold.FlavorMap
getFlavorMap()
This method returns theFlavorMap
for thisDragSource
.<T extends EventListener>
T[]getListeners(Class<T> listenerType)
Gets all the objects currently registered asFooListener
s upon thisDragSource
.static boolean
isDragImageSupported()
Reports whether or not dragImage
support is available on the underlying platform.void
removeDragSourceListener(DragSourceListener dsl)
Removes the specifiedDragSourceListener
from thisDragSource
.void
removeDragSourceMotionListener(DragSourceMotionListener dsml)
Removes the specifiedDragSourceMotionListener
from thisDragSource
.void
startDrag(DragGestureEvent trigger, Cursor dragCursor, Image dragImage, Point dragOffset, Transferable transferable, DragSourceListener dsl)
Start a drag, given theDragGestureEvent
that initiated the drag, the initialCursor
to use, theImage
to drag, the offset of theImage
origin from the hotspot of theCursor
at the instant of the trigger, the subject data of the drag, and theDragSourceListener
.void
startDrag(DragGestureEvent trigger, Cursor dragCursor, Image dragImage, Point imageOffset, Transferable transferable, DragSourceListener dsl, FlavorMap flavorMap)
Start a drag, given theDragGestureEvent
that initiated the drag, the initialCursor
to use, theImage
to drag, the offset of theImage
origin from the hotspot of theCursor
at the instant of the trigger, theTransferable
subject data of the drag, theDragSourceListener
, and theFlavorMap
.void
startDrag(DragGestureEvent trigger, Cursor dragCursor, Transferable transferable, DragSourceListener dsl)
Start a drag, given theDragGestureEvent
that initiated the drag, the initialCursor
to use, theTransferable
subject data of the drag, and theDragSourceListener
.void
startDrag(DragGestureEvent trigger, Cursor dragCursor, Transferable transferable, DragSourceListener dsl, FlavorMap flavorMap)
Start a drag, given theDragGestureEvent
that initiated the drag, the initialCursor
to use, theTransferable
subject data of the drag, theDragSourceListener
, and theFlavorMap
.
-
-
-
Field Detail
-
DefaultCopyDrop
public static final Cursor DefaultCopyDrop
The defaultCursor
to use with a copy operation indicating that a drop is currently allowed.null
ifGraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
-
DefaultMoveDrop
public static final Cursor DefaultMoveDrop
The defaultCursor
to use with a move operation indicating that a drop is currently allowed.null
ifGraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
-
DefaultLinkDrop
public static final Cursor DefaultLinkDrop
The defaultCursor
to use with a link operation indicating that a drop is currently allowed.null
ifGraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
-
DefaultCopyNoDrop
public static final Cursor DefaultCopyNoDrop
The defaultCursor
to use with a copy operation indicating that a drop is currently not allowed.null
ifGraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
-
DefaultMoveNoDrop
public static final Cursor DefaultMoveNoDrop
The defaultCursor
to use with a move operation indicating that a drop is currently not allowed.null
ifGraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
-
DefaultLinkNoDrop
public static final Cursor DefaultLinkNoDrop
The defaultCursor
to use with a link operation indicating that a drop is currently not allowed.null
ifGraphicsEnvironment.isHeadless()
returnstrue
.- See Also:
GraphicsEnvironment.isHeadless()
-
-
Constructor Detail
-
DragSource
public DragSource() throws HeadlessException
Creates a newDragSource
.- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- See Also:
GraphicsEnvironment.isHeadless()
-
-
Method Detail
-
getDefaultDragSource
public static DragSource getDefaultDragSource()
Gets theDragSource
object associated with the underlying platform.- Returns:
- the platform DragSource
- Throws:
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true- See Also:
GraphicsEnvironment.isHeadless()
-
isDragImageSupported
public static boolean isDragImageSupported()
Reports whether or not dragImage
support is available on the underlying platform.- Returns:
- if the Drag Image support is available on this platform
-
startDrag
public void startDrag(DragGestureEvent trigger, Cursor dragCursor, Image dragImage, Point imageOffset, Transferable transferable, DragSourceListener dsl, FlavorMap flavorMap) throws InvalidDnDOperationException
Start a drag, given theDragGestureEvent
that initiated the drag, the initialCursor
to use, theImage
to drag, the offset of theImage
origin from the hotspot of theCursor
at the instant of the trigger, theTransferable
subject data of the drag, theDragSourceListener
, and theFlavorMap
.- Parameters:
trigger
- theDragGestureEvent
that initiated the dragdragCursor
- the initialCursor
for this drag operation ornull
for the default cursor handling; see DragSourceContext for more details on the cursor handling mechanism during drag and dropdragImage
- the image to drag ornull
imageOffset
- the offset of theImage
origin from the hotspot of theCursor
at the instant of the triggertransferable
- the subject data of the dragdsl
- theDragSourceListener
flavorMap
- theFlavorMap
to use, ornull
- 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(DragGestureEvent trigger, Cursor dragCursor, Transferable transferable, DragSourceListener dsl, FlavorMap flavorMap) throws InvalidDnDOperationException
Start a drag, given theDragGestureEvent
that initiated the drag, the initialCursor
to use, theTransferable
subject data of the drag, theDragSourceListener
, and theFlavorMap
.- Parameters:
trigger
- theDragGestureEvent
that initiated the dragdragCursor
- the initialCursor
for this drag operation ornull
for the default cursor handling; see DragSourceContext for more details on the cursor handling mechanism during drag and droptransferable
- the subject data of the dragdsl
- theDragSourceListener
flavorMap
- theFlavorMap
to use ornull
- 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(DragGestureEvent trigger, Cursor dragCursor, Image dragImage, Point dragOffset, Transferable transferable, DragSourceListener dsl) throws InvalidDnDOperationException
Start a drag, given theDragGestureEvent
that initiated the drag, the initialCursor
to use, theImage
to drag, the offset of theImage
origin from the hotspot of theCursor
at the instant of the trigger, the subject data of the drag, and theDragSourceListener
.- Parameters:
trigger
- theDragGestureEvent
that initiated the dragdragCursor
- the initialCursor
for this drag operation ornull
for the default cursor handling; see DragSourceContext for more details on the cursor handling mechanism during drag and dropdragImage
- theImage
to drag ornull
dragOffset
- the offset of theImage
origin from the hotspot of theCursor
at the instant of the triggertransferable
- the subject data of the dragdsl
- theDragSourceListener
- 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(DragGestureEvent trigger, Cursor dragCursor, Transferable transferable, DragSourceListener dsl) throws InvalidDnDOperationException
Start a drag, given theDragGestureEvent
that initiated the drag, the initialCursor
to use, theTransferable
subject data of the drag, and theDragSourceListener
.- Parameters:
trigger
- theDragGestureEvent
that initiated the dragdragCursor
- the initialCursor
for this drag operation ornull
for the default cursor handling; see DragSourceContext class for more details on the cursor handling mechanism during drag and droptransferable
- the subject data of the dragdsl
- theDragSourceListener
- 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
-
createDragSourceContext
protected DragSourceContext createDragSourceContext(java.awt.dnd.peer.DragSourceContextPeer dscp, DragGestureEvent dgl, Cursor dragCursor, Image dragImage, Point imageOffset, Transferable t, DragSourceListener dsl)
Creates theDragSourceContext
to handle the current drag operation.To incorporate a new
DragSourceContext
subclass, subclassDragSource
and override this method.If
dragImage
isnull
, no image is used to represent the drag over feedback for this drag operation, butNullPointerException
is not thrown.If
dsl
isnull
, no drag source listener is registered with the createdDragSourceContext
, butNullPointerException
is not thrown.- Parameters:
dscp
- TheDragSourceContextPeer
for this dragdgl
- TheDragGestureEvent
that triggered the dragdragCursor
- The initialCursor
for this drag operation ornull
for the default cursor handling; see DragSourceContext class for more details on the cursor handling mechanism during drag and dropdragImage
- TheImage
to drag ornull
imageOffset
- The offset of theImage
origin from the hotspot of the cursor at the instant of the triggert
- The subject data of the dragdsl
- TheDragSourceListener
- Returns:
- the
DragSourceContext
- Throws:
NullPointerException
- ifdscp
isnull
NullPointerException
- ifdgl
isnull
NullPointerException
- ifdragImage
is notnull
andimageOffset
isnull
NullPointerException
- ift
isnull
IllegalArgumentException
- if theComponent
associated with the trigger event isnull
.IllegalArgumentException
- if theDragSource
for the trigger event isnull
.IllegalArgumentException
- if the drag action for the trigger event isDnDConstants.ACTION_NONE
.IllegalArgumentException
- if the source actions for theDragGestureRecognizer
associated with the trigger event are equal toDnDConstants.ACTION_NONE
.
-
getFlavorMap
public FlavorMap getFlavorMap()
This method returns theFlavorMap
for thisDragSource
.- Returns:
- the
FlavorMap
for thisDragSource
-
createDragGestureRecognizer
public <T extends DragGestureRecognizer> T createDragGestureRecognizer(Class<T> recognizerAbstractClass, Component c, int actions, DragGestureListener dgl)
Creates a newDragGestureRecognizer
that implements the specified abstract subclass ofDragGestureRecognizer
, and sets the specifiedComponent
andDragGestureListener
on the newly created object.- Parameters:
recognizerAbstractClass
- the requested abstract typeactions
- the permitted source drag actionsc
- theComponent
targetdgl
- theDragGestureListener
to notify- Returns:
- the new
DragGestureRecognizer
ornull
if theToolkit.createDragGestureRecognizer
method has no implementation available for the requestedDragGestureRecognizer
subclass and returnsnull
-
createDefaultDragGestureRecognizer
public DragGestureRecognizer createDefaultDragGestureRecognizer(Component c, int actions, DragGestureListener dgl)
Creates a newDragGestureRecognizer
that implements the default abstract subclass ofDragGestureRecognizer
for thisDragSource
, and sets the specifiedComponent
andDragGestureListener
on the newly created object. For thisDragSource
the default isMouseDragGestureRecognizer
.- Parameters:
c
- theComponent
target for the recognizeractions
- the permitted source actionsdgl
- theDragGestureListener
to notify- Returns:
- the new
DragGestureRecognizer
ornull
if theToolkit.createDragGestureRecognizer
method has no implementation available for the requestedDragGestureRecognizer
subclass and returnsnull
-
addDragSourceListener
public void addDragSourceListener(DragSourceListener dsl)
Adds the specifiedDragSourceListener
to thisDragSource
to receive drag source events during drag operations intiated with thisDragSource
. If anull
listener is specified, no action is taken and no exception is thrown.- Parameters:
dsl
- theDragSourceListener
to add- Since:
- 1.4
- See Also:
removeDragSourceListener(java.awt.dnd.DragSourceListener)
,getDragSourceListeners()
-
removeDragSourceListener
public void removeDragSourceListener(DragSourceListener dsl)
Removes the specifiedDragSourceListener
from thisDragSource
. If anull
listener is specified, no action is taken and no exception is thrown. If the listener specified by the argument was not previously added to thisDragSource
, no action is taken and no exception is thrown.- Parameters:
dsl
- theDragSourceListener
to remove- Since:
- 1.4
- See Also:
addDragSourceListener(java.awt.dnd.DragSourceListener)
,getDragSourceListeners()
-
getDragSourceListeners
public DragSourceListener[] getDragSourceListeners()
Gets all theDragSourceListener
s registered with thisDragSource
.- Returns:
- all of this
DragSource
'sDragSourceListener
s or an empty array if no such listeners are currently registered - Since:
- 1.4
- See Also:
addDragSourceListener(java.awt.dnd.DragSourceListener)
,removeDragSourceListener(java.awt.dnd.DragSourceListener)
-
addDragSourceMotionListener
public void addDragSourceMotionListener(DragSourceMotionListener dsml)
Adds the specifiedDragSourceMotionListener
to thisDragSource
to receive drag motion events during drag operations intiated with thisDragSource
. If anull
listener is specified, no action is taken and no exception is thrown.- Parameters:
dsml
- theDragSourceMotionListener
to add- Since:
- 1.4
- See Also:
removeDragSourceMotionListener(java.awt.dnd.DragSourceMotionListener)
,getDragSourceMotionListeners()
-
removeDragSourceMotionListener
public void removeDragSourceMotionListener(DragSourceMotionListener dsml)
Removes the specifiedDragSourceMotionListener
from thisDragSource
. If anull
listener is specified, no action is taken and no exception is thrown. If the listener specified by the argument was not previously added to thisDragSource
, no action is taken and no exception is thrown.- Parameters:
dsml
- theDragSourceMotionListener
to remove- Since:
- 1.4
- See Also:
addDragSourceMotionListener(java.awt.dnd.DragSourceMotionListener)
,getDragSourceMotionListeners()
-
getDragSourceMotionListeners
public DragSourceMotionListener[] getDragSourceMotionListeners()
Gets all of theDragSourceMotionListener
s registered with thisDragSource
.- Returns:
- all of this
DragSource
'sDragSourceMotionListener
s or an empty array if no such listeners are currently registered - Since:
- 1.4
- See Also:
addDragSourceMotionListener(java.awt.dnd.DragSourceMotionListener)
,removeDragSourceMotionListener(java.awt.dnd.DragSourceMotionListener)
-
getListeners
public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Gets all the objects currently registered asFooListener
s upon thisDragSource
.FooListener
s are registered using theaddFooListener
method.- Parameters:
listenerType
- the type of listeners requested; this parameter should specify an interface that descends fromjava.util.EventListener
- Returns:
- an array of all objects registered as
FooListener
s on thisDragSource
, or an empty array if no such listeners have been added - Throws:
- ifClassCastException
listenerType
doesn't specify a class or interface that implementsjava.util.EventListener
- Since:
- 1.4
- See Also:
getDragSourceListeners()
,getDragSourceMotionListeners()
-
getDragThreshold
public static int getDragThreshold()
Returns the drag gesture motion threshold. The drag gesture motion threshold defines the recommended behavior forMouseDragGestureRecognizer
s.If the system property
awt.dnd.drag.threshold
is set to a positive integer, this method returns the value of the system property; otherwise if a pertinent desktop property is available and supported by the implementation of the Java platform, this method returns the value of that property; otherwise this method returns some default value. The pertinent desktop property can be queried usingjava.awt.Toolkit.getDesktopProperty("DnD.gestureMotionThreshold")
.- Returns:
- the drag gesture motion threshold
- Since:
- 1.5
- See Also:
MouseDragGestureRecognizer
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-java/awt/dnd/dragsource.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.