java.awt.dnd: public class: DragSourceEvent

java.awt.dnd
public class: DragSourceEvent [javadoc | source]

java.lang.Object
   java.util.EventObject
      java.awt.dnd.DragSourceEvent

All Implemented Interfaces:
Serializable

Direct Known Subclasses:
DragSourceDragEvent, DragSourceDropEvent

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 inherited from java.util.EventObject:
source

Constructor:

Constructor:
public DragSourceEvent(DragSourceContext dsc) { super(dsc); locationSpecified = false; this.x = 0; this.y = 0; } 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` - the `DragSourceContext` Throws: `<` - code>IllegalArgumentException if `dsc` is `null`. Also see: getLocation
public DragSourceEvent(DragSourceContext dsc, int x, int y) { super(dsc); locationSpecified = true; this.x = x; this.y = y; } Construct a `DragSourceEvent` given a specified `DragSourceContext`, and coordinates of the cursor location. Parameters: `dsc` - the `DragSourceContext` `x` - the horizontal coordinate for the cursor location `y` - the vertical coordinate for the cursor location Throws: `<` - code>IllegalArgumentException if `dsc` is `null`. since: `1.4` -

 public DragSourceEvent(DragSourceContext dsc) {
                                            
        super(dsc);
        locationSpecified = false;
        this.x = 0;
        this.y = 0;
}

DragSourceEvent

DragSourceContext

DragSourceEvent

getLocation

null

Parameters:

dsc - the DragSourceContext

Throws:

< - code>IllegalArgumentException if dsc is null.

Also see:

getLocation

 public DragSourceEvent(DragSourceContext dsc,
    int x,
    int y) {
        super(dsc);
        locationSpecified = true;
        this.x = x;
        this.y = y;
}

DragSourceEvent

DragSourceContext

Parameters:

dsc - the DragSourceContext

x - the horizontal coordinate for the cursor location

y - the vertical coordinate for the cursor location

Throws:

< - code>IllegalArgumentException if dsc is null.

since: 1.4 -

Method from java.awt.dnd.DragSourceEvent Summary:
getDragSourceContext, getLocation, getX, getY

Methods from java.util.EventObject:
getSource, toString

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

Method from java.awt.dnd.DragSourceEvent Detail:
public DragSourceContext getDragSourceContext() { return (DragSourceContext)getSource(); } This method returns the `DragSourceContext` that originated the event.
public Point getLocation() { if (locationSpecified) { return new Point(x, y); } else { return null; } } 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.
public int getX() { return x; } 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.
public int getY() { return y; } 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.

Method from java.awt.dnd.DragSourceEvent Detail:

 public DragSourceContext getDragSourceContext() {
        return (DragSourceContext)getSource();
}

DragSourceContext

 public Point getLocation() {
        if (locationSpecified) {
            return new Point(x, y);
        } else {
            return null;
        }
}

Point

null

 public int getX() {
        return x;
}

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.

 public int getY() {
        return y;
}

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.