X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/source/Tree.html diff --git a/docs/source/Tree.html b/docs/source/Tree.html index 1405a469..1636b966 100644 --- a/docs/source/Tree.html +++ b/docs/source/Tree.html @@ -1,5 +1,22 @@ -
+ +/** - * @class Ext.data.Tree + + + + +\ No newline at end of file +});The source code + + + + + + +/** + * @class Ext.data.Tree * * This class is used as a container for a series of nodes. The nodes themselves maintain * the relationship between parent/child. The tree itself acts as a manager. It gives functionality @@ -9,8 +26,6 @@ * centralized fashion. In general this class is not used directly, rather used internally * by other parts of the framework. * - * @constructor - * @param {Node} root (optional) The root node */ Ext.define('Ext.data.Tree', { alias: 'data.tree', @@ -19,12 +34,16 @@ Ext.define('Ext.data.Tree', { observable: "Ext.util.Observable" }, - /** + /** * The root node for this tree * @type Node */ root: null, - + + /** + * Creates new Tree object. + * @param {Node} root (optional) The root node + */ constructor: function(root) { var me = this; @@ -37,7 +56,7 @@ Ext.define('Ext.data.Tree', { } }, - /** + /** * Returns the root node for this tree. * @return {Ext.data.NodeInterface} */ @@ -45,7 +64,7 @@ Ext.define('Ext.data.Tree', { return this.root; }, - /** + /** * Sets the root node for this tree. * @param {Ext.data.NodeInterface} node * @return {Ext.data.NodeInterface} The root node @@ -61,7 +80,7 @@ Ext.define('Ext.data.Tree', { node.updateInfo(); me.relayEvents(node, [ - /** + /** * @event append * Fires when a new child node is appended to a node in this tree. * @param {Tree} tree The owner tree @@ -71,7 +90,7 @@ Ext.define('Ext.data.Tree', { */ "append", - /** + /** * @event remove * Fires when a child node is removed from a node in this tree. * @param {Tree} tree The owner tree @@ -80,7 +99,7 @@ Ext.define('Ext.data.Tree', { */ "remove", - /** + /** * @event move * Fires when a node is moved to a new location in the tree * @param {Tree} tree The owner tree @@ -91,7 +110,7 @@ Ext.define('Ext.data.Tree', { */ "move", - /** + /** * @event insert * Fires when a new child node is inserted in a node in this tree. * @param {Tree} tree The owner tree @@ -101,7 +120,7 @@ Ext.define('Ext.data.Tree', { */ "insert", - /** + /** * @event beforeappend * Fires before a new child is appended to a node in this tree, return false to cancel the append. * @param {Tree} tree The owner tree @@ -110,7 +129,7 @@ Ext.define('Ext.data.Tree', { */ "beforeappend", - /** + /** * @event beforeremove * Fires before a child is removed from a node in this tree, return false to cancel the remove. * @param {Tree} tree The owner tree @@ -119,7 +138,7 @@ Ext.define('Ext.data.Tree', { */ "beforeremove", - /** + /** * @event beforemove * Fires before a node is moved to a new location in the tree. Return false to cancel the move. * @param {Tree} tree The owner tree @@ -130,7 +149,7 @@ Ext.define('Ext.data.Tree', { */ "beforemove", - /** + /** * @event beforeinsert * Fires before a new child is inserted in a node in this tree, return false to cancel the insert. * @param {Tree} tree The owner tree @@ -140,35 +159,35 @@ Ext.define('Ext.data.Tree', { */ "beforeinsert", - /** + /** * @event expand * Fires when this node is expanded. * @param {Node} this The expanding node */ "expand", - /** + /** * @event collapse * Fires when this node is collapsed. * @param {Node} this The collapsing node */ "collapse", - /** + /** * @event beforeexpand * Fires before this node is expanded. * @param {Node} this The expanding node */ "beforeexpand", - /** + /** * @event beforecollapse * Fires before this node is collapsed. * @param {Node} this The collapsing node */ "beforecollapse" , - /** + /** * @event rootchange * Fires whenever the root node is changed in the tree. * @param {Ext.data.Model} root The new root @@ -191,7 +210,7 @@ Ext.define('Ext.data.Tree', { return node; }, - /** + /** * Flattens all the nodes in the tree into an array. * @private * @return {Array} The flattened nodes. @@ -209,7 +228,7 @@ Ext.define('Ext.data.Tree', { return nodes; }, - /** + /** * Fired when a node is inserted into the root or one of it's children * @private * @param {Ext.data.NodeInterface} parent The parent node @@ -219,7 +238,7 @@ Ext.define('Ext.data.Tree', { this.registerNode(node); }, - /** + /** * Fired when a node is appended into the root or one of it's children * @private * @param {Ext.data.NodeInterface} parent The parent node @@ -229,7 +248,7 @@ Ext.define('Ext.data.Tree', { this.registerNode(node); }, - /** + /** * Fired when a node is removed from the root or one of it's children * @private * @param {Ext.data.NodeInterface} parent The parent node @@ -239,7 +258,7 @@ Ext.define('Ext.data.Tree', { this.unregisterNode(node); }, - /** + /** * Gets a node in this tree by its id. * @param {String} id * @return {Ext.data.NodeInterface} The match node. @@ -248,7 +267,7 @@ Ext.define('Ext.data.Tree', { return this.nodeHash[id]; }, - /** + /** * Registers a node with the tree * @private * @param {Ext.data.NodeInterface} The node to register @@ -257,7 +276,7 @@ Ext.define('Ext.data.Tree', { this.nodeHash[node.getId() || node.internalId] = node; }, - /** + /** * Unregisters a node with the tree * @private * @param {Ext.data.NodeInterface} The node to unregister @@ -266,7 +285,7 @@ Ext.define('Ext.data.Tree', { delete this.nodeHash[node.getId() || node.internalId]; }, - /** + /** * Sorts this tree * @private * @param {Function} sorterFn The function to use for sorting @@ -276,7 +295,7 @@ Ext.define('Ext.data.Tree', { this.getRootNode().sort(sorterFn, recursive); }, - /** + /** * Filters this tree * @private * @param {Function} sorterFn The function to use for filtering @@ -285,4 +304,6 @@ Ext.define('Ext.data.Tree', { filter: function(filters, recursive) { this.getRootNode().filter(filters, recursive); } -});