com.sencha.gxt.dnd.core.client

Class TreeDropTarget<M>

java.lang.Object

com.sencha.gxt.dnd.core.client.DropTarget

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

Type Parameters:

M - the model type

All Implemented Interfaces:

DndDragCancelEvent.HasDndDragCancelHandlers, DndDragEnterEvent.HasDndDragEnterHandlers, DndDragLeaveEvent.HasDndDragLeaveHandlers, DndDragMoveEvent.HasDndDragMoveHandlers, DndDropEvent.HasDndDropHandlers

public class TreeDropTarget<M>
extends DropTarget

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

Use DropTarget.setFeedback(com.sencha.gxt.dnd.core.client.DND.Feedback) to specify whether to allow inserting items between items, appending items to the end, or both (defaults to DND.Feedback.BOTH).

Use DropTarget.setOperation(com.sencha.gxt.dnd.core.client.DND.Operation) to specify whether to move items or copy them (defaults to DND.Operation.MOVE).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TreeDropTarget.TreeDropTargetResources The tree drop target resources.

Constructor Summary

Constructors

Constructor and Description
TreeDropTarget(Tree<M,?> tree) Creates a drop target for the specified tree.

Method Summary

Methods

Modifier and Type	Method and Description
Tree<M,?>	getWidget() Returns the target's widget.
boolean	isAddChildren() Returns true if children are being added when inserting into the TreeStore.
boolean	isAllowDropOnLeaf() Returns whether drops are allowed on leaf nodes.
boolean	isAutoExpand() Returns true if auto expand is enabled (defaults to true).
boolean	isAutoScroll() Returns true if auto scroll is enabled (defaults to true).
void	setAddChildren(boolean addChildren) True to add children when inserting models into the TreeStore (defaults to false).
void	setAllowDropOnLeaf(boolean allowDropOnLeaf) True to allow drops on leaf nodes (defaults to false).
void	setAutoExpand(boolean autoExpand) True to automatically expand the active tree item when the user hovers over a collapsed item (defaults to true).
void	setAutoExpandDelay(int autoExpandDelay) Sets the delay used to auto expand items (defaults to 800).
void	setAutoScroll(boolean autoScroll) True to automatically scroll the tree when the user hovers over the top and bottom of the tree grid (defaults to true).

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

addDragCancelHandler, addDragEnterHandler, addDragLeaveHandler, addDragMoveHandler, addDropHandler, disable, enable, getFeedback, getGroup, getOperation, getOverStyle, isAllowSelfAsSource, isEnabled, release, setAllowSelfAsSource, setFeedback, setGroup, setOperation, setOverStyle

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeDropTarget

public TreeDropTarget(Tree<M,?> tree)

Creates a drop target for the specified tree.

Parameters:

tree - the tree to enable as a drop target

Method Detail

getWidget

public Tree<M,?> getWidget()

Description copied from class: DropTarget

Returns the target's widget.

Overrides:

getWidget in class DropTarget

Returns:

the widget

isAddChildren

public boolean isAddChildren()

Returns true if children are being added when inserting into the TreeStore.

Returns:

the add children state

isAllowDropOnLeaf

public boolean isAllowDropOnLeaf()

Returns whether drops are allowed on leaf nodes.

Returns:

true of drops on leafs are allowed

isAutoExpand

public boolean isAutoExpand()

Returns true if auto expand is enabled (defaults to true).

Returns:

the auto expand state

isAutoScroll

public boolean isAutoScroll()

Returns true if auto scroll is enabled (defaults to true).

Returns:

true if auto scroll enabled

setAddChildren

public void setAddChildren(boolean addChildren)

True to add children when inserting models into the TreeStore (defaults to false).

Parameters:

addChildren - true to add children

setAllowDropOnLeaf

public void setAllowDropOnLeaf(boolean allowDropOnLeaf)

True to allow drops on leaf nodes (defaults to false).

Parameters:

allowDropOnLeaf - true to enable drops on leaf nodes

setAutoExpand

public void setAutoExpand(boolean autoExpand)

True to automatically expand the active tree item when the user hovers over a collapsed item (defaults to true). Use setAutoExpandDelay(int) to set the delay.

Parameters:

autoExpand - true to auto expand

setAutoExpandDelay

public void setAutoExpandDelay(int autoExpandDelay)

Sets the delay used to auto expand items (defaults to 800).

Parameters:

autoExpandDelay - the delay in milliseconds

setAutoScroll

public void setAutoScroll(boolean autoScroll)

True to automatically scroll the tree when the user hovers over the top and bottom of the tree grid (defaults to true).

Parameters:

autoScroll - true to enable auto scroll

See Also:

ScrollSupport