src/widgets/tree/TreeNode.js

   1 /*!
   2  * Ext JS Library 3.0.0
   3  * Copyright(c) 2006-2009 Ext JS, LLC
   4  * licensing@extjs.com
   5  * http://www.extjs.com/license
   6  */
   7 /**\r
   8  * @class Ext.tree.TreeNode\r
   9  * @extends Ext.data.Node\r
  10  * @cfg {String} text The text for this node\r
  11  * @cfg {Boolean} expanded true to start the node expanded\r
  12  * @cfg {Boolean} allowDrag False to make this node undraggable if {@link #draggable} = true (defaults to true)\r
  13  * @cfg {Boolean} allowDrop False if this node cannot have child nodes dropped on it (defaults to true)\r
  14  * @cfg {Boolean} disabled true to start the node disabled\r
  15  * @cfg {String} icon The path to an icon for the node. The preferred way to do this\r
  16  * is to use the cls or iconCls attributes and add the icon via a CSS background image.\r
  17  * @cfg {String} cls A css class to be added to the node\r
  18  * @cfg {String} iconCls A css class to be added to the nodes icon element for applying css background images\r
  19  * @cfg {String} href URL of the link used for the node (defaults to #)\r
  20  * @cfg {String} hrefTarget target frame for the link\r
  21  * @cfg {Boolean} hidden True to render hidden. (Defaults to false).\r
  22  * @cfg {String} qtip An Ext QuickTip for the node\r
  23  * @cfg {Boolean} expandable If set to true, the node will always show a plus/minus icon, even when empty\r
  24  * @cfg {String} qtipCfg An Ext QuickTip config for the node (used instead of qtip)\r
  25  * @cfg {Boolean} singleClickExpand True for single click expand on this node\r
  26  * @cfg {Function} uiProvider A UI <b>class</b> to use for this node (defaults to Ext.tree.TreeNodeUI)\r
  27  * @cfg {Boolean} checked True to render a checked checkbox for this node, false to render an unchecked checkbox\r
  28  * (defaults to undefined with no checkbox rendered)\r
  29  * @cfg {Boolean} draggable True to make this node draggable (defaults to false)\r
  30  * @cfg {Boolean} isTarget False to not allow this node to act as a drop target (defaults to true)\r
  31  * @cfg {Boolean} allowChildren False to not allow this node to have child nodes (defaults to true)\r
  32  * @cfg {Boolean} editable False to not allow this node to be edited by an (@link Ext.tree.TreeEditor} (defaults to true)\r
  33  * @constructor\r
  34  * @param {Object/String} attributes The attributes/config for the node or just a string with the text for the node\r
  35  */\r
  36 Ext.tree.TreeNode = function(attributes){\r
  37     attributes = attributes || {};\r
  38     if(typeof attributes == "string"){\r
  39         attributes = {text: attributes};\r
  40     }\r
  41     this.childrenRendered = false;\r
  42     this.rendered = false;\r
  43     Ext.tree.TreeNode.superclass.constructor.call(this, attributes);\r
  44     this.expanded = attributes.expanded === true;\r
  45     this.isTarget = attributes.isTarget !== false;\r
  46     this.draggable = attributes.draggable !== false && attributes.allowDrag !== false;\r
  47     this.allowChildren = attributes.allowChildren !== false && attributes.allowDrop !== false;\r
  48 \r
  49     /**\r
  50      * Read-only. The text for this node. To change it use setText().\r
  51      * @type String\r
  52      */\r
  53     this.text = attributes.text;\r
  54     /**\r
  55      * True if this node is disabled.\r
  56      * @type Boolean\r
  57      */\r
  58     this.disabled = attributes.disabled === true;\r
  59     /**\r
  60      * True if this node is hidden.\r
  61      * @type Boolean\r
  62      */\r
  63     this.hidden = attributes.hidden === true;\r
  64 \r
  65     this.addEvents(\r
  66         /**\r
  67         * @event textchange\r
  68         * Fires when the text for this node is changed\r
  69         * @param {Node} this This node\r
  70         * @param {String} text The new text\r
  71         * @param {String} oldText The old text\r
  72         */\r
  73         "textchange",\r
  74         /**\r
  75         * @event beforeexpand\r
  76         * Fires before this node is expanded, return false to cancel.\r
  77         * @param {Node} this This node\r
  78         * @param {Boolean} deep\r
  79         * @param {Boolean} anim\r
  80         */\r
  81         "beforeexpand",\r
  82         /**\r
  83         * @event beforecollapse\r
  84         * Fires before this node is collapsed, return false to cancel.\r
  85         * @param {Node} this This node\r
  86         * @param {Boolean} deep\r
  87         * @param {Boolean} anim\r
  88         */\r
  89         "beforecollapse",\r
  90         /**\r
  91         * @event expand\r
  92         * Fires when this node is expanded\r
  93         * @param {Node} this This node\r
  94         */\r
  95         "expand",\r
  96         /**\r
  97         * @event disabledchange\r
  98         * Fires when the disabled status of this node changes\r
  99         * @param {Node} this This node\r
 100         * @param {Boolean} disabled\r
 101         */\r
 102         "disabledchange",\r
 103         /**\r
 104         * @event collapse\r
 105         * Fires when this node is collapsed\r
 106         * @param {Node} this This node\r
 107         */\r
 108         "collapse",\r
 109         /**\r
 110         * @event beforeclick\r
 111         * Fires before click processing. Return false to cancel the default action.\r
 112         * @param {Node} this This node\r
 113         * @param {Ext.EventObject} e The event object\r
 114         */\r
 115         "beforeclick",\r
 116         /**\r
 117         * @event click\r
 118         * Fires when this node is clicked\r
 119         * @param {Node} this This node\r
 120         * @param {Ext.EventObject} e The event object\r
 121         */\r
 122         "click",\r
 123         /**\r
 124         * @event checkchange\r
 125         * Fires when a node with a checkbox's checked property changes\r
 126         * @param {Node} this This node\r
 127         * @param {Boolean} checked\r
 128         */\r
 129         "checkchange",\r
 130         /**\r
 131         * @event dblclick\r
 132         * Fires when this node is double clicked\r
 133         * @param {Node} this This node\r
 134         * @param {Ext.EventObject} e The event object\r
 135         */\r
 136         "dblclick",\r
 137         /**\r
 138         * @event contextmenu\r
 139         * Fires when this node is right clicked\r
 140         * @param {Node} this This node\r
 141         * @param {Ext.EventObject} e The event object\r
 142         */\r
 143         "contextmenu",\r
 144         /**\r
 145         * @event beforechildrenrendered\r
 146         * Fires right before the child nodes for this node are rendered\r
 147         * @param {Node} this This node\r
 148         */\r
 149         "beforechildrenrendered"\r
 150     );\r
 151 \r
 152     var uiClass = this.attributes.uiProvider || this.defaultUI || Ext.tree.TreeNodeUI;\r
 153 \r
 154     /**\r
 155      * Read-only. The UI for this node\r
 156      * @type TreeNodeUI\r
 157      */\r
 158     this.ui = new uiClass(this);\r
 159 };\r
 160 Ext.extend(Ext.tree.TreeNode, Ext.data.Node, {\r
 161     preventHScroll: true,\r
 162     /**\r
 163      * Returns true if this node is expanded\r
 164      * @return {Boolean}\r
 165      */\r
 166     isExpanded : function(){\r
 167         return this.expanded;\r
 168     },\r
 169 \r
 170 /**\r
 171  * Returns the UI object for this node.\r
 172  * @return {TreeNodeUI} The object which is providing the user interface for this tree\r
 173  * node. Unless otherwise specified in the {@link #uiProvider}, this will be an instance\r
 174  * of {@link Ext.tree.TreeNodeUI}\r
 175  */\r
 176     getUI : function(){\r
 177         return this.ui;\r
 178     },\r
 179 \r
 180     getLoader : function(){\r
 181         var owner;\r
 182         return this.loader || ((owner = this.getOwnerTree()) && owner.loader ? owner.loader : new Ext.tree.TreeLoader());\r
 183     },\r
 184 \r
 185     // private override\r
 186     setFirstChild : function(node){\r
 187         var of = this.firstChild;\r
 188         Ext.tree.TreeNode.superclass.setFirstChild.call(this, node);\r
 189         if(this.childrenRendered && of && node != of){\r
 190             of.renderIndent(true, true);\r
 191         }\r
 192         if(this.rendered){\r
 193             this.renderIndent(true, true);\r
 194         }\r
 195     },\r
 196 \r
 197     // private override\r
 198     setLastChild : function(node){\r
 199         var ol = this.lastChild;\r
 200         Ext.tree.TreeNode.superclass.setLastChild.call(this, node);\r
 201         if(this.childrenRendered && ol && node != ol){\r
 202             ol.renderIndent(true, true);\r
 203         }\r
 204         if(this.rendered){\r
 205             this.renderIndent(true, true);\r
 206         }\r
 207     },\r
 208 \r
 209     // these methods are overridden to provide lazy rendering support\r
 210     // private override\r
 211     appendChild : function(n){\r
 212         if(!n.render && !Ext.isArray(n)){\r
 213             n = this.getLoader().createNode(n);\r
 214         }\r
 215         var node = Ext.tree.TreeNode.superclass.appendChild.call(this, n);\r
 216         if(node && this.childrenRendered){\r
 217             node.render();\r
 218         }\r
 219         this.ui.updateExpandIcon();\r
 220         return node;\r
 221     },\r
 222 \r
 223     // private override\r
 224     removeChild : function(node){\r
 225         this.ownerTree.getSelectionModel().unselect(node);\r
 226         Ext.tree.TreeNode.superclass.removeChild.apply(this, arguments);\r
 227         // if it's been rendered remove dom node\r
 228         if(this.childrenRendered){\r
 229             node.ui.remove();\r
 230         }\r
 231         if(this.childNodes.length < 1){\r
 232             this.collapse(false, false);\r
 233         }else{\r
 234             this.ui.updateExpandIcon();\r
 235         }\r
 236         if(!this.firstChild && !this.isHiddenRoot()) {\r
 237             this.childrenRendered = false;\r
 238         }\r
 239         return node;\r
 240     },\r
 241 \r
 242     // private override\r
 243     insertBefore : function(node, refNode){\r
 244         if(!node.render){ \r
 245             node = this.getLoader().createNode(node);\r
 246         }\r
 247         var newNode = Ext.tree.TreeNode.superclass.insertBefore.call(this, node, refNode);\r
 248         if(newNode && refNode && this.childrenRendered){\r
 249             node.render();\r
 250         }\r
 251         this.ui.updateExpandIcon();\r
 252         return newNode;\r
 253     },\r
 254 \r
 255     /**\r
 256      * Sets the text for this node\r
 257      * @param {String} text\r
 258      */\r
 259     setText : function(text){\r
 260         var oldText = this.text;\r
 261         this.text = text;\r
 262         this.attributes.text = text;\r
 263         if(this.rendered){ // event without subscribing\r
 264             this.ui.onTextChange(this, text, oldText);\r
 265         }\r
 266         this.fireEvent("textchange", this, text, oldText);\r
 267     },\r
 268 \r
 269     /**\r
 270      * Triggers selection of this node\r
 271      */\r
 272     select : function(){\r
 273         this.getOwnerTree().getSelectionModel().select(this);\r
 274     },\r
 275 \r
 276     /**\r
 277      * Triggers deselection of this node\r
 278      */\r
 279     unselect : function(){\r
 280         this.getOwnerTree().getSelectionModel().unselect(this);\r
 281     },\r
 282 \r
 283     /**\r
 284      * Returns true if this node is selected\r
 285      * @return {Boolean}\r
 286      */\r
 287     isSelected : function(){\r
 288         return this.getOwnerTree().getSelectionModel().isSelected(this);\r
 289     },\r
 290 \r
 291     /**\r
 292      * Expand this node.\r
 293      * @param {Boolean} deep (optional) True to expand all children as well\r
 294      * @param {Boolean} anim (optional) false to cancel the default animation\r
 295      * @param {Function} callback (optional) A callback to be called when\r
 296      * expanding this node completes (does not wait for deep expand to complete).\r
 297      * Called with 1 parameter, this node.\r
 298      * @param {Object} scope (optional) The scope in which to execute the callback.\r
 299      */\r
 300     expand : function(deep, anim, callback, scope){\r
 301         if(!this.expanded){\r
 302             if(this.fireEvent("beforeexpand", this, deep, anim) === false){\r
 303                 return;\r
 304             }\r
 305             if(!this.childrenRendered){\r
 306                 this.renderChildren();\r
 307             }\r
 308             this.expanded = true;\r
 309             if(!this.isHiddenRoot() && (this.getOwnerTree().animate && anim !== false) || anim){\r
 310                 this.ui.animExpand(function(){\r
 311                     this.fireEvent("expand", this);\r
 312                     this.runCallback(callback, scope || this, [this]);\r
 313                     if(deep === true){\r
 314                         this.expandChildNodes(true);\r
 315                     }\r
 316                 }.createDelegate(this));\r
 317                 return;\r
 318             }else{\r
 319                 this.ui.expand();\r
 320                 this.fireEvent("expand", this);\r
 321                 this.runCallback(callback, scope || this, [this]);\r
 322             }\r
 323         }else{\r
 324            this.runCallback(callback, scope || this, [this]);\r
 325         }\r
 326         if(deep === true){\r
 327             this.expandChildNodes(true);\r
 328         }\r
 329     },\r
 330     \r
 331     runCallback: function(cb, scope, args){\r
 332         if(Ext.isFunction(cb)){\r
 333             cb.apply(scope, args);\r
 334         }\r
 335     },\r
 336 \r
 337     isHiddenRoot : function(){\r
 338         return this.isRoot && !this.getOwnerTree().rootVisible;\r
 339     },\r
 340 \r
 341     /**\r
 342      * Collapse this node.\r
 343      * @param {Boolean} deep (optional) True to collapse all children as well\r
 344      * @param {Boolean} anim (optional) false to cancel the default animation\r
 345      * @param {Function} callback (optional) A callback to be called when\r
 346      * expanding this node completes (does not wait for deep expand to complete).\r
 347      * Called with 1 parameter, this node.\r
 348      * @param {Object} scope (optional) The scope in which to execute the callback.\r
 349      */\r
 350     collapse : function(deep, anim, callback, scope){\r
 351         if(this.expanded && !this.isHiddenRoot()){\r
 352             if(this.fireEvent("beforecollapse", this, deep, anim) === false){\r
 353                 return;\r
 354             }\r
 355             this.expanded = false;\r
 356             if((this.getOwnerTree().animate && anim !== false) || anim){\r
 357                 this.ui.animCollapse(function(){\r
 358                     this.fireEvent("collapse", this);\r
 359                     this.runCallback(callback, scope || this, [this]);\r
 360                     if(deep === true){\r
 361                         this.collapseChildNodes(true);\r
 362                     }\r
 363                 }.createDelegate(this));\r
 364                 return;\r
 365             }else{\r
 366                 this.ui.collapse();\r
 367                 this.fireEvent("collapse", this);\r
 368                 this.runCallback(callback, scope || this, [this]);\r
 369             }\r
 370         }else if(!this.expanded){\r
 371             this.runCallback(callback, scope || this, [this]);\r
 372         }\r
 373         if(deep === true){\r
 374             var cs = this.childNodes;\r
 375             for(var i = 0, len = cs.length; i < len; i++) {\r
 376                 cs[i].collapse(true, false);\r
 377             }\r
 378         }\r
 379     },\r
 380 \r
 381     // private\r
 382     delayedExpand : function(delay){\r
 383         if(!this.expandProcId){\r
 384             this.expandProcId = this.expand.defer(delay, this);\r
 385         }\r
 386     },\r
 387 \r
 388     // private\r
 389     cancelExpand : function(){\r
 390         if(this.expandProcId){\r
 391             clearTimeout(this.expandProcId);\r
 392         }\r
 393         this.expandProcId = false;\r
 394     },\r
 395 \r
 396     /**\r
 397      * Toggles expanded/collapsed state of the node\r
 398      */\r
 399     toggle : function(){\r
 400         if(this.expanded){\r
 401             this.collapse();\r
 402         }else{\r
 403             this.expand();\r
 404         }\r
 405     },\r
 406 \r
 407     /**\r
 408      * Ensures all parent nodes are expanded, and if necessary, scrolls\r
 409      * the node into view.\r
 410      * @param {Function} callback (optional) A function to call when the node has been made visible.\r
 411      * @param {Object} scope (optional) The scope in which to execute the callback.\r
 412      */\r
 413     ensureVisible : function(callback, scope){\r
 414         var tree = this.getOwnerTree();\r
 415         tree.expandPath(this.parentNode ? this.parentNode.getPath() : this.getPath(), false, function(){\r
 416             var node = tree.getNodeById(this.id);  // Somehow if we don't do this, we lose changes that happened to node in the meantime\r
 417             tree.getTreeEl().scrollChildIntoView(node.ui.anchor);\r
 418             this.runCallback(callback, scope || this, [this]);\r
 419         }.createDelegate(this));\r
 420     },\r
 421 \r
 422     /**\r
 423      * Expand all child nodes\r
 424      * @param {Boolean} deep (optional) true if the child nodes should also expand their child nodes\r
 425      */\r
 426     expandChildNodes : function(deep){\r
 427         var cs = this.childNodes;\r
 428         for(var i = 0, len = cs.length; i < len; i++) {\r
 429                 cs[i].expand(deep);\r
 430         }\r
 431     },\r
 432 \r
 433     /**\r
 434      * Collapse all child nodes\r
 435      * @param {Boolean} deep (optional) true if the child nodes should also collapse their child nodes\r
 436      */\r
 437     collapseChildNodes : function(deep){\r
 438         var cs = this.childNodes;\r
 439         for(var i = 0, len = cs.length; i < len; i++) {\r
 440                 cs[i].collapse(deep);\r
 441         }\r
 442     },\r
 443 \r
 444     /**\r
 445      * Disables this node\r
 446      */\r
 447     disable : function(){\r
 448         this.disabled = true;\r
 449         this.unselect();\r
 450         if(this.rendered && this.ui.onDisableChange){ // event without subscribing\r
 451             this.ui.onDisableChange(this, true);\r
 452         }\r
 453         this.fireEvent("disabledchange", this, true);\r
 454     },\r
 455 \r
 456     /**\r
 457      * Enables this node\r
 458      */\r
 459     enable : function(){\r
 460         this.disabled = false;\r
 461         if(this.rendered && this.ui.onDisableChange){ // event without subscribing\r
 462             this.ui.onDisableChange(this, false);\r
 463         }\r
 464         this.fireEvent("disabledchange", this, false);\r
 465     },\r
 466 \r
 467     // private\r
 468     renderChildren : function(suppressEvent){\r
 469         if(suppressEvent !== false){\r
 470             this.fireEvent("beforechildrenrendered", this);\r
 471         }\r
 472         var cs = this.childNodes;\r
 473         for(var i = 0, len = cs.length; i < len; i++){\r
 474             cs[i].render(true);\r
 475         }\r
 476         this.childrenRendered = true;\r
 477     },\r
 478 \r
 479     // private\r
 480     sort : function(fn, scope){\r
 481         Ext.tree.TreeNode.superclass.sort.apply(this, arguments);\r
 482         if(this.childrenRendered){\r
 483             var cs = this.childNodes;\r
 484             for(var i = 0, len = cs.length; i < len; i++){\r
 485                 cs[i].render(true);\r
 486             }\r
 487         }\r
 488     },\r
 489 \r
 490     // private\r
 491     render : function(bulkRender){\r
 492         this.ui.render(bulkRender);\r
 493         if(!this.rendered){\r
 494             // make sure it is registered\r
 495             this.getOwnerTree().registerNode(this);\r
 496             this.rendered = true;\r
 497             if(this.expanded){\r
 498                 this.expanded = false;\r
 499                 this.expand(false, false);\r
 500             }\r
 501         }\r
 502     },\r
 503 \r
 504     // private\r
 505     renderIndent : function(deep, refresh){\r
 506         if(refresh){\r
 507             this.ui.childIndent = null;\r
 508         }\r
 509         this.ui.renderIndent();\r
 510         if(deep === true && this.childrenRendered){\r
 511             var cs = this.childNodes;\r
 512             for(var i = 0, len = cs.length; i < len; i++){\r
 513                 cs[i].renderIndent(true, refresh);\r
 514             }\r
 515         }\r
 516     },\r
 517 \r
 518     beginUpdate : function(){\r
 519         this.childrenRendered = false;\r
 520     },\r
 521 \r
 522     endUpdate : function(){\r
 523         if(this.expanded && this.rendered){\r
 524             this.renderChildren();\r
 525         }\r
 526     },\r
 527 \r
 528     destroy : function(){\r
 529         if(this.childNodes){\r
 530             for(var i = 0,l = this.childNodes.length; i < l; i++){\r
 531                 this.childNodes[i].destroy();\r
 532             }\r
 533             this.childNodes = null;\r
 534         }\r
 535         if(this.ui.destroy){\r
 536             this.ui.destroy();\r
 537         }\r
 538     },\r
 539     \r
 540     // private\r
 541     onIdChange: function(id){\r
 542         this.ui.onIdChange(id);\r
 543     }\r
 544 });\r
 545 \r
 546 Ext.tree.TreePanel.nodeTypes.node = Ext.tree.TreeNode;