org.eclipse.swt.dnd

Class DropTargetEffect

java.lang.Object

org.eclipse.swt.dnd.DropTargetAdapter

org.eclipse.swt.dnd.DropTargetEffect

All Implemented Interfaces:

java.util.EventListener, DropTargetListener, SWTEventListener

Direct Known Subclasses:

StyledTextDropTargetEffect, TableDropTargetEffect, TreeDropTargetEffect

public class DropTargetEffect
extends DropTargetAdapter

This class provides a default drag under effect during a drag and drop. The current implementation does not provide any visual feedback.

The drop target effect has the same API as the DropTargetAdapter so that it can provide custom visual feedback when a DropTargetEvent occurs.

Classes that wish to provide their own drag under effect can extend the DropTargetEffect and override any applicable methods in DropTargetAdapter to display their own drag under effect.

The feedback value is either one of the FEEDBACK constants defined in class DND which is applicable to instances of this class, or it must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those DND effect constants.

Feedback:

FEEDBACK_EXPAND, FEEDBACK_INSERT_AFTER, FEEDBACK_INSERT_BEFORE, FEEDBACK_NONE, FEEDBACK_SELECT, FEEDBACK_SCROLL

Since:

3.3

See Also:

DropTargetAdapter, DropTargetEvent, Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Control	control

Constructor Summary

Constructors

Constructor and Description
DropTargetEffect(Control control) Creates a new DropTargetEffect to handle the drag under effect on the specified Control.

Method Summary

Methods

Modifier and Type	Method and Description
Control	getControl() Returns the Control which is registered for this DropTargetEffect.
Widget	getItem(int x, int y) Returns the item at the given x-y coordinate in the receiver or null if no such item exists.
(package private) Widget	getItem(Table table, int x, int y)
(package private) Widget	getItem(Tree tree, int x, int y)
(package private) TreeItem	nextItem(Tree tree, TreeItem item)
(package private) TreeItem	previousItem(Tree tree, TreeItem item)

Methods inherited from class org.eclipse.swt.dnd.DropTargetAdapter

dragEnter, dragLeave, dragOperationChanged, dragOver, drop, dropAccept

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

control

Control control

Constructor Detail

DropTargetEffect

public DropTargetEffect(Control control)

Creates a new DropTargetEffect to handle the drag under effect on the specified Control.

Parameters:

control - the Control over which the user positions the cursor to drop the data

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the control is null

Method Detail

getControl

public Control getControl()

Returns the Control which is registered for this DropTargetEffect. This is the control over which the user positions the cursor to drop the data.

Returns:

the Control which is registered for this DropTargetEffect

getItem

public Widget getItem(int x,
             int y)

Returns the item at the given x-y coordinate in the receiver or null if no such item exists. The x-y coordinate is in the display relative coordinates.

Parameters:

x - the x coordinate used to locate the item

y - the y coordinate used to locate the item

Returns:

the item at the given x-y coordinate, or null if the coordinate is not in a selectable item

getItem

Widget getItem(Table table,
             int x,
             int y)

getItem

Widget getItem(Tree tree,
             int x,
             int y)

nextItem

TreeItem nextItem(Tree tree,
                TreeItem item)

previousItem

TreeItem previousItem(Tree tree,
                    TreeItem item)