dijit/tree/model.js

• dijit.tree.model

  • type

    Function

  • summary

    Contract for any data provider object for the tree.

  • description

    Tree passes in values to the constructor to specify the callbacks.
    "item" is typically a dojo.data.Item but it's just a black box so
    it could be anything.
    
    This (like `dojo.data.api.Read`) is just documentation, and not meant to be used.

• dijit.tree.model.destroy

  • summary

    Destroys this object, releasing connections to the store

  • tags: extension
  • type

    Function

• dijit.tree.model.getRoot

  • parameters:
    • onItem
  • summary

    Calls onItem with the root item for the tree, possibly a fabricated item.
    Throws exception on error.

  • tags: extension
  • type

    Function

• dijit.tree.model.mayHaveChildren

  • parameters:
    • item: (typeof dojo.data.Item)
  • summary

    Tells if an item has or may have children.  Implementing logic here
    avoids showing +/- expando icon for nodes that we know don't have children.
    (For efficiency reasons we may not want to check if an element actually
    has children until user clicks the expando node)

  • tags: extension
  • type

    Function

• dijit.tree.model.getChildren

  • parameters:
    • parentItem: (typeof dojo.data.Item)
    • onComplete: (typeof function(items))
  • summary

    Calls onComplete() with array of child items of given parent item, all loaded.
    Throws exception on error.

  • tags: extension
  • type

    Function

• dijit.tree.model.isItem

  • parameters:
    • something: (typeof anything)
  • summary

    Returns true if *something* is an item and came from this model instance.
    Returns false if *something* is a literal, an item from another model instance,
    or is any object other than an item.

  • tags: extension
  • type

    Function

• dijit.tree.model.fetchItemByIdentity

  • parameters:
    • keywordArgs: (typeof object)
  • summary

    Given the identity of an item, this method returns the item that has
    that identity through the onItem callback.  Conforming implementations
    should return null if there is no item with the given identity.
    Implementations of fetchItemByIdentity() may sometimes return an item
    from a local cache and may sometimes fetch an item from a remote server.

  • tags: extension
  • type

    Function

• dijit.tree.model.getIdentity

  • parameters:
    • item: (typeof item)
  • summary

    Returns identity for an item

  • tags: extension
  • type

    Function

• dijit.tree.model.getLabel

  • parameters:
    • item: (typeof dojo.data.Item)
  • summary

    Get the label for an item

  • tags: extension
  • type

    Function

• dijit.tree.model.newItem

  • parameters:
    • args: (typeof dojo.dnd.Item)
    • parent: (typeof Item)
    • insertIndex: (typeof int)
  • summary

    Creates a new item.   See <code>dojo.data.api.Write</code> for details on args.

  • tags: extension
  • type

    Function

• dijit.tree.model.pasteItem

  • parameters:
    • childItem: (typeof Item)
    • oldParentItem: (typeof Item)
    • newParentItem: (typeof Item)
    • bCopy: (typeof Boolean)
  • summary

    Move or copy an item from one parent item to another.
    Used in drag & drop.
    If oldParentItem is specified and bCopy is false, childItem is removed from oldParentItem.
    If newParentItem is specified, childItem is attached to newParentItem.

  • tags: extension
  • type

    Function

• dijit.tree.model.onChange

  • parameters:
    • item: (typeof dojo.data.Item)
  • summary

    Callback whenever an item has changed, so that Tree
    can update the label, icon, etc.   Note that changes
    to an item's children or parent(s) will trigger an
    onChildrenChange() so you can ignore those changes here.

  • tags: callback
  • type

    Function

• dijit.tree.model.onChildrenChange

  • parameters:
    • parent: (typeof dojo.data.Item)
    • newChildrenList: (typeof dojo.data.Item[])
  • summary

    Callback to do notifications about new, updated, or deleted items.

  • tags: callback
  • type

    Function