dijit/tree/_dndSelector.js

• Provides:

  • dijit.tree._dndSelector

• Requires:

  • dojo.dnd.common in common
  • dijit.tree._dndContainer in common

• dijit.tree._dndSelector

  • type

    Function

  • chains:
    • dijit.tree._dndContainer: (prototype)
    • dijit.tree._dndContainer: (call)
  • parameters:
    • tree
    • params
  • summary

    This is a base class for <code>dijit.tree.dndSource</code> , and isn't meant to be used directly.
    It's based on <code>dojo.dnd.Selector</code>.

  • tags:

• dijit.tree._dndSelector.selection

  • type

    Hash<String,

  • summary

    DomNode>
    (id, DomNode) map for every TreeNode that's currently selected.
    The DOMNode is the TreeNode.rowNode.

• dijit.tree._dndSelector.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • tree
    • params
  • summary

    Initialization

  • tags:

• dijit.tree._dndSelector.singular

  • type

    Boolean

  • summary

    Allows selection of only one element, if true.
    Tree hasn't been tested in singular=true mode, unclear if it works.

• dijit.tree._dndSelector.getSelectedTreeNodes

  • summary

    Returns a list of selected node(s).
    Used by dndSource on the start of a drag.

  • tags:
  • type

    Function

• dijit.tree._dndSelector.selectNone

  • returns

    self

  • summary

    Unselects all items

  • tags:
  • type

    Function

• dijit.tree._dndSelector.destroy

  • summary

    Prepares the object to be garbage-collected

  • type

    Function

• dijit.tree._dndSelector.anchor

  • type

    Object

• dijit.tree._dndSelector.addTreeNode

  • parameters:
    • node: (typeof dijit._TreeNode)

      Node node to add

    • isAnchor: (typeof Boolean)

      Whether the node should become anchor.

  • type

    Function

• dijit.tree._dndSelector.removeTreeNode

  • parameters:
    • node: (typeof dijit._TreeNode)

      Node node to remove

  • type

    Function

• dijit.tree._dndSelector.isTreeNodeSelected

  • parameters:
    • node: (typeof dijit._TreeNode)

      Node the node to check whether it's in the current selection

  • type

    Function

• dijit.tree._dndSelector.setSelection

  • parameters:
    • newSelection: (typeof dijit._treeNode[])

      Node[] list of tree nodes to make selected

  • type

    Function

• dijit.tree._dndSelector._setDifference

  • parameters:
    • xs
    • ys
  • type

    Function

• dijit.tree._dndSelector._updateSelectionProperties

  • type

    Function

• dijit.tree._dndSelector.onMouseDown

  • parameters:
    • e: (typeof Event)

      mouse event

  • returns

    ignore right-click

  • summary

    Event processor for onmousedown

  • tags:
  • type

    Function

• dijit.tree._dndSelector.current

• dijit.tree._dndSelector.current.id

• dijit.tree._dndSelector._doDeselect

  • type

    bool

• dijit.tree._dndSelector.onMouseUp

  • parameters:
    • e: (typeof Event)

      mouse event

  • summary

    Event processor for onmouseup

  • tags:
  • type

    Function

• dijit.tree._dndSelector.onMouseMove

  • parameters:
    • e: (typeof Event)

      mouse event

  • type

    Function

• dijit.tree._dndSelector.userSelect

  • parameters:
    • node
    • multi: (typeof Boolean)

      Indicates whether this is meant to be a multi-select action (e.g. ctrl-click)

    • range: (typeof Boolean)

      Indicates whether this is meant to be a ranged action (e.g. shift-click)

  • summary

    Add or remove the given node from selection, responding
    to a user action such as a click or keypress.

  • tags:
  • type

    Function

• dijit.tree._dndSelector.forInSelectedItems

  • parameters:
    • f: (typeof Function)
    • o: (typeof Object)
  • summary

    Iterates over selected items;
    see <code>dojo.dnd.Container.forInItems()</code> for details

  • type

    Function

• dijit.tree

  • type

    Object

• dijit

  • type

    Object