org.eclipse.swt.custom

Class StyledTextDropTargetEffect

java.lang.Object

org.eclipse.swt.dnd.DropTargetAdapter

org.eclipse.swt.dnd.DropTargetEffect

org.eclipse.swt.custom.StyledTextDropTargetEffect

All Implemented Interfaces:

java.util.EventListener, DropTargetListener, SWTEventListener

public class StyledTextDropTargetEffect
extends DropTargetEffect

This adapter class provides a default drag under effect (eg. select and scroll) when a drag occurs over a StyledText.

Classes that wish to provide their own drag under effect for a StyledText can extend this class, override the StyledTextDropTargetEffect.dragOver method and override any other applicable methods in StyledTextDropTargetEffect to display their own drag under effect.

Subclasses that override any methods of this class should call the corresponding super method to get the default drag under effect implementation.

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_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) static int	CARET_WIDTH
(package private) int	currentOffset
(package private) Listener	paintListener
(package private) static int	SCROLL_HYSTERESIS
(package private) static int	SCROLL_TOLERANCE
(package private) long	scrollBeginTime
(package private) int	scrollX
(package private) int	scrollY

Constructor Summary

Constructors

Constructor and Description
StyledTextDropTargetEffect(StyledText styledText) Creates a new StyledTextDropTargetEffect to handle the drag under effect on the specified StyledText.

Method Summary

Methods

Modifier and Type	Method and Description
void	dragEnter(DropTargetEvent event) This implementation of dragEnter provides a default drag under effect for the feedback specified in event.feedback.
void	dragLeave(DropTargetEvent event) This implementation of dragLeave provides a default drag under effect for the feedback specified in event.feedback.
void	dragOver(DropTargetEvent event) This implementation of dragOver provides a default drag under effect for the feedback specified in event.feedback.
void	dropAccept(DropTargetEvent event) This implementation of dropAccept provides a default drag under effect for the feedback specified in event.feedback.
(package private) void	refreshCaret(StyledText text, int oldOffset, int newOffset)

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

getControl, getItem

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

dragOperationChanged, drop

Methods inherited from class java.lang.Object

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

Field Detail

CARET_WIDTH

static final int CARET_WIDTH

See Also:

Constant Field Values

SCROLL_HYSTERESIS

static final int SCROLL_HYSTERESIS

See Also:

Constant Field Values

SCROLL_TOLERANCE

static final int SCROLL_TOLERANCE

See Also:

Constant Field Values

currentOffset

int currentOffset

scrollBeginTime

long scrollBeginTime

scrollX

int scrollX

scrollY

int scrollY

paintListener

Listener paintListener

Constructor Detail

StyledTextDropTargetEffect

public StyledTextDropTargetEffect(StyledText styledText)

Creates a new StyledTextDropTargetEffect to handle the drag under effect on the specified StyledText.

Parameters:

styledText - the StyledText over which the user positions the cursor to drop the data

Method Detail

dragEnter

public void dragEnter(DropTargetEvent event)

This implementation of dragEnter provides a default drag under effect for the feedback specified in event.feedback. For additional information see DropTargetAdapter.dragEnter. Subclasses that override this method should call super.dragEnter(event) to get the default drag under effect implementation.

Specified by:

dragEnter in interface DropTargetListener

Overrides:

dragEnter in class DropTargetAdapter

Parameters:

event - the information associated with the drag start event

See Also:

DropTargetAdapter, DropTargetEvent

dragLeave

public void dragLeave(DropTargetEvent event)

This implementation of dragLeave provides a default drag under effect for the feedback specified in event.feedback. For additional information see DropTargetAdapter.dragLeave. Subclasses that override this method should call super.dragLeave(event) to get the default drag under effect implementation.

Specified by:

dragLeave in interface DropTargetListener

Overrides:

dragLeave in class DropTargetAdapter

Parameters:

event - the information associated with the drag leave event

See Also:

DropTargetAdapter, DropTargetEvent

dragOver

public void dragOver(DropTargetEvent event)

This implementation of dragOver provides a default drag under effect for the feedback specified in event.feedback. For additional information see DropTargetAdapter.dragOver. Subclasses that override this method should call super.dragOver(event) to get the default drag under effect implementation.

Specified by:

dragOver in interface DropTargetListener

Overrides:

dragOver in class DropTargetAdapter

Parameters:

event - the information associated with the drag over event

See Also:

DropTargetAdapter, DropTargetEvent, DND.FEEDBACK_SELECT, DND.FEEDBACK_SCROLL

refreshCaret

void refreshCaret(StyledText text,
                int oldOffset,
                int newOffset)

dropAccept

public void dropAccept(DropTargetEvent event)

This implementation of dropAccept provides a default drag under effect for the feedback specified in event.feedback. For additional information see DropTargetAdapter.dropAccept. Subclasses that override this method should call super.dropAccept(event) to get the default drag under effect implementation.

Specified by:

dropAccept in interface DropTargetListener

Overrides:

dropAccept in class DropTargetAdapter

Parameters:

event - the information associated with the drop accept event

See Also:

DropTargetAdapter, DropTargetEvent