| java.lang.Object org.eclipse.ui.internal.dnd.DragUtil
DragUtil | public class DragUtil (Code) | | Provides the methods for attaching drag-and-drop listeners to SWT controls.
|
Method Summary | |
public static void | addDragTarget(Control control, IDragOverListener target) Sets the drop target for the given control. | public static boolean | dragTo(Display display, Object draggedItem, Point finalLocation, Rectangle dragRectangle) Drags the given item to the given location (in display coordinates). | static IDropTarget | dragToTarget(Object draggedItem, Rectangle sourceBounds, Point initialLocation, boolean allowSnapping) Drags the given item, given an initial bounding rectangle in display coordinates.
Due to a quirk in the Tracker class, changing the tracking rectangle when using the
keyboard will also cause the mouse cursor to move. | public static void | forceDropLocation(TestDropLocation forcedLocation) Forces all drags to end at the given position (display coordinates). | public static Rectangle | getDisplayBounds(Control boundsControl) Shorthand method. | public static IDropTarget | getDropTarget(Control toSearch, Object draggedObject, Point position, Rectangle dragRectangle) Returns the drag target for the given control or null if none. | public static Point | getEventLoc(Event event) | public static boolean | performDrag(Object draggedItem, Rectangle sourceBounds, Point initialLocation, boolean allowSnapping) | public static void | removeDragTarget(Control control, IDragOverListener target) Removes a drop target from the given control. |
addDragTarget | public static void addDragTarget(Control control, IDragOverListener target)(Code) | | Sets the drop target for the given control. It is possible to add one or more
targets for a "null" control. This becomes a default target that is used if no
other targets are found (for example, when dragging objects off the application
window).
Parameters: control - the control that should be treated as a drag target, or nullto indicate the default target Parameters: target - the drag target to handle the given control |
dragTo | public static boolean dragTo(Display display, Object draggedItem, Point finalLocation, Rectangle dragRectangle)(Code) | | Drags the given item to the given location (in display coordinates). This
method is intended for use by test suites.
Parameters: draggedItem - object being dragged Parameters: finalLocation - location being dragged to true iff the drop was accepted |
dragToTarget | static IDropTarget dragToTarget(Object draggedItem, Rectangle sourceBounds, Point initialLocation, boolean allowSnapping)(Code) | | Drags the given item, given an initial bounding rectangle in display coordinates.
Due to a quirk in the Tracker class, changing the tracking rectangle when using the
keyboard will also cause the mouse cursor to move. Since "snapping" causes the tracking
rectangle to change based on the position of the mouse cursor, it is impossible to do
drag-and-drop with the keyboard when snapping is enabled.
Parameters: draggedItem - object being dragged Parameters: sourceBounds - initial bounding rectangle for the dragged item Parameters: initialLocation - initial position of the mouse cursor Parameters: allowSnapping - true iff the rectangle should snap to the drop location. This mustbe false if the user might be doing drag-and-drop using the keyboard. |
forceDropLocation | public static void forceDropLocation(TestDropLocation forcedLocation)(Code) | | Forces all drags to end at the given position (display coordinates). Intended
for use by test suites. If this method is called, then all subsequent calls
to performDrag will terminate immediately and behave as though the object were
dragged to the given location. Calling this method with null cancels this
behavior and causes performDrag to behave normally.
Parameters: forcedLocation - location where objects will be dropped (or null tocause drag/drop to behave normally). |
getDisplayBounds | public static Rectangle getDisplayBounds(Control boundsControl)(Code) | | Shorthand method. Returns the bounding rectangle for the given control, in
display coordinates. Note that all 'Shell' controls are expected to be 'top level'
so DO NOT do the origin offset for them.
Parameters: draggedItem - Parameters: boundsControl - |
getDropTarget | public static IDropTarget getDropTarget(Control toSearch, Object draggedObject, Point position, Rectangle dragRectangle)(Code) | | Returns the drag target for the given control or null if none.
Parameters: toSearch - Parameters: e - |
getEventLoc | public static Point getEventLoc(Event event)(Code) | | Returns the location of the given event, in display coordinates
|
performDrag | public static boolean performDrag(Object draggedItem, Rectangle sourceBounds, Point initialLocation, boolean allowSnapping)(Code) | | |
removeDragTarget | public static void removeDragTarget(Control control, IDragOverListener target)(Code) | | Removes a drop target from the given control.
Parameters: control - Parameters: target - |
|
|