Package com.sencha.gxt.dnd.core.client

Class TreeGridDragSource<M>

java.lang.Object

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

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

Type Parameters:

M - the model type

All Implemented Interfaces:

DndDragCancelEvent.HasDndDragCancelHandlers, DndDragStartEvent.HasDndDragStartHandlers, DndDropEvent.HasDndDropHandlers

public class TreeGridDragSource<M>
extends DragSource

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

Use setTreeGridSource(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	Description
TreeGridDragSource(TreeGrid<M> widget)	Creates a drag source for the specified tree grid.

Method Summary

Modifier and Type	Method	Description
DND.TreeSource	getTreeGridSource()	Returns the tree grid associated with this drag source.
TreeGrid<M>	getWidget()	Returns the source widget.
void	setTreeGridSource(DND.TreeSource treeGridSource)	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

TreeGridDragSource

public TreeGridDragSource(TreeGrid<M> widget)

Creates a drag source for the specified tree grid.

Parameters:

widget - the tree grid to enable as a drag source

Method Detail

getTreeGridSource

public DND.TreeSource getTreeGridSource()

Returns the tree grid associated with this drag source.

Returns:

the tree grid associated with this drag source

getWidget

public TreeGrid<M> getWidget()

Description copied from class: DragSource

Returns the source widget.

Overrides:

getWidget in class DragSource

Returns:

the widget

setTreeGridSource

public void setTreeGridSource(DND.TreeSource treeGridSource)

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

Parameters:

treeGridSource - the tree source