java.awt.dnd: public class: DragSourceDragEvent

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

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

All Implemented Interfaces:
Serializable

The DragSourceDragEvent is delivered from the DragSourceContextPeer, via the DragSourceContext, to the DragSourceListener registered with that DragSourceContext and with its associated DragSource.

The DragSourceDragEvent reports the target drop action and the user drop action that reflect the current state of the drag operation.

Target drop action is one of DnDConstants that represents the drop action selected by the current drop target if this drop action is supported by the drag source or DnDConstants.ACTION_NONE if this drop action is not supported by the drag source.

User drop action depends on the drop actions supported by the drag source and the drop action selected by the user. The user can select a drop action by pressing modifier keys during the drag operation:

Ctrl + Shift -> ACTION_LINK
Ctrl -> ACTION_COPY
Shift -> ACTION_MOVE

If the user selects a drop action, the user drop action is one of DnDConstants that represents the selected drop action if this drop action is supported by the drag source or DnDConstants.ACTION_NONE if this drop action is not supported by the drag source.

If the user doesn't select a drop action, the set of DnDConstants that represents the set of drop actions supported by the drag source is searched for DnDConstants.ACTION_MOVE, then for DnDConstants.ACTION_COPY, then for DnDConstants.ACTION_LINK and the user drop action is the first constant found. If no constant is found the user drop action is DnDConstants.ACTION_NONE.

since: 1.2 -

Fields inherited from java.util.EventObject:
source

Constructor:

Constructor:
public DragSourceDragEvent(DragSourceContext dsc, int dropAction, int action, int modifiers) { super(dsc); targetActions = action; gestureModifiers = modifiers; this.dropAction = dropAction; if ((modifiers & ~(JDK_1_3_MODIFIERS \| JDK_1_4_MODIFIERS)) != 0) { invalidModifiers = true; } else if ((getGestureModifiers() != 0) && (getGestureModifiersEx() == 0)) { setNewModifiers(); } else if ((getGestureModifiers() == 0) && (getGestureModifiersEx() != 0)) { setOldModifiers(); } else { invalidModifiers = true; } } Constructs a `DragSourceDragEvent`. This class is typically instantiated by the `DragSourceContextPeer` rather than directly by client code. The coordinates for this `DragSourceDragEvent` are not specified, so `getLocation` will return `null` for this event. The arguments `dropAction` and `action` should be one of `DnDConstants` that represents a single action. The argument `modifiers` should be either a bitwise mask of old `java.awt.event.InputEvent._MASK` constants or a bitwise mask of extended `java.awt.event.InputEvent._DOWN_MASK` constants. This constructor does not throw any exception for invalid `dropAction`, `action` and `modifiers`. Parameters: `dsc` - the `DragSourceContext` that is to manage notifications for this event. `dropAction` - the user drop action. `action` - the target drop action. `modifiers` - the modifier keys down during event (shift, ctrl, alt, meta) Either extended _DOWN_MASK or old _MASK modifiers should be used, but both models should not be mixed in one event. Use of the extended modifiers is preferred. Throws: `<` - code>IllegalArgumentException if `dsc` is `null`. Also see: java.awt.event.InputEvent DragSourceEvent#getLocation
public DragSourceDragEvent(DragSourceContext dsc, int dropAction, int action, int modifiers, int x, int y) { super(dsc, x, y); targetActions = action; gestureModifiers = modifiers; this.dropAction = dropAction; if ((modifiers & ~(JDK_1_3_MODIFIERS \| JDK_1_4_MODIFIERS)) != 0) { invalidModifiers = true; } else if ((getGestureModifiers() != 0) && (getGestureModifiersEx() == 0)) { setNewModifiers(); } else if ((getGestureModifiers() == 0) && (getGestureModifiersEx() != 0)) { setOldModifiers(); } else { invalidModifiers = true; } } Constructs a `DragSourceDragEvent` given the specified `DragSourceContext`, user drop action, target drop action, modifiers and coordinates. The arguments `dropAction` and `action` should be one of `DnDConstants` that represents a single action. The argument `modifiers` should be either a bitwise mask of old `java.awt.event.InputEvent._MASK` constants or a bitwise mask of extended `java.awt.event.InputEvent._DOWN_MASK` constants. This constructor does not throw any exception for invalid `dropAction`, `action` and `modifiers`. Parameters: `dsc` - the `DragSourceContext` associated with this event. `dropAction` - the user drop action. `action` - the target drop action. `modifiers` - the modifier keys down during event (shift, ctrl, alt, meta) Either extended _DOWN_MASK or old _MASK modifiers should be used, but both models should not be mixed in one event. Use of the extended modifiers is preferred. `x` - the horizontal coordinate for the cursor location `y` - the vertical coordinate for the cursor location Throws: `<` - code>IllegalArgumentException if `dsc` is `null`. Also see: java.awt.event.InputEvent since: `1.4` -

 public DragSourceDragEvent(DragSourceContext dsc,
    int dropAction,
    int action,
    int modifiers) {
                                                                                                                                                                                                                   
        super(dsc);
        targetActions    = action;
        gestureModifiers = modifiers;
        this.dropAction  = dropAction;
        if ((modifiers & ~(JDK_1_3_MODIFIERS | JDK_1_4_MODIFIERS)) != 0) {
            invalidModifiers = true;
        } else if ((getGestureModifiers() != 0) && (getGestureModifiersEx() == 0)) {
            setNewModifiers();
        } else if ((getGestureModifiers() == 0) && (getGestureModifiersEx() != 0)) {
            setOldModifiers();
        } else {
            invalidModifiers = true;
        }
}

DragSourceDragEvent

DragSourceContextPeer

DragSourceDragEvent

getLocation

null

The arguments dropAction and action should be one of DnDConstants that represents a single action. The argument modifiers should be either a bitwise mask of old java.awt.event.InputEvent.*_MASK constants or a bitwise mask of extended java.awt.event.InputEvent.*_DOWN_MASK constants. This constructor does not throw any exception for invalid dropAction, action and modifiers.

Parameters:

dsc - the DragSourceContext that is to manage notifications for this event.

dropAction - the user drop action.

action - the target drop action.

modifiers - the modifier keys down during event (shift, ctrl, alt, meta) Either extended _DOWN_MASK or old _MASK modifiers should be used, but both models should not be mixed in one event. Use of the extended modifiers is preferred.

Throws:

< - code>IllegalArgumentException if dsc is null.

Also see:

java.awt.event.InputEvent

DragSourceEvent#getLocation

 public DragSourceDragEvent(DragSourceContext dsc,
    int dropAction,
    int action,
    int modifiers,
    int x,
    int y) {
        super(dsc, x, y);
        targetActions    = action;
        gestureModifiers = modifiers;
        this.dropAction  = dropAction;
        if ((modifiers & ~(JDK_1_3_MODIFIERS | JDK_1_4_MODIFIERS)) != 0) {
            invalidModifiers = true;
        } else if ((getGestureModifiers() != 0) && (getGestureModifiersEx() == 0)) {
            setNewModifiers();
        } else if ((getGestureModifiers() == 0) && (getGestureModifiersEx() != 0)) {
            setOldModifiers();
        } else {
            invalidModifiers = true;
        }
}

DragSourceDragEvent

DragSourceContext

Parameters:

dsc - the DragSourceContext associated with this event.

dropAction - the user drop action.

action - the target drop action.

x - the horizontal coordinate for the cursor location

y - the vertical coordinate for the cursor location

Throws:

< - code>IllegalArgumentException if dsc is null.

Also see:

java.awt.event.InputEvent

since: 1.4 -

Method from java.awt.dnd.DragSourceDragEvent Summary:
getDropAction, getGestureModifiers, getGestureModifiersEx, getTargetActions, getUserAction

Methods from java.awt.dnd.DragSourceEvent:
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.DragSourceDragEvent Detail:
public int getDropAction() { return targetActions & getDragSourceContext().getSourceActions(); } This method returns the logical intersection of the target drop action and the set of drop actions supported by the drag source.
public int getGestureModifiers() { return invalidModifiers ? gestureModifiers : gestureModifiers & JDK_1_3_MODIFIERS; } This method returns an `int` representing the current state of the input device modifiers associated with the user's gesture. Typically these would be mouse buttons or keyboard modifiers. If the `modifiers` passed to the constructor are invalid, this method returns them unchanged.
public int getGestureModifiersEx() { return invalidModifiers ? gestureModifiers : gestureModifiers & JDK_1_4_MODIFIERS; } This method returns an `int` representing the current state of the input device extended modifiers associated with the user's gesture. See InputEvent#getModifiersEx If the `modifiers` passed to the constructor are invalid, this method returns them unchanged.
public int getTargetActions() { return targetActions; } This method returns the target drop action.
public int getUserAction() { return dropAction; } This method returns the user drop action.

Method from java.awt.dnd.DragSourceDragEvent Detail:

 public int getDropAction() {
        return targetActions & getDragSourceContext().getSourceActions();
}

This method returns the logical intersection of the target drop action and the set of drop actions supported by the drag source.

 public int getGestureModifiers() {
                                                             
        return invalidModifiers ? gestureModifiers : gestureModifiers & JDK_1_3_MODIFIERS;
}

int

If the modifiers passed to the constructor are invalid, this method returns them unchanged.

 public int getGestureModifiersEx() {
        return invalidModifiers ? gestureModifiers : gestureModifiers & JDK_1_4_MODIFIERS;
}

int

InputEvent#getModifiersEx

If the modifiers passed to the constructor are invalid, this method returns them unchanged.

 public int getTargetActions() {
        return targetActions;
}

This method returns the target drop action.

 public int getUserAction() {
 return dropAction;
}

This method returns the user drop action.