FileDocCategorySizeDatePackage
DragSourceEvent.javaAPI DocJava SE 5 API5512Fri Aug 26 14:56:48 BST 2005java.awt.dnd

DragSourceEvent

public class DragSourceEvent extends EventObject
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 occured.

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.

since
1.2

Fields Summary
private static final long
serialVersionUID
private final boolean
locationSpecified
The boolean indicating whether the cursor location is specified for this event.
private final int
x
The horizontal coordinate for the cursor location at the moment this event occured 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 occured if the cursor location is specified for this event; otherwise zero.
Constructors 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.

param
dsc the DragSourceContext
throws
IllegalArgumentException if dsc is null.
see
#getLocation


                                              

        
        super(dsc); 
        locationSpecified = false;
        this.x = 0;
        this.y = 0;
public DragSourceEvent(DragSourceContext dsc, int x, int y)
Construct a DragSourceEvent given a specified DragSourceContext, and coordinates of the cursor location.

param
dsc the DragSourceContext
param
x the horizontal coordinate for the cursor location
param
y the vertical coordinate for the cursor location
throws
IllegalArgumentException if dsc is null.
since
1.4

 
        super(dsc);
        locationSpecified = true;
        this.x = x;
        this.y = y;
Methods Summary
public java.awt.dnd.DragSourceContextgetDragSourceContext()
This method returns the DragSourceContext that originated the event.

return
the DragSourceContext that originated the event

	return (DragSourceContext)getSource();
public java.awt.PointgetLocation()
This method returns a Point indicating the cursor location in screen coordinates at the moment this event occured, or null if the cursor location is not specified for this event.

return
the Point indicating the cursor location or null if the cursor location is not specified
since
1.4

        if (locationSpecified) {
            return new Point(x, y);
        } else {
            return null;
        }
public intgetX()
This method returns the horizontal coordinate of the cursor location in screen coordinates at the moment this event occured, or zero if the cursor location is not specified for this event.

return
an integer indicating the horizontal coordinate of the cursor location or zero if the cursor location is not specified
since
1.4

        return x;
public intgetY()
This method returns the vertical coordinate of the cursor location in screen coordinates at the moment this event occured, or zero if the cursor location is not specified for this event.

return
an integer indicating the vertical coordinate of the cursor location or zero if the cursor location is not specified
since
1.4

        return y;