Top Description Fields Constructors Methods
org.eclipse.swt.dnd

public Class TreeDragSourceEffect

extends DragSourceEffect
Class Inheritance
Imports
org.eclipse.swt.graphics.*, org.eclipse.swt.widgets.*
This class provides default implementations to display a source image when a drag is initiated from a Tree.

Classes that wish to provide their own source image for a Tree can extend TreeDragSourceEffect class and override the TreeDragSourceEffect.dragStart method and set the field DragSourceEvent.image with their own image.

Subclasses that override any methods of this class must call the corresponding super method to get the default drag under effect implementation.
Since
3.3
See Also
DragSourceEffect, DragSourceEvent, Sample code and further information

Field Summary

Modifier and TypeField and Description
pack-priv Image
dragSourceImage

Inherited from org.eclipse.swt.dnd.DragSourceEffect:
control

Constructor Summary

AccessConstructor and Description
public
TreeDragSourceEffect(Tree
the Tree that the user clicks on to initiate the drag
tree)

Creates a new TreeDragSourceEffect to handle drag effect from the specified Tree.

Method Summary

Modifier and TypeMethod and Description
public void
dragFinished(DragSourceEvent
the information associated with the drag finished event
event)

Overrides org.eclipse.swt.dnd.DragSourceAdapter.dragFinished.

Implements org.eclipse.swt.dnd.DragSourceListener.dragFinished.

This implementation of dragFinished disposes the image that was created in TreeDragSourceEffect.dragStart.
public void
dragStart(DragSourceEvent
the information associated with the drag start event
event)

Overrides org.eclipse.swt.dnd.DragSourceAdapter.dragStart.

Implements org.eclipse.swt.dnd.DragSourceListener.dragStart.

This implementation of dragStart will create a default image that will be used during the drag.
pack-priv Image
getDragSourceImage(DragSourceEvent event)

Inherited from org.eclipse.swt.dnd.DragSourceEffect:
getControl

Field Detail

dragSourceImageback to summary
pack-priv Image dragSourceImage

Constructor Detail

TreeDragSourceEffectback to summary
public TreeDragSourceEffect(Tree tree)

Creates a new TreeDragSourceEffect to handle drag effect from the specified Tree.

Parameters
tree:Tree

the Tree that the user clicks on to initiate the drag

Method Detail

dragFinishedback to summary
public void dragFinished(DragSourceEvent event)

Overrides org.eclipse.swt.dnd.DragSourceAdapter.dragFinished.

Implements org.eclipse.swt.dnd.DragSourceListener.dragFinished.

This implementation of dragFinished disposes the image that was created in TreeDragSourceEffect.dragStart. Subclasses that override this method should call super.dragFinished(event) to dispose the image in the default implementation.

Parameters
event:DragSourceEvent

the information associated with the drag finished event

Annotations
@Override
dragStartback to summary
public void dragStart(DragSourceEvent event)

Overrides org.eclipse.swt.dnd.DragSourceAdapter.dragStart.

Implements org.eclipse.swt.dnd.DragSourceListener.dragStart.

This implementation of dragStart will create a default image that will be used during the drag. The image should be disposed when the drag is completed in the TreeDragSourceEffect.dragFinished method. Subclasses that override this method should call super.dragStart(event) to use the image from the default implementation.

Parameters
event:DragSourceEvent

the information associated with the drag start event

Annotations
@Override
getDragSourceImageback to summary
pack-priv Image getDragSourceImage(DragSourceEvent event)