com.sencha.gxt.dnd.core.client

Class TreeDragSource<M>

java.lang.Object

com.sencha.gxt.dnd.core.client.DragSource

com.sencha.gxt.dnd.core.client.TreeDragSource<M>

Type Parameters:

M - the model type

All Implemented Interfaces:

DndDragCancelEvent.HasDndDragCancelHandlers, DndDragStartEvent.HasDndDragStartHandlers, DndDropEvent.HasDndDropHandlers

public class TreeDragSource<M>
extends DragSource

Enables a Tree to act as the source of a drag and drop operation.

Use setTreeSource(com.sencha.gxt.dnd.core.client.DND.TreeSource) to specify whether leaf nodes, non-leaf nodes or both types of nodes can be dragged (defaults to DND.TreeSource.BOTH). The drag operation is cancelled if the user attempts to drag a node type that is not permitted.

The drag data consists of a list of items of type <M>. It is optimized to remove children of parents that are also in the list (i.e. if a parent is the subject of a drag operation then all of its children are implicitly part of the drag operation).

Constructor Summary

Constructors

Constructor and Description
TreeDragSource(Tree<M,?> tree) Creates a drag source for the specified tree.

Method Summary

Methods

Modifier and Type	Method and Description
DND.TreeSource	getTreeSource() Returns the tree associated with this drag source.
Tree<M,?>	getWidget() Returns the source widget.
void	setTreeSource(DND.TreeSource treeSource) Sets the tree source (defaults to DND.TreeSource.BOTH).

Methods inherited from class com.sencha.gxt.dnd.core.client.DragSource

addDragCancelHandler, addDragStartHandler, addDropHandler, disable, enable, getData, getDraggable, getGroup, getStatusText, isEnabled, release, setData, setGroup, setStatusText

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeDragSource

public TreeDragSource(Tree<M,?> tree)

Creates a drag source for the specified tree.

Parameters:

tree - the tree to enable as a drag source

Method Detail

getTreeSource

public DND.TreeSource getTreeSource()

Returns the tree associated with this drag source.

Returns:

the tree associated with this drag source

getWidget

public Tree<M,?> getWidget()

Description copied from class: DragSource

Returns the source widget.

Overrides:

getWidget in class DragSource

Returns:

the widget

setTreeSource

public void setTreeSource(DND.TreeSource treeSource)

Sets the tree source (defaults to DND.TreeSource.BOTH).

Parameters:

treeSource - the tree source