X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/25ef3491bd9ae007ff1fc2b0d7943e6eaaccf775..10a866c12701c0a0afd0ac85dcdcf32a421514ac:/docs/source/TreePanel.html?ds=sidebyside diff --git a/docs/source/TreePanel.html b/docs/source/TreePanel.html index 4892cbbf..95723087 100644 --- a/docs/source/TreePanel.html +++ b/docs/source/TreePanel.html @@ -1,17 +1,12 @@ - - - The source code - - - - - 
/*!
- * Ext JS Library 3.0.3
- * Copyright(c) 2006-2009 Ext JS, LLC
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-
/**
+
+
+      
+  The source code
+    
+    
+
+
+    
/**
  * @class Ext.tree.TreePanel
  * @extends Ext.Panel
  * 
The TreePanel provides tree-structured UI representation of tree-structured data.

@@ -125,18 +120,19 @@ new Ext.Viewport({
  */
 Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
     rootVisible : true,
-    animate: Ext.enableFx,
+    animate : Ext.enableFx,
     lines : true,
     enableDD : false,
     hlDrop : Ext.enableFx,
-    pathSeparator: "/",
-    
+    pathSeparator : '/',
+
     /**
      * @cfg {Array} bubbleEvents
      * 
An array of events that, when fired, should be bubbled to any parent container.
-     * Defaults to ['add', 'remove'].
+     * See {@link Ext.util.Observable#enableBubble}.
+     * Defaults to [].
      */
-    bubbleEvents: [],
+    bubbleEvents : [],
 
     initComponent : function(){
         Ext.tree.TreePanel.superclass.initComponent.call(this);
@@ -152,7 +148,7 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
                 dataUrl: this.dataUrl,
                 requestMethod: this.requestMethod
             });
-        }else if(typeof l == 'object' && !l.load){
+        }else if(Ext.isObject(l) && !l.load){
             l = new Ext.tree.TreeLoader(l);
         }
         this.loader = l;
@@ -181,7 +177,7 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
             * @param {Node} node The newly appended node
             * @param {Number} index The index of the newly appended node
             */
-           "append",
+           'append',
            /**
             * @event remove
             * Fires when a child node is removed from a node in this tree.
@@ -189,7 +185,7 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
             * @param {Node} parent The parent node
             * @param {Node} node The child node removed
             */
-           "remove",
+           'remove',
            /**
             * @event movenode
             * Fires when a node is moved to a new location in the tree
@@ -199,7 +195,7 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
             * @param {Node} newParent The new parent of this node
             * @param {Number} index The index it was moved to
             */
-           "movenode",
+           'movenode',
            /**
             * @event insert
             * Fires when a new child node is inserted in a node in this tree.
@@ -208,7 +204,7 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
             * @param {Node} node The child node inserted
             * @param {Node} refNode The child node the node was inserted before
             */
-           "insert",
+           'insert',
            /**
             * @event beforeappend
             * Fires before a new child is appended to a node in this tree, return false to cancel the append.
@@ -216,7 +212,7 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
             * @param {Node} parent The parent node
             * @param {Node} node The child node to be appended
             */
-           "beforeappend",
+           'beforeappend',
            /**
             * @event beforeremove
             * Fires before a child is removed from a node in this tree, return false to cancel the remove.
@@ -224,7 +220,7 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
             * @param {Node} parent The parent node
             * @param {Node} node The child node to be removed
             */
-           "beforeremove",
+           'beforeremove',
            /**
             * @event beforemovenode
             * Fires before a node is moved to a new location in the tree. Return false to cancel the move.
@@ -234,7 +230,7 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
             * @param {Node} newParent The new parent the node is moving to
             * @param {Number} index The index it is being moved to
             */
-           "beforemovenode",
+           'beforemovenode',
            /**
             * @event beforeinsert
             * Fires before a new child is inserted in a node in this tree, return false to cancel the insert.
@@ -243,20 +239,20 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
             * @param {Node} node The child node to be inserted
             * @param {Node} refNode The child node the node is being inserted before
             */
-            "beforeinsert",
+            'beforeinsert',
 
             /**
             * @event beforeload
             * Fires before a node is loaded, return false to cancel
             * @param {Node} node The node being loaded
             */
-            "beforeload",
+            'beforeload',
             /**
             * @event load
             * Fires when a node is loaded
             * @param {Node} node The node that was loaded
             */
-            "load",
+            'load',
             /**
             * @event textchange
             * Fires when the text for a node is changed
@@ -264,7 +260,7 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
             * @param {String} text The new text
             * @param {String} oldText The old text
             */
-            "textchange",
+            'textchange',
             /**
             * @event beforeexpandnode
             * Fires before a node is expanded, return false to cancel.
@@ -272,7 +268,7 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
             * @param {Boolean} deep
             * @param {Boolean} anim
             */
-            "beforeexpandnode",
+            'beforeexpandnode',
             /**
             * @event beforecollapsenode
             * Fires before a node is collapsed, return false to cancel.
@@ -280,61 +276,75 @@ Ext.tree.TreePanel = Ext.extend(Ext.Panel, {
             * @param {Boolean} deep
             * @param {Boolean} anim
             */
-            "beforecollapsenode",
+            'beforecollapsenode',
             /**
             * @event expandnode
             * Fires when a node is expanded
             * @param {Node} node The node
             */
-            "expandnode",
+            'expandnode',
             /**
             * @event disabledchange
             * Fires when the disabled status of a node changes
             * @param {Node} node The node
             * @param {Boolean} disabled
             */
-            "disabledchange",
+            'disabledchange',
             /**
             * @event collapsenode
             * Fires when a node is collapsed
             * @param {Node} node The node
             */
-            "collapsenode",
+            'collapsenode',
             /**
             * @event beforeclick
             * Fires before click processing on a node. Return false to cancel the default action.
             * @param {Node} node The node
             * @param {Ext.EventObject} e The event object
             */
-            "beforeclick",
+            'beforeclick',
             /**
             * @event click
             * Fires when a node is clicked
             * @param {Node} node The node
             * @param {Ext.EventObject} e The event object
             */
-            "click",
+            'click',
+            /**
+            * @event containerclick
+            * Fires when the tree container is clicked
+            * @param {Tree} this
+            * @param {Ext.EventObject} e The event object
+            */
+            'containerclick',
             /**
             * @event checkchange
             * Fires when a node with a checkbox's checked property changes
             * @param {Node} this This node
             * @param {Boolean} checked
             */
-            "checkchange",
+            'checkchange',
             /**
             * @event beforedblclick
             * Fires before double click processing on a node. Return false to cancel the default action.
             * @param {Node} node The node
             * @param {Ext.EventObject} e The event object
             */
-            "beforedblclick",
+            'beforedblclick',
             /**
             * @event dblclick
             * Fires when a node is double clicked
             * @param {Node} node The node
             * @param {Ext.EventObject} e The event object
             */
-            "dblclick",
+            'dblclick',
+            /**
+            * @event containerdblclick
+            * Fires when the tree container is double clicked
+            * @param {Tree} this
+            * @param {Ext.EventObject} e The event object
+            */
+            'containerdblclick',
             /**
             * @event contextmenu
             * Fires when a node is right clicked. To display a context menu in response to this
@@ -382,13 +392,20 @@ new Ext.tree.TreePanel({
             * @param {Node} node The node
             * @param {Ext.EventObject} e The event object
             */
-            "contextmenu",
+            'contextmenu',
+            /**
+            * @event containercontextmenu
+            * Fires when the tree container is right clicked
+            * @param {Tree} this
+            * @param {Ext.EventObject} e The event object
+            */
+            'containercontextmenu',
             /**
             * @event beforechildrenrendered
             * Fires right before the child nodes for a node are rendered
             * @param {Node} node The node
             */
-            "beforechildrenrendered",
+            'beforechildrenrendered',
            /**
              * @event startdrag
              * Fires when a node starts being dragged
@@ -396,7 +413,7 @@ new Ext.tree.TreePanel({
              * @param {Ext.tree.TreeNode} node
              * @param {event} e The raw browser event
              */
-            "startdrag",
+            'startdrag',
             /**
              * @event enddrag
              * Fires when a drag operation is complete
@@ -404,7 +421,7 @@ new Ext.tree.TreePanel({
              * @param {Ext.tree.TreeNode} node
              * @param {event} e The raw browser event
              */
-            "enddrag",
+            'enddrag',
             /**
              * @event dragdrop
              * Fires when a dragged node is dropped on a valid DD target
@@ -413,7 +430,7 @@ new Ext.tree.TreePanel({
              * @param {DD} dd The dd it was dropped on
              * @param {event} e The raw browser event
              */
-            "dragdrop",
+            'dragdrop',
             /**
              * @event beforenodedrop
              * Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent
@@ -429,11 +446,11 @@ new Ext.tree.TreePanel({
              * to be inserted by setting them on this object.
              * 
  • cancel - Set this to true to cancel the drop.
    • 
              * 
  • dropStatus - If the default drop action is cancelled but the drop is valid, setting this to true
-             * will prevent the animated "repair" from appearing.
    • 
+             * will prevent the animated 'repair' from appearing.
              * 
              * @param {Object} dropEvent
              */
-            "beforenodedrop",
+            'beforenodedrop',
             /**
              * @event nodedrop
              * Fires after a DD object is dropped on a node in this tree. The dropEvent
@@ -449,7 +466,7 @@ new Ext.tree.TreePanel({
              * 
              * @param {Object} dropEvent
              */
-            "nodedrop",
+            'nodedrop',
              /**
              * @event nodedragover
              * Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
@@ -466,10 +483,10 @@ new Ext.tree.TreePanel({
              * 
              * @param {Object} dragOverEvent
              */
-            "nodedragover"
+            'nodedragover'
         );
         if(this.singleExpand){
-            this.on("beforeexpandnode", this.restrictExpand, this);
+            this.on('beforeexpandnode', this.restrictExpand, this);
         }
     },
 
@@ -538,7 +555,7 @@ new Ext.tree.TreePanel({
 
     // private
     toString : function(){
-        return "[Tree"+(this.id?" "+this.id:"")+"]";
+        return '[Tree'+(this.id?' '+this.id:'')+']';
     },
 
     // private
@@ -553,7 +570,7 @@ new Ext.tree.TreePanel({
     },
 
     /**
-     * Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. "id")
+     * Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. 'id')
      * @param {String} attribute (optional) Defaults to null (return the actual nodes)
      * @param {TreeNode} startNode (optional) The node to start from, defaults to the root
      * @return {Array}
@@ -570,14 +587,6 @@ new Ext.tree.TreePanel({
         return r;
     },
 
-    /**
-     * Returns the container element for this TreePanel.
-     * @return {Element} The container element for this TreePanel.
-     */
-    getEl : function(){
-        return this.el;
-    },
-
     /**
      * Returns the default {@link Ext.tree.TreeLoader} for this TreePanel.
      * @return {Ext.tree.TreeLoader} The TreeLoader for this TreePanel.
@@ -619,7 +628,7 @@ new Ext.tree.TreePanel({
      * (bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.
      */
     expandPath : function(path, attr, callback){
-        attr = attr || "id";
+        attr = attr || 'id';
         var keys = path.split(this.pathSeparator);
         var curNode = this.root;
         if(curNode.attributes[attr] != keys[1]){ // invalid root
@@ -657,7 +666,7 @@ new Ext.tree.TreePanel({
      * (bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.
      */
     selectPath : function(path, attr, callback){
-        attr = attr || "id";
+        attr = attr || 'id';
         var keys = path.split(this.pathSeparator),
             v = keys.pop();
         if(keys.length > 1){
@@ -699,9 +708,9 @@ new Ext.tree.TreePanel({
     onRender : function(ct, position){
         Ext.tree.TreePanel.superclass.onRender.call(this, ct, position);
         this.el.addClass('x-tree');
-        this.innerCt = this.body.createChild({tag:"ul",
-               cls:"x-tree-root-ct " +
-               (this.useArrows ? 'x-tree-arrows' : this.lines ? "x-tree-lines" : "x-tree-no-lines")});
+        this.innerCt = this.body.createChild({tag:'ul',
+               cls:'x-tree-root-ct ' +
+               (this.useArrows ? 'x-tree-arrows' : this.lines ? 'x-tree-lines' : 'x-tree-no-lines')});
     },
 
     // private
@@ -718,7 +727,7 @@ new Ext.tree.TreePanel({
             * @type Ext.tree.TreeDropZone
             */
              this.dropZone = new Ext.tree.TreeDropZone(this, this.dropConfig || {
-               ddGroup: this.ddGroup || "TreeDD", appendOnly: this.ddAppendOnly === true
+               ddGroup: this.ddGroup || 'TreeDD', appendOnly: this.ddAppendOnly === true
            });
         }
         if((this.enableDD || this.enableDrag) && !this.dragZone){
@@ -728,7 +737,7 @@ new Ext.tree.TreePanel({
             * @type Ext.tree.TreeDragZone
             */
             this.dragZone = new Ext.tree.TreeDragZone(this, this.dragConfig || {
-               ddGroup: this.ddGroup || "TreeDD",
+               ddGroup: this.ddGroup || 'TreeDD',
                scroll: this.ddScroll
            });
         }
@@ -744,20 +753,14 @@ new Ext.tree.TreePanel({
         }
     },
 
-    onDestroy : function(){
+    beforeDestroy : function(){
         if(this.rendered){
-            this.body.removeAllListeners();
             Ext.dd.ScrollManager.unregister(this.body);
-            if(this.dropZone){
-                this.dropZone.unreg();
-            }
-            if(this.dragZone){
-               this.dragZone.unreg();
-            }
+            Ext.destroy(this.dropZone, this.dragZone);
         }
-        this.root.destroy();
-        this.nodeHash = null;
-        Ext.tree.TreePanel.superclass.onDestroy.call(this);
+        Ext.destroy(this.root, this.loader);
+        this.nodeHash = this.root = this.loader = null;
+        Ext.tree.TreePanel.superclass.beforeDestroy.call(this);
     }
 
     /**
@@ -936,6 +939,6 @@ new Ext.tree.TreePanel({
 
 Ext.tree.TreePanel.nodeTypes = {};
 
-Ext.reg('treepanel', Ext.tree.TreePanel);
    
-
+Ext.reg('treepanel', Ext.tree.TreePanel);
    + \ No newline at end of file