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

This class is the base class for DragSourceDragEvent and DragSourceDropEvent.

DragSourceEvents are generated whenever the drag enters, moves over, or exits a drop site, when the drop action changes, and when the drag ends. The location for the generated DragSourceEvent specifies the mouse cursor location in screen coordinates at the moment this event occurred.

In a multi-screen environment without a virtual device, the cursor location is specified in the coordinate system of the initiator GraphicsConfiguration. The initiator GraphicsConfiguration is the GraphicsConfiguration of the Component on which the drag gesture for the current drag operation was recognized. If the cursor location is outside the bounds of the initiator GraphicsConfiguration, the reported coordinates are clipped to fit within the bounds of that GraphicsConfiguration.

In a multi-screen environment with a virtual device, the location is specified in the corresponding virtual coordinate system. If the cursor location is outside the bounds of the virtual device the reported coordinates are clipped to fit within the bounds of the virtual device.

Field Summary

Modifier and Type	Field and Description
private final boolean	locationSpecified The `boolean` indicating whether the cursor location is specified for this event.
private static final long	serialVersionUID Hides java.util.EventObject.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability.
private final int	x The horizontal coordinate for the cursor location at the moment this event occurred if the cursor location is specified for this event; otherwise zero.
private final int	y The vertical coordinate for the cursor location at the moment this event occurred if the cursor location is specified for this event; otherwise zero.

Inherited from java.util.EventObject:: source

Constructor Summary

Access	Constructor and Description
public	DragSourceEvent(DragSourceContext the `DragSourceContext` dsc) Construct a `DragSourceEvent` given a specified `DragSourceContext`.
public	DragSourceEvent(DragSourceContext the `DragSourceContext` dsc, int the horizontal coordinate for the cursor location x, int the vertical coordinate for the cursor location y) Construct a `DragSourceEvent` given a specified `DragSourceContext`, and coordinates of the cursor location.

Method Summary

Modifier and Type	Method and Description
public DragSourceContext	Returns: the `DragSourceContext` that originated the event getDragSourceContext() This method returns the `DragSourceContext` that originated the event.
public Point	Returns: the `Point` indicating the cursor location or `null` if the cursor location is not specified getLocation() This method returns a `Point` indicating the cursor location in screen coordinates at the moment this event occurred, or `null` if the cursor location is not specified for this event.
public int	Returns: an integer indicating the horizontal coordinate of the cursor location or zero if the cursor location is not specified getX() This method returns the horizontal coordinate of the cursor location in screen coordinates at the moment this event occurred, or zero if the cursor location is not specified for this event.
public int	Returns: an integer indicating the vertical coordinate of the cursor location or zero if the cursor location is not specified getY() This method returns the vertical coordinate of the cursor location in screen coordinates at the moment this event occurred, or zero if the cursor location is not specified for this event.

Inherited from java.util.EventObject:: getSource toString

Field Detail

locationSpecified	back to summary
private final boolean locationSpecified The `boolean` indicating whether the cursor location is specified for this event.

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

serialVersionUID

back to summary

private static final long serialVersionUID

Hides java.util.EventObject.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations

@Serial

x	back to summary
private final int x The horizontal coordinate for the cursor location at the moment this event occurred if the cursor location is specified for this event; otherwise zero.

y	back to summary
private final int y The vertical coordinate for the cursor location at the moment this event occurred if the cursor location is specified for this event; otherwise zero.

Constructor Detail

DragSourceEvent back to summary

DragSourceEvent	back to summary
public DragSourceEvent(DragSourceContext dsc) Construct a `DragSourceEvent` given a specified `DragSourceContext`. The coordinates for this `DragSourceEvent` are not specified, so `getLocation` will return `null` for this event. Parameters dsc:DragSourceContext the `DragSourceContext` Exceptions IllegalArgumentException: if `dsc` is `null`. See Also `getLocation`

public DragSourceEvent(DragSourceContext dsc)

Construct a DragSourceEvent given a specified DragSourceContext. The coordinates for this DragSourceEvent are not specified, so getLocation will return null for this event.

Parameters

dsc:DragSourceContext: the DragSourceContext

Exceptions

IllegalArgumentException:: if dsc is null.

See Also

getLocation

DragSourceEvent back to summary

DragSourceEvent	back to summary
public DragSourceEvent(DragSourceContext dsc, int x, int y) Construct a `DragSourceEvent` given a specified `DragSourceContext`, and coordinates of the cursor location. Parameters dsc:DragSourceContext the `DragSourceContext` x:int the horizontal coordinate for the cursor location y:int the vertical coordinate for the cursor location Exceptions IllegalArgumentException: if `dsc` is `null`. Since 1.4

public DragSourceEvent(DragSourceContext dsc, int x, int y)

Construct a DragSourceEvent given a specified DragSourceContext, and coordinates of the cursor location.

Parameters

dsc:DragSourceContext: the DragSourceContext
x:int: the horizontal coordinate for the cursor location
y:int: the vertical coordinate for the cursor location

Exceptions

IllegalArgumentException:: if dsc is null.

Since

1.4

Method Detail

getDragSourceContext back to summary

getDragSourceContext	back to summary
public DragSourceContext getDragSourceContext() This method returns the `DragSourceContext` that originated the event. Returns:DragSourceContext the `DragSourceContext` that originated the event

public DragSourceContext getDragSourceContext()

This method returns the DragSourceContext that originated the event.

Returns:DragSourceContext: the DragSourceContext that originated the event

getLocation back to summary

getLocation	back to summary
public Point getLocation() This method returns a `Point` indicating the cursor location in screen coordinates at the moment this event occurred, or `null` if the cursor location is not specified for this event. Returns:Point the `Point` indicating the cursor location or `null` if the cursor location is not specified Since 1.4

public Point getLocation()

This method returns a Point indicating the cursor location in screen coordinates at the moment this event occurred, or null if the cursor location is not specified for this event.

Returns:Point: the Point indicating the cursor location or null if the cursor location is not specified
Since: 1.4

getX	back to summary
public int getX() This method returns the horizontal coordinate of the cursor location in screen coordinates at the moment this event occurred, or zero if the cursor location is not specified for this event. Returns:int an integer indicating the horizontal coordinate of the cursor location or zero if the cursor location is not specified Since 1.4

getX

back to summary

public int getX()

This method returns the horizontal coordinate of the cursor location in screen coordinates at the moment this event occurred, or zero if the cursor location is not specified for this event.

Returns:int: an integer indicating the horizontal coordinate of the cursor location or zero if the cursor location is not specified
Since: 1.4

getY	back to summary
public int getY() This method returns the vertical coordinate of the cursor location in screen coordinates at the moment this event occurred, or zero if the cursor location is not specified for this event. Returns:int an integer indicating the vertical coordinate of the cursor location or zero if the cursor location is not specified Since 1.4

getY

back to summary

public int getY()

This method returns the vertical coordinate of the cursor location in screen coordinates at the moment this event occurred, or zero if the cursor location is not specified for this event.

Returns:int: an integer indicating the vertical coordinate of the cursor location or zero if the cursor location is not specified
Since: 1.4

public Class DragSourceEvent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail