Contract for any data provider object for the tree.
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.
Calls onComplete() with array of child items of given parent item, all loaded. Throws exception on error.
Parameter | Type | Description |
---|---|---|
parentItem | dojo/data/Item | |
onComplete | undefined |
Calls onItem with the root item for the tree, possibly a fabricated item. Throws exception on error.
Parameter | Type | Description |
---|---|---|
onItem | undefined |
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.
Parameter | Type | Description |
---|---|---|
something | undefined |
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)
Parameter | Type | Description |
---|---|---|
item | dojo/data/Item |
Creates a new item. See dojo/data/api/Write
for details on args.
Parameter | Type | Description |
---|---|---|
args | dijit/tree/dndSource.__Item | |
parent | Item | |
insertIndex | int |
Optional Allows to insert the new item as the n'th child of |
before | Item |
Optional Insert the new item as the previous sibling of this item. |
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.
Parameter | Type | Description |
---|---|---|
childItem | Item | |
oldParentItem | Item | |
newParentItem | Item | |
bCopy | Boolean | |
insertIndex | int |
Optional Allows to insert the new item as the n'th child of |
before | Item |
Optional Insert the new item as the previous sibling of this item. |
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.
Parameter | Type | Description |
---|---|---|
item | dojo/data/Item |
Callback to do notifications about new, updated, or deleted items.
Parameter | Type | Description |
---|---|---|
parent | dojo/data/Item | |
newChildrenList | dojo/data/Item[] |