dojox/dnd/Selector.js

• Provides:

  • dojox.dnd.Selector

• Requires:

  • dojo.dnd.Selector in common

• dojox.dnd.Selector

  • type

    Function

  • chains:
    • dojo.dnd.Selector: (prototype)
    • dojo.dnd.Selector: (call)

• dojox.dnd.Selector.isSelected

  • parameters:
    • node: (typeof String|DomNode:)

      Node to check (id or DOM Node)

  • returns

    Boolean

  • summary

    checks if node is selected

  • type

    Function

• dojox.dnd.Selector.selectNode

  • parameters:
    • node: (typeof String|DomNode:)

      Node to select (id or DOM Node)

    • add: (typeof Boolean:)

      If true, node is added to selection, otherwise current
      selection is removed, and node will be the only selection.

  • returns

    self

  • summary

    selects a node

  • type

    Function

• dojox.dnd.Selector.anchor

  • type

    Object

• dojox.dnd.Selector.deselectNode

  • parameters:
    • node: (typeof String|DomNode:)

      Node to deselect (id or DOM Node)

  • returns

    self

  • summary

    deselects a node

  • type

    Function

• dojox.dnd.Selector.selectByBBox

  • parameters:
    • left: (typeof Number:)

      Left coordinate of the bounding box

    • top: (typeof Number:)

      Top coordinate of the bounding box

    • right: (typeof Number:)

      Right coordinate of the bounding box

    • bottom: (typeof Number:)

      Bottom coordinate of the bounding box

    • add: (typeof Boolean:)

      If true, node is added to selection, otherwise current
      selection is removed, and node will be the only selection.

  • returns

    self

  • summary

    selects nodes by bounding box

  • type

    Function

• dojox.dnd.Selector._isBoundedByBox

  • parameters:
    • node: (typeof String|DomNode:)

      Node to check (id or DOM Node)

    • left: (typeof Number:)

      Left coordinate of the bounding box

    • top: (typeof Number:)

      Top coordinate of the bounding box

    • right: (typeof Number:)

      Right coordinate of the bounding box

    • bottom: (typeof Number:)

      Bottom coordinate of the bounding box

  • returns

    Boolean

  • summary

    figures out whether certain coodinates bound a particular
    dom node.

  • type

    Function

• dojox.dnd.Selector.shift

  • parameters:
    • toNext: (typeof Boolean:)

      If true, we select the next node, otherwise the previous one.

    • add: (typeof Boolean:)

      If true, add to selection, otherwise current selection is
      removed before adding any nodes.

  • summary

    shifts the currently selected dnd item forwards and backwards.
    One possible use would be to allow a user select different
    dnd items using the right and left keys.

  • type

    Function

• dojox.dnd.Selector._getNodeId

  • parameters:
    • nodeId: (typeof String:)

      the id of the node to use as the base node

    • toNext: (typeof Boolean:)

      If true, we select the next node, otherwise the previous one.

  • summary

    finds a next/previous node in relation to nodeId

  • type

    Function

• dojox.dnd

  • type

    Object

• dojox

  • type

    Object