com.extjs.gxt.ui.client.dnd
Class TreePanelDropTarget

java.lang.Object
  extended by com.extjs.gxt.ui.client.event.BaseObservable
      extended by com.extjs.gxt.ui.client.dnd.DropTarget
          extended by com.extjs.gxt.ui.client.dnd.TreePanelDropTarget
All Implemented Interfaces:
Observable

public class TreePanelDropTarget
extends DropTarget


Field Summary
protected  TreePanel.TreeNode activeItem
           
protected  TreePanel.TreeNode appendItem
           
protected  int status
           
protected  TreePanel<ModelData> tree
           
 
Fields inherited from class com.extjs.gxt.ui.client.dnd.DropTarget
component, feedback, operation, overStyle
 
Constructor Summary
TreePanelDropTarget(TreePanel tree)
           
 
Method Summary
protected  void appendModel(ModelData p, java.util.List<ModelData> models, int index)
           
protected  void clearStyles(DNDEvent event)
           
 java.lang.String getScrollElementId()
          Returns the scroll element id.
 ScrollSupport getScrollSupport()
          Returns the scroll support instance.
 TreePanel<?> getTree()
          Returns the target's tree.
protected  void handleAppend(DNDEvent event, TreePanel.TreeNode item)
           
protected  void handleAppendDrop(DNDEvent event, TreePanel.TreeNode item)
           
protected  void handleInsert(DNDEvent event, TreePanel.TreeNode item)
           
protected  void handleInsertDrop(DNDEvent event, TreePanel.TreeNode item, int index)
           
 boolean isAllowDropOnLeaf()
          Returns whether drops are allowed on leaf nodes.
 boolean isAutoExpand()
          Returns true if auto expand is enabled.
 boolean isAutoScroll()
          Returns true if auto scroll is enabled (defaults to true).
protected  void onDragDrop(DNDEvent event)
          Called when the user releases the mouse over the target component.
protected  void onDragEnter(DNDEvent e)
          Called when the cursor first enters the bounds of the drop target.
protected  void onDragFail(DNDEvent event)
           
protected  void onDragLeave(DNDEvent e)
          Called when the cursor leaves the target.
protected  void onDragMove(DNDEvent event)
          Called when the cursor is moved within the target component.
 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).
 void setScrollElementId(java.lang.String scrollElementId)
          Sets the element that will be scrolled when auto scroll is enabled (optional, defaults to null).
protected  void showFeedback(DNDEvent event)
          Called as the mouse is moved over the target component.
 
Methods inherited from class com.extjs.gxt.ui.client.dnd.DropTarget
addDNDListener, disable, enable, getComponent, getFeedback, getGroup, getOperation, getOverStyle, isAllowSelfAsSource, isEnabled, onComponentAttach, onComponentDetach, onDragCancelled, prepareDropData, release, removeDNDListener, setAllowSelfAsSource, setFeedback, setGroup, setOperation, setOverStyle
 
Methods inherited from class com.extjs.gxt.ui.client.event.BaseObservable
addListener, callListener, fireEvent, fireEvent, getFiresEvents, getListeners, hasActiveEvent, hasListeners, hasListeners, removeAllListeners, removeListener, setFiresEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

tree

protected TreePanel<ModelData> tree

activeItem

protected TreePanel.TreeNode activeItem

appendItem

protected TreePanel.TreeNode appendItem

status

protected int status
Constructor Detail

TreePanelDropTarget

public TreePanelDropTarget(TreePanel tree)
Method Detail

getScrollElementId

public java.lang.String getScrollElementId()
Returns the scroll element id.

Returns:
the scroll element id.

getScrollSupport

public ScrollSupport getScrollSupport()
Returns the scroll support instance.

Returns:
the scroll support

getTree

public TreePanel<?> getTree()
Returns the target's tree.

Returns:
the tree

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.

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

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

setScrollElementId

public void setScrollElementId(java.lang.String scrollElementId)
Sets the element that will be scrolled when auto scroll is enabled (optional, defaults to null).

Parameters:
scrollElementId - the scroll element id

appendModel

protected void appendModel(ModelData p,
                           java.util.List<ModelData> models,
                           int index)

clearStyles

protected void clearStyles(DNDEvent event)

handleAppend

protected void handleAppend(DNDEvent event,
                            TreePanel.TreeNode item)

handleAppendDrop

protected void handleAppendDrop(DNDEvent event,
                                TreePanel.TreeNode item)

handleInsert

protected void handleInsert(DNDEvent event,
                            TreePanel.TreeNode item)

handleInsertDrop

protected void handleInsertDrop(DNDEvent event,
                                TreePanel.TreeNode item,
                                int index)

onDragDrop

protected void onDragDrop(DNDEvent event)
Description copied from class: DropTarget
Called when the user releases the mouse over the target component.

Overrides:
onDragDrop in class DropTarget
Parameters:
event - the dd event

onDragEnter

protected void onDragEnter(DNDEvent e)
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:
e - the dd event

onDragFail

protected void onDragFail(DNDEvent event)
Overrides:
onDragFail in class DropTarget

onDragLeave

protected void onDragLeave(DNDEvent e)
Description copied from class: DropTarget
Called when the cursor leaves the target.

Overrides:
onDragLeave in class DropTarget
Parameters:
e - the dd event

onDragMove

protected void onDragMove(DNDEvent event)
Description copied from class: DropTarget
Called when the cursor is moved within the target component. Subclasses or listeners can change the status of status proxy via the passed event. If either a subclass or listener sets BaseEvent.setCancelled(boolean) to true, DropTarget.showFeedback(DNDEvent) will be called.

Overrides:
onDragMove in class DropTarget
Parameters:
event - the dd event

showFeedback

protected void showFeedback(DNDEvent event)
Description copied from class: DropTarget
Called as the mouse is moved over the target component. The default implementation does nothing.

Overrides:
showFeedback in class DropTarget
Parameters:
event - the dd event