dijit/tree/dndSource.js

• Provides:

  • dijit.tree.dndSource

• Requires:

  • dijit.tree._dndSelector in common
  • dojo.dnd.Manager in common

• dijit.tree.dndSource

  • type

    Function

  • chains:
    • dijit.tree._dndSelector: (prototype)
    • dijit.tree._dndSelector: (call)
  • parameters:
    • tree: (typeof dijit.Tree)
    • params: (typeof dijit.tree.__SourceArgs)
  • summary

    Handles drag and drop operations (as a source or a target) for <code>dijit.Tree</code>

  • tags:

• dijit.tree.dndSource.isSource

  • tags:
  • type

    Boolean

  • summary

    Can be used as a DnD source.

• dijit.tree.dndSource.accept

  • type

    String[]

  • summary

    List of accepted types (text strings) for the Tree; defaults to
    ["text"]

• dijit.tree.dndSource.copyOnly

  • tags:
  • type

    Boolean

  • summary

    Copy items, if true, use a state of Ctrl key otherwise

• dijit.tree.dndSource.dragThreshold

  • type

    Number

  • summary

    The move delay in pixels before detecting a drag; 5 by default

• dijit.tree.dndSource.betweenThreshold

  • type

    Integer

  • summary

    Distance from upper/lower edge of node to allow drop to reorder nodes

• dijit.tree.dndSource.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • tree: (typeof dijit.Tree)
    • params: (typeof dijit.tree.__SourceArgs)
  • summary

    a constructor of the Tree DnD Source

  • tags:

• dijit.tree.dndSource.checkAcceptance

  • parameters:
    • source: (typeof dijit.tree.dndSource)

      The source which provides items

    • nodes: (typeof DOMNode[])

      Array of DOM nodes corresponding to nodes being dropped, dijitTreeRow nodes if
      source is a dijit.Tree.

  • returns

    Boolean

  • summary

    Checks if the target can accept nodes from this source

  • tags: extension
  • type

    Function

• dijit.tree.dndSource.copyState

  • parameters:
    • keyPressed: (typeof Boolean)

      The "copy" control key was pressed

  • returns

    Boolean

  • summary

    Returns true, if we need to copy items, false to move.
    It is separated to be overwritten dynamically, if needed.

  • tags:
  • type

    Function

• dijit.tree.dndSource.destroy

  • summary

    Prepares the object to be garbage-collected.

  • type

    Function

• dijit.tree.dndSource.targetAnchor

  • type

    Object

• dijit.tree.dndSource._onDragMouse

  • parameters:
    • e
  • summary

    Helper method for processing onmousemove/onmouseover events while drag is in progress.
    Keeps track of current drop target.

  • type

    Function

• dijit.tree.dndSource.current

• dijit.tree.dndSource.dropPosition

  • type

    String

• dijit.tree.dndSource.targetBox

  • type

    Object

• dijit.tree.dndSource.onMouseMove

  • parameters:
    • e: (typeof Event)

      onmousemouse event

  • summary

    Called for any onmousemove events over the Tree

  • tags:
  • type

    Function

• dijit.tree.dndSource.selection

• dijit.tree.dndSource.onMouseDown

  • parameters:
    • e: (typeof Event)

      onmousedown event

  • summary

    Event processor for onmousedown

  • tags:
  • type

    Function

• dijit.tree.dndSource.mouseDown

  • type

    bool

• dijit.tree.dndSource.mouseButton

• dijit.tree.dndSource._lastX

  • type

    Number

• dijit.tree.dndSource._lastY

  • type

    Number

• dijit.tree.dndSource.onMouseUp

  • parameters:
    • e: (typeof Event)

      onmouseup event

  • summary

    Event processor for onmouseup

  • tags:
  • type

    Function

• dijit.tree.dndSource.onMouseOut

  • summary

    Event processor for when mouse is moved away from a TreeNode

  • tags:
  • type

    Function

• dijit.tree.dndSource.checkItemAcceptance

  • parameters:
    • target: (typeof DOMNode)

      The dijitTreeRoot DOM node inside of the TreeNode that we are dropping on to
      Use dijit.getEnclosingWidget(target) to get the TreeNode.

    • source: (typeof dijit.tree.dndSource)

      The (set of) nodes we are dropping

    • position: (typeof String)

      "over", "before", or "after"

  • summary

    Stub function to be overridden if one wants to check for the ability to drop at the node/item level

  • description

    In the base case, this is called to check if target can become a child of source.
    When betweenThreshold is set, position="before" or "after" means that we
    are asking if the source node can be dropped before/after the target node.

  • tags: extension
  • type

    Function

• dijit.tree.dndSource.onDndSourceOver

  • parameters:
    • source: (typeof Object)

      The dijit.tree.dndSource / dojo.dnd.Source which has the mouse over it

  • summary

    Topic event processor for /dnd/source/over, called when detected a current source.

  • tags:
  • type

    Function

• dijit.tree.dndSource.onDndStart

  • parameters:
    • source: (typeof Object)

      The dijit.tree.dndSource / dojo.dnd.Source which is providing the items

    • nodes: (typeof DomNode[])

      The list of transferred items, dndTreeNode nodes if dragging from a Tree

    • copy: (typeof Boolean)

      Copy items, if true, move items otherwise

  • summary

    Topic event processor for /dnd/start, called to initiate the DnD operation

  • tags:
  • type

    Function

• dijit.tree.dndSource.isDragging

  • type

    bool

• dijit.tree.dndSource.itemCreator

  • parameters:
    • nodes: (typeof DomNode[])
    • target
    • source: (typeof dojo.dnd.Source)
  • summary

    Returns objects passed to <code>Tree.model.newItem()</code> based on DnD nodes
    dropped onto the tree.   Developer must override this method to enable
    dropping from external sources onto this Tree, unless the Tree.model's items
    happen to look like {id: 123, name: &quot;Apple&quot; } with no other attributes.

  • description

    For each node in nodes[], which came from source, create a hash of name/value
    pairs to be passed to Tree.model.newItem().  Returns array of those hashes.

  • return_summary

    Object[]
    Array of name/value hashes for each new item to be added to the Tree, like:
    	[
    		{ id: 123, label: "apple", foo: "bar" },
    		{ id: 456, label: "pear", zaz: "bam" }
    	]

  • tags: extension
  • type

    Function

• dijit.tree.dndSource.onDndDrop

  • parameters:
    • source: (typeof Object)

      The dijit.tree.dndSource / dojo.dnd.Source which is providing the items

    • nodes: (typeof DomNode[])

      The list of transferred items, dndTreeNode nodes if dragging from a Tree

    • copy: (typeof Boolean)

      Copy items, if true, move items otherwise

  • summary

    Topic event processor for /dnd/drop, called to finish the DnD operation.

  • description

    Updates data store items according to where node was dragged from and dropped
    to.   The tree will then respond to those data store updates and redraw itself.

  • tags:
  • type

    Function

• dijit.tree.dndSource.tree

• dijit.tree.dndSource.tree.model

• dijit.tree.dndSource.tree.item

• dijit.tree.dndSource.onDndCancel

  • summary

    Topic event processor for /dnd/cancel, called to cancel the DnD operation

  • tags:
  • type

    Function

• dijit.tree.dndSource.onOverEvent

  • summary

    This method is called when mouse is moved over our container (like onmouseenter)

  • tags:
  • type

    Function

• dijit.tree.dndSource.onOutEvent

  • summary

    This method is called when mouse is moved out of our container (like onmouseleave)

  • tags:
  • type

    Function

• dijit.tree.dndSource._isParentChildDrop

  • parameters:
    • source: (typeof The)

      DragSource object.

    • targetRow: (typeof The)

      tree row onto which the dragged nodes are being dropped.

  • summary

    Checks whether the dragged items are parent rows in the tree which are being
    dragged into their own children.

  • tags:
  • type

    Function

• dijit.tree.dndSource._unmarkTargetAnchor

  • summary

    Removes hover class of the current target anchor

  • tags:
  • type

    Function

• dijit.tree.dndSource._markDndStatus

  • parameters:
    • copy
  • summary

    Changes source's state based on "copy" status

  • type

    Function

• dijit.tree.dndSource.sourceState

  • type

    String

• dijit.tree.dndSource.targetState

  • type

    String

• dijit.tree.dndSource.topics

  • type

    Array

• dijit.tree.__SourceArgs

  • summary

    A dict of parameters for Tree source configuration.

  • type

    Function

• dijit.tree.__SourceArgs.isSource

  • optional
  • type

    Boolean

  • summary

    Can be used as a DnD source. Defaults to true.

• dijit.tree.__SourceArgs.accept

  • type

    String[]

  • summary

    List of accepted types (text strings) for a target; defaults to
    ["text", "treeNode"]

• dijit.tree.__SourceArgs.autoSync

• dijit.tree.__SourceArgs.copyOnly

  • optional
  • type

    Boolean

  • summary

    Copy items, if true, use a state of Ctrl key otherwise,

• dijit.tree.__SourceArgs.dragThreshold

  • type

    Number

  • summary

    The move delay in pixels before detecting a drag; 0 by default

• dijit.tree.__SourceArgs.betweenThreshold

  • type

    Integer

  • summary

    Distance from upper/lower edge of node to allow drop to reorder nodes

• dijit.tree

  • type

    Object

• dijit

  • type

    Object