dijit/tree/model.js

  • Provides:

    • dijit.tree.model

  • 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

    • type
      Function
    • source: [view]
        // summary:
        //  Destroys this object, releasing connections to the store
        // tags:
        //  extension
    • summary
      Destroys this object, releasing connections to the store
    • tags:

  • dijit.tree.model.getRoot

    • type
      Function
    • parameters:
      • onItem: (typeof )
    • source: [view]
        // summary:
        //  Calls onItem with the root item for the tree, possibly a fabricated item.
        //  Throws exception on error.
        // tags:
        //  extension
    • summary
      Calls onItem with the root item for the tree, possibly a fabricated item.
Throws exception on error.
    • tags:

  • dijit.tree.model.mayHaveChildren

    • type
      Function
    • parameters:
      • item: (typeof dojo.data.Item)
    • source: [view]
        // 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
    • 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:

  • dijit.tree.model.getChildren

    • type
      Function
    • parameters:
      • parentItem: (typeof dojo.data.Item)
      • onComplete: (typeof function(items))
    • source: [view]
        // summary:
        //   Calls onComplete() with array of child items of given parent item, all loaded.
        //  Throws exception on error.
        // tags:
        //  extension
    • summary
      Calls onComplete() with array of child items of given parent item, all loaded.
Throws exception on error.
    • tags:

  • dijit.tree.model.isItem

    • type
      Function
    • parameters:
      • something: (typeof anything)
    • source: [view]
        // 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
    • 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:

  • dijit.tree.model.fetchItemByIdentity

    • type
      Function
    • parameters:
      • keywordArgs: (typeof object)
    • source: [view]
        // 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
    • 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:

  • dijit.tree.model.getIdentity

    • type
      Function
    • parameters:
      • item: (typeof item)
    • source: [view]
        // summary:
        //  Returns identity for an item
        // tags:
        //  extension
    • summary
      Returns identity for an item
    • tags:

  • dijit.tree.model.getLabel

    • type
      Function
    • parameters:
      • item: (typeof dojo.data.Item)
    • source: [view]
        // summary:
        //  Get the label for an item
        // tags:
        //  extension
    • summary
      Get the label for an item
    • tags:

  • dijit.tree.model.newItem

    • type
      Function
    • parameters:
      • args: (typeof dojo.dnd.Item)
      • parent: (typeof Item)
      • insertIndex: (typeof int)
    • source: [view]
        // summary:
        //  Creates a new item. See `dojo.data.api.Write` for details on args.
        // tags:
        //  extension
    • summary
      Creates a new item.   See `dojo.data.api.Write` for details on args.
    • tags:

  • dijit.tree.model.pasteItem

    • type
      Function
    • parameters:
      • childItem: (typeof Item)
      • oldParentItem: (typeof Item)
      • newParentItem: (typeof Item)
      • bCopy: (typeof Boolean)
    • source: [view]
        // 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
    • 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:

  • dijit.tree.model.onChange

    • type
      Function
    • parameters:
      • item: (typeof dojo.data.Item)
    • source: [view]
        // 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
    • 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:

  • dijit.tree.model.onChildrenChange

    • type
      Function
    • parameters:
      • parent: (typeof dojo.data.Item)
      • newChildrenList: (typeof dojo.data.Item[])
    • source: [view]
        // summary:
        //  Callback to do notifications about new, updated, or deleted items.
        // tags:
        //  callback
    • summary
      Callback to do notifications about new, updated, or deleted items.
    • tags:

  • dijit.tree

    • type
      Object
    • summary
  • dijit
       
    • type
      Object
    • summary