com.sencha.gxt.dnd.core.client

Class TreeGridDropTarget<M>

java.lang.Object

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

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

Type Parameters:

M - the model type

All Implemented Interfaces:

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

public class TreeGridDropTarget<M>
extends DropTarget

Enables a TreeGrid 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	TreeGridDropTarget.TreeGridDropTargetResources The tree drop target resources.

Field Summary

Fields

Modifier and Type	Field and Description
protected Tree.TreeNode<M>	activeItem
protected Tree.TreeNode<M>	appendItem
protected TreeGridDropTarget.TreeGridDropTargetResources	resources
protected int	status

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

dropWidget, feedback, operation, overStyle

Constructor Summary

Constructors

Constructor and Description
TreeGridDropTarget(TreeGrid<M> tree) Creates a drop target for the specified tree grid.

Method Summary

Modifier and Type	Method and Description
protected void	appendModel(M p, List<?> items, int index)
protected void	bind(TreeGrid<M> tree)
protected void	clearStyle(Tree.TreeNode<M> node)
TreeGrid<M>	getWidget() Returns the target's widget.
protected void	handleAppend(DndDragMoveEvent event, Tree.TreeNode<M> item)
protected void	handleAppendDrop(DndDropEvent event, Tree.TreeNode<M> item)
protected void	handleInsert(DndDragMoveEvent event, Tree.TreeNode<M> item)
protected void	handleInsertDrop(DndDropEvent event, Tree.TreeNode<M> item, int index)
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).
protected void	onDragCancelled(DndDragCancelEvent event) Called if the user cancels the drag operations while the mouse is over the target.
protected void	onDragDrop(DndDropEvent event) Called when the user releases the mouse over the target widget.
protected void	onDragEnter(DndDragEnterEvent event) Called when the cursor first enters the bounds of the drop target.
protected void	onDragFail(DndDropEvent event) Called when a drop fails.
protected void	onDragLeave(DndDragLeaveEvent event) Called when the cursor leaves the target.
protected void	onDragMove(DndDragMoveEvent event) Called when the cursor is moved within the target widget.
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).
protected void	showFeedback(DndDragMoveEvent event) Called as the mouse is moved over the target widget.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

activeItem

protected Tree.TreeNode<M> activeItem

appendItem

protected Tree.TreeNode<M> appendItem

status

protected int status

resources

protected TreeGridDropTarget.TreeGridDropTargetResources resources

Constructor Detail

TreeGridDropTarget

public TreeGridDropTarget(TreeGrid<M> tree)

Creates a drop target for the specified tree grid.

Parameters:

tree - the tree grid to enable as a drop target

Method Detail

getWidget

public TreeGrid<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

appendModel

protected void appendModel(M p,
                           List<?> items,
                           int index)

bind

protected void bind(TreeGrid<M> tree)

clearStyle

protected void clearStyle(Tree.TreeNode<M> node)

handleAppend

protected void handleAppend(DndDragMoveEvent event,
                            Tree.TreeNode<M> item)

handleAppendDrop

protected void handleAppendDrop(DndDropEvent event,
                                Tree.TreeNode<M> item)

handleInsert

protected void handleInsert(DndDragMoveEvent event,
                            Tree.TreeNode<M> item)

handleInsertDrop

protected void handleInsertDrop(DndDropEvent event,
                                Tree.TreeNode<M> item,
                                int index)

onDragCancelled

protected void onDragCancelled(DndDragCancelEvent event)

Description copied from class: DropTarget

Called if the user cancels the drag operations while the mouse is over the target.

Overrides:

onDragCancelled in class DropTarget

Parameters:

event - the drag cancel event

onDragDrop

protected void onDragDrop(DndDropEvent event)

Description copied from class: DropTarget

Called when the user releases the mouse over the target widget.

Overrides:

onDragDrop in class DropTarget

Parameters:

event - the drop event

onDragEnter

protected void onDragEnter(DndDragEnterEvent event)

Description copied from class: DropTarget

Called when the cursor first enters the bounds of the drop target. Subclasses or listeners can change the status of status proxy via the passed event.

Overrides:

onDragEnter in class DropTarget

Parameters:

event - the drag enter event

onDragFail

protected void onDragFail(DndDropEvent event)

Description copied from class: DropTarget

Called when a drop fails.

Overrides:

onDragFail in class DropTarget

Parameters:

event - the drop event

onDragLeave

protected void onDragLeave(DndDragLeaveEvent event)

Description copied from class: DropTarget

Called when the cursor leaves the target.

Overrides:

onDragLeave in class DropTarget

Parameters:

event - the drag leave event

onDragMove

protected void onDragMove(DndDragMoveEvent event)

Description copied from class: DropTarget

Called when the cursor is moved within the target widget. Subclasses or listeners can change the status of status proxy via the passed event. If either a subclass or listener sets CancellableEvent.setCancelled(boolean) to true, DropTarget.showFeedback(DndDragMoveEvent) will be called.

Overrides:

onDragMove in class DropTarget

Parameters:

event - the dd event

showFeedback

protected void showFeedback(DndDragMoveEvent event)

Description copied from class: DropTarget

Called as the mouse is moved over the target widget. The default implementation does nothing.

Overrides:

showFeedback in class DropTarget

Parameters:

event - the dd event