Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / source / TreeNode.html
diff --git a/docs/source/TreeNode.html b/docs/source/TreeNode.html
new file mode 100644 (file)
index 0000000..ff39011
--- /dev/null
@@ -0,0 +1,549 @@
+<html>\r
+<head>\r
+  <title>The source code</title>\r
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body  onload="prettyPrint();">\r
+    <pre class="prettyprint lang-js"><div id="cls-Ext.tree.TreeNode"></div>/**\r
+ * @class Ext.tree.TreeNode\r
+ * @extends Ext.data.Node\r
+ * @cfg {String} text The text for this node\r
+ * @cfg {Boolean} expanded true to start the node expanded\r
+ * @cfg {Boolean} allowDrag False to make this node undraggable if {@link #draggable} = true (defaults to true)\r
+ * @cfg {Boolean} allowDrop False if this node cannot have child nodes dropped on it (defaults to true)\r
+ * @cfg {Boolean} disabled true to start the node disabled\r
+ * @cfg {String} icon The path to an icon for the node. The preferred way to do this\r
+ * is to use the cls or iconCls attributes and add the icon via a CSS background image.\r
+ * @cfg {String} cls A css class to be added to the node\r
+ * @cfg {String} iconCls A css class to be added to the nodes icon element for applying css background images\r
+ * @cfg {String} href URL of the link used for the node (defaults to #)\r
+ * @cfg {String} hrefTarget target frame for the link\r
+ * @cfg {Boolean} hidden True to render hidden. (Defaults to false).\r
+ * @cfg {String} qtip An Ext QuickTip for the node\r
+ * @cfg {Boolean} expandable If set to true, the node will always show a plus/minus icon, even when empty\r
+ * @cfg {String} qtipCfg An Ext QuickTip config for the node (used instead of qtip)\r
+ * @cfg {Boolean} singleClickExpand True for single click expand on this node\r
+ * @cfg {Function} uiProvider A UI <b>class</b> to use for this node (defaults to Ext.tree.TreeNodeUI)\r
+ * @cfg {Boolean} checked True to render a checked checkbox for this node, false to render an unchecked checkbox\r
+ * (defaults to undefined with no checkbox rendered)\r
+ * @cfg {Boolean} draggable True to make this node draggable (defaults to false)\r
+ * @cfg {Boolean} isTarget False to not allow this node to act as a drop target (defaults to true)\r
+ * @cfg {Boolean} allowChildren False to not allow this node to have child nodes (defaults to true)\r
+ * @cfg {Boolean} editable False to not allow this node to be edited by an (@link Ext.tree.TreeEditor} (defaults to true)\r
+ * @constructor\r
+ * @param {Object/String} attributes The attributes/config for the node or just a string with the text for the node\r
+ */\r
+Ext.tree.TreeNode = function(attributes){\r
+    attributes = attributes || {};\r
+    if(typeof attributes == "string"){\r
+        attributes = {text: attributes};\r
+    }\r
+    this.childrenRendered = false;\r
+    this.rendered = false;\r
+    Ext.tree.TreeNode.superclass.constructor.call(this, attributes);\r
+    this.expanded = attributes.expanded === true;\r
+    this.isTarget = attributes.isTarget !== false;\r
+    this.draggable = attributes.draggable !== false && attributes.allowDrag !== false;\r
+    this.allowChildren = attributes.allowChildren !== false && attributes.allowDrop !== false;\r
+\r
+    /**\r
+     * Read-only. The text for this node. To change it use setText().\r
+     * @type String\r
+     */\r
+    this.text = attributes.text;\r
+    /**\r
+     * True if this node is disabled.\r
+     * @type Boolean\r
+     */\r
+    this.disabled = attributes.disabled === true;\r
+    /**\r
+     * True if this node is hidden.\r
+     * @type Boolean\r
+     */\r
+    this.hidden = attributes.hidden === true;\r
+\r
+    this.addEvents(\r
+        /**\r
+        * @event textchange\r
+        * Fires when the text for this node is changed\r
+        * @param {Node} this This node\r
+        * @param {String} text The new text\r
+        * @param {String} oldText The old text\r
+        */\r
+        "textchange",\r
+        /**\r
+        * @event beforeexpand\r
+        * Fires before this node is expanded, return false to cancel.\r
+        * @param {Node} this This node\r
+        * @param {Boolean} deep\r
+        * @param {Boolean} anim\r
+        */\r
+        "beforeexpand",\r
+        /**\r
+        * @event beforecollapse\r
+        * Fires before this node is collapsed, return false to cancel.\r
+        * @param {Node} this This node\r
+        * @param {Boolean} deep\r
+        * @param {Boolean} anim\r
+        */\r
+        "beforecollapse",\r
+        /**\r
+        * @event expand\r
+        * Fires when this node is expanded\r
+        * @param {Node} this This node\r
+        */\r
+        "expand",\r
+        /**\r
+        * @event disabledchange\r
+        * Fires when the disabled status of this node changes\r
+        * @param {Node} this This node\r
+        * @param {Boolean} disabled\r
+        */\r
+        "disabledchange",\r
+        /**\r
+        * @event collapse\r
+        * Fires when this node is collapsed\r
+        * @param {Node} this This node\r
+        */\r
+        "collapse",\r
+        /**\r
+        * @event beforeclick\r
+        * Fires before click processing. Return false to cancel the default action.\r
+        * @param {Node} this This node\r
+        * @param {Ext.EventObject} e The event object\r
+        */\r
+        "beforeclick",\r
+        /**\r
+        * @event click\r
+        * Fires when this node is clicked\r
+        * @param {Node} this This node\r
+        * @param {Ext.EventObject} e The event object\r
+        */\r
+        "click",\r
+        /**\r
+        * @event checkchange\r
+        * Fires when a node with a checkbox's checked property changes\r
+        * @param {Node} this This node\r
+        * @param {Boolean} checked\r
+        */\r
+        "checkchange",\r
+        /**\r
+        * @event dblclick\r
+        * Fires when this node is double clicked\r
+        * @param {Node} this This node\r
+        * @param {Ext.EventObject} e The event object\r
+        */\r
+        "dblclick",\r
+        /**\r
+        * @event contextmenu\r
+        * Fires when this node is right clicked\r
+        * @param {Node} this This node\r
+        * @param {Ext.EventObject} e The event object\r
+        */\r
+        "contextmenu",\r
+        /**\r
+        * @event beforechildrenrendered\r
+        * Fires right before the child nodes for this node are rendered\r
+        * @param {Node} this This node\r
+        */\r
+        "beforechildrenrendered"\r
+    );\r
+\r
+    var uiClass = this.attributes.uiProvider || this.defaultUI || Ext.tree.TreeNodeUI;\r
+\r
+    /**\r
+     * Read-only. The UI for this node\r
+     * @type TreeNodeUI\r
+     */\r
+    this.ui = new uiClass(this);\r
+};\r
+Ext.extend(Ext.tree.TreeNode, Ext.data.Node, {\r
+    preventHScroll: true,\r
+    /**\r
+     * Returns true if this node is expanded\r
+     * @return {Boolean}\r
+     */\r
+    isExpanded : function(){\r
+        return this.expanded;\r
+    },\r
+\r
+/**\r
+ * Returns the UI object for this node.\r
+ * @return {TreeNodeUI} The object which is providing the user interface for this tree\r
+ * node. Unless otherwise specified in the {@link #uiProvider}, this will be an instance\r
+ * of {@link Ext.tree.TreeNodeUI}\r
+ */\r
+    getUI : function(){\r
+        return this.ui;\r
+    },\r
+\r
+    getLoader : function(){\r
+        var owner;\r
+        return this.loader || ((owner = this.getOwnerTree()) && owner.loader ? owner.loader : new Ext.tree.TreeLoader());\r
+    },\r
+\r
+    // private override\r
+    setFirstChild : function(node){\r
+        var of = this.firstChild;\r
+        Ext.tree.TreeNode.superclass.setFirstChild.call(this, node);\r
+        if(this.childrenRendered && of && node != of){\r
+            of.renderIndent(true, true);\r
+        }\r
+        if(this.rendered){\r
+            this.renderIndent(true, true);\r
+        }\r
+    },\r
+\r
+    // private override\r
+    setLastChild : function(node){\r
+        var ol = this.lastChild;\r
+        Ext.tree.TreeNode.superclass.setLastChild.call(this, node);\r
+        if(this.childrenRendered && ol && node != ol){\r
+            ol.renderIndent(true, true);\r
+        }\r
+        if(this.rendered){\r
+            this.renderIndent(true, true);\r
+        }\r
+    },\r
+\r
+    // these methods are overridden to provide lazy rendering support\r
+    // private override\r
+    appendChild : function(n){\r
+        if(!n.render && !Ext.isArray(n)){\r
+            n = this.getLoader().createNode(n);\r
+        }\r
+        var node = Ext.tree.TreeNode.superclass.appendChild.call(this, n);\r
+        if(node && this.childrenRendered){\r
+            node.render();\r
+        }\r
+        this.ui.updateExpandIcon();\r
+        return node;\r
+    },\r
+\r
+    // private override\r
+    removeChild : function(node){\r
+        this.ownerTree.getSelectionModel().unselect(node);\r
+        Ext.tree.TreeNode.superclass.removeChild.apply(this, arguments);\r
+        // if it's been rendered remove dom node\r
+        if(this.childrenRendered){\r
+            node.ui.remove();\r
+        }\r
+        if(this.childNodes.length < 1){\r
+            this.collapse(false, false);\r
+        }else{\r
+            this.ui.updateExpandIcon();\r
+        }\r
+        if(!this.firstChild && !this.isHiddenRoot()) {\r
+            this.childrenRendered = false;\r
+        }\r
+        return node;\r
+    },\r
+\r
+    // private override\r
+    insertBefore : function(node, refNode){\r
+        if(!node.render){ \r
+            node = this.getLoader().createNode(node);\r
+        }\r
+        var newNode = Ext.tree.TreeNode.superclass.insertBefore.call(this, node, refNode);\r
+        if(newNode && refNode && this.childrenRendered){\r
+            node.render();\r
+        }\r
+        this.ui.updateExpandIcon();\r
+        return newNode;\r
+    },\r
+\r
+    /**\r
+     * Sets the text for this node\r
+     * @param {String} text\r
+     */\r
+    setText : function(text){\r
+        var oldText = this.text;\r
+        this.text = text;\r
+        this.attributes.text = text;\r
+        if(this.rendered){ // event without subscribing\r
+            this.ui.onTextChange(this, text, oldText);\r
+        }\r
+        this.fireEvent("textchange", this, text, oldText);\r
+    },\r
+\r
+    /**\r
+     * Triggers selection of this node\r
+     */\r
+    select : function(){\r
+        this.getOwnerTree().getSelectionModel().select(this);\r
+    },\r
+\r
+    /**\r
+     * Triggers deselection of this node\r
+     */\r
+    unselect : function(){\r
+        this.getOwnerTree().getSelectionModel().unselect(this);\r
+    },\r
+\r
+    /**\r
+     * Returns true if this node is selected\r
+     * @return {Boolean}\r
+     */\r
+    isSelected : function(){\r
+        return this.getOwnerTree().getSelectionModel().isSelected(this);\r
+    },\r
+\r
+    /**\r
+     * Expand this node.\r
+     * @param {Boolean} deep (optional) True to expand all children as well\r
+     * @param {Boolean} anim (optional) false to cancel the default animation\r
+     * @param {Function} callback (optional) A callback to be called when\r
+     * expanding this node completes (does not wait for deep expand to complete).\r
+     * Called with 1 parameter, this node.\r
+     * @param {Object} scope (optional) The scope in which to execute the callback.\r
+     */\r
+    expand : function(deep, anim, callback, scope){\r
+        if(!this.expanded){\r
+            if(this.fireEvent("beforeexpand", this, deep, anim) === false){\r
+                return;\r
+            }\r
+            if(!this.childrenRendered){\r
+                this.renderChildren();\r
+            }\r
+            this.expanded = true;\r
+            if(!this.isHiddenRoot() && (this.getOwnerTree().animate && anim !== false) || anim){\r
+                this.ui.animExpand(function(){\r
+                    this.fireEvent("expand", this);\r
+                    this.runCallback(callback, scope || this, [this]);\r
+                    if(deep === true){\r
+                        this.expandChildNodes(true);\r
+                    }\r
+                }.createDelegate(this));\r
+                return;\r
+            }else{\r
+                this.ui.expand();\r
+                this.fireEvent("expand", this);\r
+                this.runCallback(callback, scope || this, [this]);\r
+            }\r
+        }else{\r
+           this.runCallback(callback, scope || this, [this]);\r
+        }\r
+        if(deep === true){\r
+            this.expandChildNodes(true);\r
+        }\r
+    },\r
+    \r
+    runCallback: function(cb, scope, args){\r
+        if(Ext.isFunction(cb)){\r
+            cb.apply(scope, args);\r
+        }\r
+    },\r
+\r
+    isHiddenRoot : function(){\r
+        return this.isRoot && !this.getOwnerTree().rootVisible;\r
+    },\r
+\r
+    /**\r
+     * Collapse this node.\r
+     * @param {Boolean} deep (optional) True to collapse all children as well\r
+     * @param {Boolean} anim (optional) false to cancel the default animation\r
+     * @param {Function} callback (optional) A callback to be called when\r
+     * expanding this node completes (does not wait for deep expand to complete).\r
+     * Called with 1 parameter, this node.\r
+     * @param {Object} scope (optional) The scope in which to execute the callback.\r
+     */\r
+    collapse : function(deep, anim, callback, scope){\r
+        if(this.expanded && !this.isHiddenRoot()){\r
+            if(this.fireEvent("beforecollapse", this, deep, anim) === false){\r
+                return;\r
+            }\r
+            this.expanded = false;\r
+            if((this.getOwnerTree().animate && anim !== false) || anim){\r
+                this.ui.animCollapse(function(){\r
+                    this.fireEvent("collapse", this);\r
+                    this.runCallback(callback, scope || this, [this]);\r
+                    if(deep === true){\r
+                        this.collapseChildNodes(true);\r
+                    }\r
+                }.createDelegate(this));\r
+                return;\r
+            }else{\r
+                this.ui.collapse();\r
+                this.fireEvent("collapse", this);\r
+                this.runCallback(callback, scope || this, [this]);\r
+            }\r
+        }else if(!this.expanded){\r
+            this.runCallback(callback, scope || this, [this]);\r
+        }\r
+        if(deep === true){\r
+            var cs = this.childNodes;\r
+            for(var i = 0, len = cs.length; i < len; i++) {\r
+               cs[i].collapse(true, false);\r
+            }\r
+        }\r
+    },\r
+\r
+    // private\r
+    delayedExpand : function(delay){\r
+        if(!this.expandProcId){\r
+            this.expandProcId = this.expand.defer(delay, this);\r
+        }\r
+    },\r
+\r
+    // private\r
+    cancelExpand : function(){\r
+        if(this.expandProcId){\r
+            clearTimeout(this.expandProcId);\r
+        }\r
+        this.expandProcId = false;\r
+    },\r
+\r
+    /**\r
+     * Toggles expanded/collapsed state of the node\r
+     */\r
+    toggle : function(){\r
+        if(this.expanded){\r
+            this.collapse();\r
+        }else{\r
+            this.expand();\r
+        }\r
+    },\r
+\r
+    /**\r
+     * Ensures all parent nodes are expanded, and if necessary, scrolls\r
+     * the node into view.\r
+     * @param {Function} callback (optional) A function to call when the node has been made visible.\r
+     * @param {Object} scope (optional) The scope in which to execute the callback.\r
+     */\r
+    ensureVisible : function(callback, scope){\r
+        var tree = this.getOwnerTree();\r
+        tree.expandPath(this.parentNode ? this.parentNode.getPath() : this.getPath(), false, function(){\r
+            var node = tree.getNodeById(this.id);  // Somehow if we don't do this, we lose changes that happened to node in the meantime\r
+            tree.getTreeEl().scrollChildIntoView(node.ui.anchor);\r
+            this.runCallback(callback, scope || this, [this]);\r
+        }.createDelegate(this));\r
+    },\r
+\r
+    /**\r
+     * Expand all child nodes\r
+     * @param {Boolean} deep (optional) true if the child nodes should also expand their child nodes\r
+     */\r
+    expandChildNodes : function(deep){\r
+        var cs = this.childNodes;\r
+        for(var i = 0, len = cs.length; i < len; i++) {\r
+               cs[i].expand(deep);\r
+        }\r
+    },\r
+\r
+    /**\r
+     * Collapse all child nodes\r
+     * @param {Boolean} deep (optional) true if the child nodes should also collapse their child nodes\r
+     */\r
+    collapseChildNodes : function(deep){\r
+        var cs = this.childNodes;\r
+        for(var i = 0, len = cs.length; i < len; i++) {\r
+               cs[i].collapse(deep);\r
+        }\r
+    },\r
+\r
+    /**\r
+     * Disables this node\r
+     */\r
+    disable : function(){\r
+        this.disabled = true;\r
+        this.unselect();\r
+        if(this.rendered && this.ui.onDisableChange){ // event without subscribing\r
+            this.ui.onDisableChange(this, true);\r
+        }\r
+        this.fireEvent("disabledchange", this, true);\r
+    },\r
+\r
+    /**\r
+     * Enables this node\r
+     */\r
+    enable : function(){\r
+        this.disabled = false;\r
+        if(this.rendered && this.ui.onDisableChange){ // event without subscribing\r
+            this.ui.onDisableChange(this, false);\r
+        }\r
+        this.fireEvent("disabledchange", this, false);\r
+    },\r
+\r
+    // private\r
+    renderChildren : function(suppressEvent){\r
+        if(suppressEvent !== false){\r
+            this.fireEvent("beforechildrenrendered", this);\r
+        }\r
+        var cs = this.childNodes;\r
+        for(var i = 0, len = cs.length; i < len; i++){\r
+            cs[i].render(true);\r
+        }\r
+        this.childrenRendered = true;\r
+    },\r
+\r
+    // private\r
+    sort : function(fn, scope){\r
+        Ext.tree.TreeNode.superclass.sort.apply(this, arguments);\r
+        if(this.childrenRendered){\r
+            var cs = this.childNodes;\r
+            for(var i = 0, len = cs.length; i < len; i++){\r
+                cs[i].render(true);\r
+            }\r
+        }\r
+    },\r
+\r
+    // private\r
+    render : function(bulkRender){\r
+        this.ui.render(bulkRender);\r
+        if(!this.rendered){\r
+            // make sure it is registered\r
+            this.getOwnerTree().registerNode(this);\r
+            this.rendered = true;\r
+            if(this.expanded){\r
+                this.expanded = false;\r
+                this.expand(false, false);\r
+            }\r
+        }\r
+    },\r
+\r
+    // private\r
+    renderIndent : function(deep, refresh){\r
+        if(refresh){\r
+            this.ui.childIndent = null;\r
+        }\r
+        this.ui.renderIndent();\r
+        if(deep === true && this.childrenRendered){\r
+            var cs = this.childNodes;\r
+            for(var i = 0, len = cs.length; i < len; i++){\r
+                cs[i].renderIndent(true, refresh);\r
+            }\r
+        }\r
+    },\r
+\r
+    beginUpdate : function(){\r
+        this.childrenRendered = false;\r
+    },\r
+\r
+    endUpdate : function(){\r
+        if(this.expanded && this.rendered){\r
+            this.renderChildren();\r
+        }\r
+    },\r
+\r
+    destroy : function(){\r
+        if(this.childNodes){\r
+            for(var i = 0,l = this.childNodes.length; i < l; i++){\r
+                this.childNodes[i].destroy();\r
+            }\r
+            this.childNodes = null;\r
+        }\r
+        if(this.ui.destroy){\r
+            this.ui.destroy();\r
+        }\r
+    },\r
+    \r
+    // private\r
+    onIdChange: function(id){\r
+        this.ui.onIdChange(id);\r
+    }\r
+});\r
+\r
+Ext.tree.TreePanel.nodeTypes.node = Ext.tree.TreeNode;</pre>    \r
+</body>\r
+</html>
\ No newline at end of file