dojo/dnd/Container.js

• Provides:

  • dojo.dnd.Container

• Requires:

  • dojo.dnd.common in common
  • dojo.parser in common

• dojo.dnd.__ContainerArgs

  • type

    Function

• dojo.dnd.__ContainerArgs.creator

  • summary

    a creator function, which takes a data item, and returns an object like that:
    {node: newNode, data: usedData, type: arrayOfStrings}

  • type

    Function

• dojo.dnd.__ContainerArgs.skipForm

  • type

    Boolean

  • summary

    don't start the drag operation, if clicked on form elements

• dojo.dnd.__ContainerArgs.dropParent

  • type

    Node||String

  • summary

    node or node's id to use as the parent node for dropped items
    (must be underneath the 'node' parameter in the DOM)

• dojo.dnd.__ContainerArgs._skipStartup

  • type

    Boolean

  • summary

    skip startup(), which collects children, for deferred initialization
    (this is used in the markup mode)

• dojo.dnd.Container

  • type

    Function

  • parameters:
    • node: (typeof Node)

      node or node's id to build the container on

    • params: (typeof dojo.dnd.__ContainerArgs)

      a dictionary of parameters

  • summary

    a Container object, which knows when mouse hovers over it,
    and over which element it hovers

• dojo.dnd.Container.skipForm

  • type

    bool

• dojo.dnd.Container.current

  • type

    DomNode

  • summary

    The DOM node the mouse is currently hovered over

• dojo.dnd.Container.map

  • type

    Hash<String,

  • summary

    dojo.dnd.Item>
    Map from an item's id (which is also the DOMNode's id) to
    the dojo.dnd.Item itself.

• dojo.dnd.Container.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • node: (typeof Node)

      node or node's id to build the container on

    • params: (typeof dojo.dnd.__ContainerArgs)

      a dictionary of parameters

  • summary

    a constructor of the Container

• dojo.dnd.Container.creator

  • summary

    creator function, dummy at the moment

  • type

    Object

• dojo.dnd.Container.getItem

  • parameters:
    • key: (typeof String)
  • returns

    dojo.dnd.Item

  • summary

    returns a data item by its key (id)

  • type

    Function

• dojo.dnd.Container.setItem

  • parameters:
    • key: (typeof String)
    • data: (typeof dojo.dnd.Item)
  • summary

    associates a data item with its key (id)

  • type

    Function

• dojo.dnd.Container.delItem

  • parameters:
    • key: (typeof String)
  • summary

    removes a data item from the map by its key (id)

  • type

    Function

• dojo.dnd.Container.forInItems

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

    Object

  • summary

    iterates over a data map skipping members that
    are present in the empty object (IE and/or 3rd-party libraries).

  • type

    Function

• dojo.dnd.Container.clearItems

  • summary

    removes all data items from the map

  • type

    Function

• dojo.dnd.Container.getAllNodes

  • returns

    NodeList

  • summary

    returns a list (an array) of all valid child nodes

  • type

    Function

• dojo.dnd.Container.sync

  • returns

    self

  • summary

    sync up the node list with the data map

  • type

    Function

• dojo.dnd.Container.insertNodes

  • parameters:
    • data: (typeof Array)

      a list of data items, which should be processed by the creator function

    • before: (typeof Boolean)

      insert before the anchor, if true, and after the anchor otherwise

    • anchor: (typeof Node)

      the anchor node to be used as a point of insertion

  • returns

    self

  • summary

    inserts an array of new nodes before/after an anchor node

  • type

    Function

• dojo.dnd.Container.destroy

  • summary

    prepares this object to be garbage-collected

  • type

    Function

• dojo.dnd.Container.node

  • type

    Node

  • summary

    node or node's id to build the container on
    params: dojo.dnd.__ContainerArgs
    a dictionary of parameters

• dojo.dnd.Container.parent

  • type

    Object

• dojo.dnd.Container.markupFactory

  • parameters:
    • params
    • node
  • type

    Function

• dojo.dnd.Container.startup

  • summary

    collects valid child items and populate the map

  • type

    Function

• dojo.dnd.Container.defaultCreator

  • type

    Object

• dojo.dnd.Container.onMouseOver

  • parameters:
    • e: (typeof Event)

      mouse event

  • summary

    event processor for onmouseover

  • type

    Function

• dojo.dnd.Container.onMouseOut

  • parameters:
    • e: (typeof Event)

      mouse event

  • summary

    event processor for onmouseout

  • type

    Function

• dojo.dnd.Container.onSelectStart

  • parameters:
    • e: (typeof Event)

      mouse event

  • summary

    event processor for onselectevent and ondragevent

  • type

    Function

• dojo.dnd.Container.onOverEvent

  • summary

    this function is called once, when mouse is over our container

  • type

    Function

• dojo.dnd.Container.onOutEvent

  • summary

    this function is called once, when mouse is out of our container

  • type

    Function

• dojo.dnd.Container._changeState

  • parameters:
    • type: (typeof String)

      a name of the state to change

    • newState: (typeof String)

      new state

  • summary

    changes a named state to new state value

  • type

    Function

• dojo.dnd.Container._addItemClass

  • parameters:
    • node: (typeof Node)

      a node

    • type: (typeof String)

      a variable suffix for a class name

  • summary

    adds a class with prefix "dojoDndItem"

  • type

    Function

• dojo.dnd.Container._removeItemClass

  • parameters:
    • node: (typeof Node)

      a node

    • type: (typeof String)

      a variable suffix for a class name

  • summary

    removes a class with prefix "dojoDndItem"

  • type

    Function

• dojo.dnd.Container._getChildByEvent

  • parameters:
    • e: (typeof Event)

      a mouse event

  • summary

    gets a child, which is under the mouse at the moment, or null

  • type

    Function

• dojo.dnd.Container._normalizedCreator

  • parameters:
    • item: (typeof dojo.dnd.Item)
    • hint: (typeof String)
  • summary

    adds all necessary data to the output of the user-supplied creator function

  • type

    Function

• dojo.dnd.Container.containerState

  • type

    String

• dojo.dnd.Container.events

  • type

    Array

• dojo.dnd.Item

  • summary

    Represents (one of) the source node(s) being dragged.
    Contains (at least) the "type" and "data" attributes.

  • type

    Function

• dojo.dnd.Item.type

  • type

    String[]

  • summary

    Type(s) of this item, by default this is ["text"]

• dojo.dnd.Item.data

  • type

    Object

  • summary

    Logical representation of the object being dragged.
    If the drag object's type is "text" then data is a String,
    if it's another type then data could be a different Object,
    perhaps a name/value hash.

• dojo.dnd._createNode

  • parameters:
    • tag: (typeof String)

      a tag name or empty for SPAN

  • returns

    Function|Node

  • summary

    returns a function, which creates an element of given tag
    (SPAN by default) and sets its innerHTML to given text

  • type

    Function

• dojo.dnd._createTrTd

  • parameters:
    • text: (typeof String)

      a text for TD

  • returns

    Node

  • summary

    creates a TR/TD structure with given text as an innerHTML of TD

  • type

    Function

• dojo.dnd._createSpan

  • parameters:
    • text: (typeof String)

      a text for SPAN

  • returns

    Node

  • summary

    creates a SPAN element with given text as its innerHTML

  • type

    Function

• dojo.dnd._defaultCreatorNodes

  • type

    Object

• dojo.dnd._defaultCreatorNodes.ul

  • type

    String

• dojo.dnd._defaultCreatorNodes.ol

  • type

    String

• dojo.dnd._defaultCreatorNodes.div

  • type

    String

• dojo.dnd._defaultCreatorNodes.p

  • type

    String

• dojo.dnd._defaultCreator

  • parameters:
    • node: (typeof Node)

      a container node

  • returns

    Function

  • summary

    takes a parent node, and returns an appropriate creator function

  • type

    Function

• dojo.dnd

  • type

    Object

• dojo

  • type

    Object