OpenJDK 27 · java.awt.dnd.DragSourceContext · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected static final int	CHANGED An `int` used by updateCurrentCursor() indicating that the user operation has changed.
private Cursor	cursor The current drag cursor.
protected static final int	DEFAULT An `int` used by updateCurrentCursor() indicating that the `Cursor` should change to the default (no drop) `Cursor`.
private static Transferable	emptyTransferable
protected static final int	ENTER An `int` used by updateCurrentCursor() indicating that the `Cursor` has entered a `DropTarget`.
private transient DragSourceListener	listener
protected static final int	OVER An `int` used by updateCurrentCursor() indicating that the `Cursor` is over a `DropTarget`.
private final transient DragSourceContextPeer	peer
private static final long	serialVersionUID Use serialVersionUID from JDK 1.4 for interoperability.
private int	sourceActions A bitwise mask of `DnDConstants` that represents the set of drop actions supported by the drag source for the drag operation associated with this `DragSourceContext.`
private transient Transferable	transferable
private DragGestureEvent	trigger The event which triggered the start of the drag.
private boolean	useCustomCursor `true` if the custom drag cursor is used instead of the default one.

Access	Constructor and Description
public	DragSourceContext(DragGestureEvent the triggering event trigger, Cursor the initial `Cursor` for this drag operation or `null` for the default cursor handling; see class level documentation for more details on the cursor handling mechanism during drag and drop dragCursor, Image the `Image` to drag (or `null`) dragImage, Point the offset of the image origin from the hotspot at the instant of the triggering event offset, Transferable the `Transferable` t, DragSourceListener the `DragSourceListener` dsl) Called from `DragSource`, this constructor creates a new `DragSourceContext` given the `DragSourceContextPeer` for this Drag, the `DragGestureEvent` that triggered the Drag, the initial `Cursor` to use for the Drag, an (optional) `Image` to display while the Drag is taking place, the offset of the `Image` origin from the hotspot at the instant of the triggering event, the `Transferable` subject data, and the `DragSourceListener` to use during the Drag and Drop operation.

Method Summary

Modifier and Type	Method and Description
public synchronized void	addDragSourceListener(DragSourceListener the `DragSourceListener` to add. Note that while `null` is not prohibited, it is not acceptable as a parameter. dsl) Add a `DragSourceListener` to this `DragSourceContext` if one has not already been added.
public void	dragDropEnd(DragSourceDropEvent the `DragSourceDropEvent` dsde) Implements java.awt.dnd.DragSourceListener.dragDropEnd. Calls `dragDropEnd` on the `DragSourceListener`s registered with this `DragSourceContext` and with the associated `DragSource`, and passes them the specified `DragSourceDropEvent`.
public void	dragEnter(DragSourceDragEvent the `DragSourceDragEvent` dsde) Implements java.awt.dnd.DragSourceListener.dragEnter. Calls `dragEnter` on the `DragSourceListener`s registered with this `DragSourceContext` and with the associated `DragSource`, and passes them the specified `DragSourceDragEvent`.
public void	dragExit(DragSourceEvent the `DragSourceEvent` dse) Implements java.awt.dnd.DragSourceListener.dragExit. Calls `dragExit` on the `DragSourceListener`s registered with this `DragSourceContext` and with the associated `DragSource`, and passes them the specified `DragSourceEvent`.
public void	dragMouseMoved(DragSourceDragEvent the `DragSourceDragEvent` dsde) Implements java.awt.dnd.DragSourceMotionListener.dragMouseMoved. Calls `dragMouseMoved` on the `DragSourceMotionListener`s registered with the `DragSource` associated with this `DragSourceContext`, and them passes the specified `DragSourceDragEvent`.
public void	dragOver(DragSourceDragEvent the `DragSourceDragEvent` dsde) Implements java.awt.dnd.DragSourceListener.dragOver. Calls `dragOver` on the `DragSourceListener`s registered with this `DragSourceContext` and with the associated `DragSource`, and passes them the specified `DragSourceDragEvent`.
public void	dropActionChanged(DragSourceDragEvent the `DragSourceDragEvent` dsde) Implements java.awt.dnd.DragSourceListener.dropActionChanged. Calls `dropActionChanged` on the `DragSourceListener`s registered with this `DragSourceContext` and with the associated `DragSource`, and passes them the specified `DragSourceDragEvent`.
public Component	Returns: the `Component` that started the drag getComponent() Returns the `Component` associated with this `DragSourceContext`.
public Cursor	Returns: the current custom drag `Cursor`, if it was set otherwise returns `null`. getCursor() Returns the current custom drag `Cursor`.
public DragSource	Returns: the `DragSource` that instantiated this `DragSourceContext` getDragSource() Returns the `DragSource` that instantiated this `DragSourceContext`.
public int	Returns: the drop actions supported by the drag source getSourceActions() Returns a bitwise mask of `DnDConstants` that represent the set of drop actions supported by the drag source for the drag operation associated with this `DragSourceContext`.
public Transferable	Returns: the `Transferable` getTransferable() Returns the `Transferable` associated with this `DragSourceContext`.
public DragGestureEvent	Returns: the Event that triggered the drag getTrigger() Returns the `DragGestureEvent` that initially triggered the drag.
private void	readObject(ObjectInputStream the `ObjectInputStream` to read s) Deserializes this `DragSourceContext`.
public synchronized void	removeDragSourceListener(DragSourceListener the `DragSourceListener` to remove; note that while `null` is not prohibited, it is not acceptable as a parameter dsl) Removes the specified `DragSourceListener` from this `DragSourceContext`.
public synchronized void	setCursor(Cursor the initial `Cursor` for this drag operation, or `null` for the default cursor handling; see class level documentation for more details on the cursor handling during drag and drop c) Sets the custom cursor for this drag operation to the specified `Cursor`.
private void	setCursorImpl(Cursor c)
public void	transferablesFlavorsChanged() Notifies the peer that the `Transferable`'s `DataFlavor`s have changed.
protected synchronized void	updateCurrentCursor(int the actions supported by the drag source sourceAct, int the drop target action targetAct, int one of the fields `DEFAULT`, `ENTER`, `OVER`, `CHANGED` status) If the default drag cursor behavior is active, this method sets the default drag cursor for the specified actions supported by the drag source, the drop target action, and status, otherwise this method does nothing.
private void	writeObject(ObjectOutputStream the `ObjectOutputStream` to write s) Serializes this `DragSourceContext`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CHANGED	back to summary
protected static final int CHANGED An `int` used by updateCurrentCursor() indicating that the user operation has changed.

cursor	back to summary
private Cursor cursor The current drag cursor.

DEFAULT	back to summary
protected static final int DEFAULT An `int` used by updateCurrentCursor() indicating that the `Cursor` should change to the default (no drop) `Cursor`.

emptyTransferable	back to summary
private static Transferable emptyTransferable

ENTER	back to summary
protected static final int ENTER An `int` used by updateCurrentCursor() indicating that the `Cursor` has entered a `DropTarget`.

listener	back to summary
private transient DragSourceListener listener

OVER	back to summary
protected static final int OVER An `int` used by updateCurrentCursor() indicating that the `Cursor` is over a `DropTarget`.

peer	back to summary
private final transient DragSourceContextPeer peer

serialVersionUID	back to summary
private static final long serialVersionUID Use serialVersionUID from JDK 1.4 for interoperability. Annotations @Serial

sourceActions	back to summary
private int sourceActions A bitwise mask of `DnDConstants` that represents the set of drop actions supported by the drag source for the drag operation associated with this `DragSourceContext.`

transferable	back to summary
private transient Transferable transferable

trigger	back to summary
private DragGestureEvent trigger The event which triggered the start of the drag.

useCustomCursor	back to summary
private boolean useCustomCursor `true` if the custom drag cursor is used instead of the default one.

Constructor Detail

DragSourceContext back to summary

DragSourceContext	back to summary
public DragSourceContext(DragGestureEvent trigger, Cursor dragCursor, Image dragImage, Point offset, Transferable t, DragSourceListener dsl) Called from `DragSource`, this constructor creates a new `DragSourceContext` given the `DragSourceContextPeer` for this Drag, the `DragGestureEvent` that triggered the Drag, the initial `Cursor` to use for the Drag, an (optional) `Image` to display while the Drag is taking place, the offset of the `Image` origin from the hotspot at the instant of the triggering event, the `Transferable` subject data, and the `DragSourceListener` to use during the Drag and Drop operation. If `DragSourceContextPeer` is `null` `NullPointerException` is thrown. If `DragGestureEvent` is `null` `NullPointerException` is thrown. If `Cursor` is `null` no exception is thrown and the default drag cursor behavior is activated for this drag operation. If `Image` is `null` no exception is thrown. If `Image` is not `null` and the offset is `null NullPointerException` is thrown. If `Transferable` is `null` `NullPointerException` is thrown. If `DragSourceListener` is `null` no exception is thrown. Parameters trigger:DragGestureEvent the triggering event dragCursor:Cursor the initial `Cursor` for this drag operation or `null` for the default cursor handling; see class level documentation for more details on the cursor handling mechanism during drag and drop dragImage:Image the `Image` to drag (or `null`) offset:Point the offset of the image origin from the hotspot at the instant of the triggering event t:Transferable the `Transferable` dsl:DragSourceListener the `DragSourceListener` Exceptions IllegalArgumentException: if the `Component` associated with the trigger event is `null`. if the `DragSource` for the trigger event is `null`. if the drag action for the trigger event is `DnDConstants.ACTION_NONE`. if the source actions for the `DragGestureRecognizer` associated with the trigger event are equal to `DnDConstants.ACTION_NONE`. NullPointerException: if dscp, trigger, or t are null, or if dragImage is non-null and offset is null

public DragSourceContext(DragGestureEvent trigger, Cursor dragCursor, Image dragImage, Point offset, Transferable t, DragSourceListener dsl)

Called from DragSource, this constructor creates a new DragSourceContext given the DragSourceContextPeer for this Drag, the DragGestureEvent that triggered the Drag, the initial Cursor to use for the Drag, an (optional) Image to display while the Drag is taking place, the offset of the Image origin from the hotspot at the instant of the triggering event, the Transferable subject data, and the DragSourceListener to use during the Drag and Drop operation.
If DragSourceContextPeer is null NullPointerException is thrown.
If DragGestureEvent is null NullPointerException is thrown.
If Cursor is null no exception is thrown and the default drag cursor behavior is activated for this drag operation.
If Image is null no exception is thrown.
If Image is not null and the offset is null NullPointerException is thrown.
If Transferable is null NullPointerException is thrown.
If DragSourceListener is null no exception is thrown.

Parameters

trigger:DragGestureEvent: the triggering event
dragCursor:Cursor: the initial Cursor for this drag operation or null for the default cursor handling; see class level documentation for more details on the cursor handling mechanism during drag and drop
dragImage:Image: the Image to drag (or null)
offset:Point: the offset of the image origin from the hotspot at the instant of the triggering event
t:Transferable: the Transferable
dsl:DragSourceListener: the DragSourceListener

Exceptions

IllegalArgumentException:

if the Component associated with the trigger event is null.
if the DragSource for the trigger event is null.
if the drag action for the trigger event is DnDConstants.ACTION_NONE.
if the source actions for the DragGestureRecognizer associated with the trigger event are equal to DnDConstants.ACTION_NONE.

NullPointerException:

if dscp, trigger, or t are null, or if dragImage is non-null and offset is null

Method Detail

addDragSourceListener back to summary

addDragSourceListener	back to summary
public synchronized void addDragSourceListener(DragSourceListener dsl) throws TooManyListenersException Add a `DragSourceListener` to this `DragSourceContext` if one has not already been added. If a `DragSourceListener` already exists, this method throws a `TooManyListenersException`. Parameters dsl:DragSourceListener the `DragSourceListener` to add. Note that while `null` is not prohibited, it is not acceptable as a parameter. Exceptions TooManyListenersException: if a `DragSourceListener` has already been added

public synchronized void addDragSourceListener(DragSourceListener dsl) throws TooManyListenersException

Add a DragSourceListener to this DragSourceContext if one has not already been added. If a DragSourceListener already exists, this method throws a TooManyListenersException.

Parameters

dsl:DragSourceListener: the DragSourceListener to add. Note that while null is not prohibited, it is not acceptable as a parameter.

Exceptions

TooManyListenersException:: if a DragSourceListener has already been added

dragDropEnd back to summary

dragDropEnd	back to summary
public void dragDropEnd(DragSourceDropEvent dsde) Implements java.awt.dnd.DragSourceListener.dragDropEnd. Calls `dragDropEnd` on the `DragSourceListener`s registered with this `DragSourceContext` and with the associated `DragSource`, and passes them the specified `DragSourceDropEvent`. Parameters dsde:DragSourceDropEvent the `DragSourceDropEvent`

public void dragDropEnd(DragSourceDropEvent dsde)

Implements java.awt.dnd.DragSourceListener.dragDropEnd.

Calls dragDropEnd on the DragSourceListeners registered with this DragSourceContext and with the associated DragSource, and passes them the specified DragSourceDropEvent.

Parameters

dsde:DragSourceDropEvent: the DragSourceDropEvent

dragEnter back to summary

dragEnter	back to summary
public void dragEnter(DragSourceDragEvent dsde) Implements java.awt.dnd.DragSourceListener.dragEnter. Calls `dragEnter` on the `DragSourceListener`s registered with this `DragSourceContext` and with the associated `DragSource`, and passes them the specified `DragSourceDragEvent`. Parameters dsde:DragSourceDragEvent the `DragSourceDragEvent`

public void dragEnter(DragSourceDragEvent dsde)

Implements java.awt.dnd.DragSourceListener.dragEnter.

Calls dragEnter on the DragSourceListeners registered with this DragSourceContext and with the associated DragSource, and passes them the specified DragSourceDragEvent.

Parameters

dsde:DragSourceDragEvent: the DragSourceDragEvent

dragExit back to summary

dragExit	back to summary
public void dragExit(DragSourceEvent dse) Implements java.awt.dnd.DragSourceListener.dragExit. Calls `dragExit` on the `DragSourceListener`s registered with this `DragSourceContext` and with the associated `DragSource`, and passes them the specified `DragSourceEvent`. Parameters dse:DragSourceEvent the `DragSourceEvent`

public void dragExit(DragSourceEvent dse)

Implements java.awt.dnd.DragSourceListener.dragExit.

Calls dragExit on the DragSourceListeners registered with this DragSourceContext and with the associated DragSource, and passes them the specified DragSourceEvent.

Parameters

dse:DragSourceEvent: the DragSourceEvent

dragMouseMoved back to summary

dragMouseMoved	back to summary
public void dragMouseMoved(DragSourceDragEvent dsde) Implements java.awt.dnd.DragSourceMotionListener.dragMouseMoved. Calls `dragMouseMoved` on the `DragSourceMotionListener`s registered with the `DragSource` associated with this `DragSourceContext`, and them passes the specified `DragSourceDragEvent`. Parameters dsde:DragSourceDragEvent the `DragSourceDragEvent` Since 1.4

public void dragMouseMoved(DragSourceDragEvent dsde)

Implements java.awt.dnd.DragSourceMotionListener.dragMouseMoved.

Calls dragMouseMoved on the DragSourceMotionListeners registered with the DragSource associated with this DragSourceContext, and them passes the specified DragSourceDragEvent.

Parameters

dsde:DragSourceDragEvent: the DragSourceDragEvent

Since

1.4

dragOver back to summary

dragOver	back to summary
public void dragOver(DragSourceDragEvent dsde) Implements java.awt.dnd.DragSourceListener.dragOver. Calls `dragOver` on the `DragSourceListener`s registered with this `DragSourceContext` and with the associated `DragSource`, and passes them the specified `DragSourceDragEvent`. Parameters dsde:DragSourceDragEvent the `DragSourceDragEvent`

public void dragOver(DragSourceDragEvent dsde)

Implements java.awt.dnd.DragSourceListener.dragOver.

Calls dragOver on the DragSourceListeners registered with this DragSourceContext and with the associated DragSource, and passes them the specified DragSourceDragEvent.

Parameters

dsde:DragSourceDragEvent: the DragSourceDragEvent

dropActionChanged back to summary

dropActionChanged	back to summary
public void dropActionChanged(DragSourceDragEvent dsde) Implements java.awt.dnd.DragSourceListener.dropActionChanged. Calls `dropActionChanged` on the `DragSourceListener`s registered with this `DragSourceContext` and with the associated `DragSource`, and passes them the specified `DragSourceDragEvent`. Parameters dsde:DragSourceDragEvent the `DragSourceDragEvent`

public void dropActionChanged(DragSourceDragEvent dsde)

Implements java.awt.dnd.DragSourceListener.dropActionChanged.

Calls dropActionChanged on the DragSourceListeners registered with this DragSourceContext and with the associated DragSource, and passes them the specified DragSourceDragEvent.

Parameters

dsde:DragSourceDragEvent: the DragSourceDragEvent

getComponent back to summary

getComponent	back to summary
public Component getComponent() Returns the `Component` associated with this `DragSourceContext`. Returns:Component the `Component` that started the drag

public Component getComponent()

Returns the Component associated with this DragSourceContext.

Returns:Component: the Component that started the drag

getCursor back to summary

getCursor	back to summary
public Cursor getCursor() Returns the current custom drag `Cursor`. Returns:Cursor the current custom drag `Cursor`, if it was set otherwise returns `null`. See Also `setCursor`

public Cursor getCursor()

Returns the current custom drag Cursor.

Returns:Cursor: the current custom drag Cursor, if it was set otherwise returns null.
See Also: setCursor

getDragSource back to summary

getDragSource	back to summary
public DragSource getDragSource() Returns the `DragSource` that instantiated this `DragSourceContext`. Returns:DragSource the `DragSource` that instantiated this `DragSourceContext`

public DragSource getDragSource()

Returns the DragSource that instantiated this DragSourceContext.

Returns:DragSource: the DragSource that instantiated this DragSourceContext

getSourceActions back to summary

getSourceActions	back to summary
public int getSourceActions() Returns a bitwise mask of `DnDConstants` that represent the set of drop actions supported by the drag source for the drag operation associated with this `DragSourceContext`. Returns:int the drop actions supported by the drag source

public int getSourceActions()

Returns a bitwise mask of DnDConstants that represent the set of drop actions supported by the drag source for the drag operation associated with this DragSourceContext.

Returns:int: the drop actions supported by the drag source

getTransferable back to summary

getTransferable	back to summary
public Transferable getTransferable() Returns the `Transferable` associated with this `DragSourceContext`. Returns:Transferable the `Transferable`

public Transferable getTransferable()

Returns the Transferable associated with this DragSourceContext.

Returns:Transferable: the Transferable

getTrigger back to summary

getTrigger	back to summary
public DragGestureEvent getTrigger() Returns the `DragGestureEvent` that initially triggered the drag. Returns:DragGestureEvent the Event that triggered the drag

public DragGestureEvent getTrigger()

Returns the DragGestureEvent that initially triggered the drag.

Returns:DragGestureEvent: the Event that triggered the drag

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream s) throws ClassNotFoundException, IOException Deserializes this `DragSourceContext`. This method first performs default deserialization for all non-`transient` fields. This object's `Transferable` and `DragSourceListener` are then deserialized as well by using the next two objects in the stream. If the resulting `Transferable` is `null`, this object's `Transferable` is set to a dummy `Transferable` which supports no `DataFlavor`s. Parameters s:ObjectInputStream the `ObjectInputStream` to read Annotations @Serial Exceptions ClassNotFoundException: if the class of a serialized object could not be found IOException: if an I/O error occurs Since 1.4

private void readObject(ObjectInputStream s) throws ClassNotFoundException, IOException

Deserializes this DragSourceContext. This method first performs default deserialization for all non-transient fields. This object's Transferable and DragSourceListener are then deserialized as well by using the next two objects in the stream. If the resulting Transferable is null, this object's Transferable is set to a dummy Transferable which supports no DataFlavors.

Parameters

s:ObjectInputStream: the ObjectInputStream to read

Annotations

@Serial

Exceptions

ClassNotFoundException:: if the class of a serialized object could not be found
IOException:: if an I/O error occurs

Since

1.4

removeDragSourceListener back to summary

removeDragSourceListener	back to summary
public synchronized void removeDragSourceListener(DragSourceListener dsl) Removes the specified `DragSourceListener` from this `DragSourceContext`. Parameters dsl:DragSourceListener the `DragSourceListener` to remove; note that while `null` is not prohibited, it is not acceptable as a parameter

public synchronized void removeDragSourceListener(DragSourceListener dsl)

Removes the specified DragSourceListener from this DragSourceContext.

Parameters

dsl:DragSourceListener: the DragSourceListener to remove; note that while null is not prohibited, it is not acceptable as a parameter

setCursor back to summary

setCursor	back to summary
public synchronized void setCursor(Cursor c) Sets the custom cursor for this drag operation to the specified `Cursor`. If the specified `Cursor` is `null`, the default drag cursor behavior is activated for this drag operation, otherwise it is deactivated. Parameters c:Cursor the initial `Cursor` for this drag operation, or `null` for the default cursor handling; see class level documentation for more details on the cursor handling during drag and drop

public synchronized void setCursor(Cursor c)

Sets the custom cursor for this drag operation to the specified Cursor. If the specified Cursor is null, the default drag cursor behavior is activated for this drag operation, otherwise it is deactivated.

Parameters

c:Cursor: the initial Cursor for this drag operation, or null for the default cursor handling; see class level documentation for more details on the cursor handling during drag and drop

setCursorImpl	back to summary
private void setCursorImpl(Cursor c)

transferablesFlavorsChanged	back to summary
public void transferablesFlavorsChanged() Notifies the peer that the `Transferable`'s `DataFlavor`s have changed.

updateCurrentCursor back to summary

updateCurrentCursor	back to summary
protected synchronized void updateCurrentCursor(int sourceAct, int targetAct, int status) If the default drag cursor behavior is active, this method sets the default drag cursor for the specified actions supported by the drag source, the drop target action, and status, otherwise this method does nothing. Parameters sourceAct:int the actions supported by the drag source targetAct:int the drop target action status:int one of the fields `DEFAULT`, `ENTER`, `OVER`, `CHANGED` Annotations @SuppressWarnings:fallthrough

protected synchronized void updateCurrentCursor(int sourceAct, int targetAct, int status)

If the default drag cursor behavior is active, this method sets the default drag cursor for the specified actions supported by the drag source, the drop target action, and status, otherwise this method does nothing.

Parameters

sourceAct:int: the actions supported by the drag source
targetAct:int: the drop target action
status:int: one of the fields DEFAULT, ENTER, OVER, CHANGED

Annotations

@SuppressWarnings:fallthrough

writeObject back to summary

writeObject	back to summary
private void writeObject(ObjectOutputStream s) throws IOException Serializes this `DragSourceContext`. This method first performs default serialization. Next, this object's `Transferable` is written out if and only if it can be serialized. If not, `null` is written instead. In this case, a `DragSourceContext` created from the resulting deserialized stream will contain a dummy `Transferable` which supports no `DataFlavor`s. Finally, this object's `DragSourceListener` is written out if and only if it can be serialized. If not, `null` is written instead. Parameters s:ObjectOutputStream the `ObjectOutputStream` to write Annotations @Serial Exceptions IOException: if an I/O error occurs Since 1.4 Serial data The default serializable fields, in alphabetical order, followed by either a `Transferable` instance, or `null`, followed by either a `DragSourceListener` instance, or `null`.

private void writeObject(ObjectOutputStream s) throws IOException

Serializes this DragSourceContext. This method first performs default serialization. Next, this object's Transferable is written out if and only if it can be serialized. If not, null is written instead. In this case, a DragSourceContext created from the resulting deserialized stream will contain a dummy Transferable which supports no DataFlavors. Finally, this object's DragSourceListener is written out if and only if it can be serialized. If not, null is written instead.

Parameters

s:ObjectOutputStream: the ObjectOutputStream to write

Annotations

@Serial

Exceptions

IOException:: if an I/O error occurs

Since

1.4

Serial data

The default serializable fields, in alphabetical order, followed by either a Transferable instance, or null, followed by either a DragSourceListener instance, or null.

public Class DragSourceContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail