Ticket #5912: tree_custom_nodetype.1.patch

tests/test_Tree.html

@@ -20 +20 @@
                 dojo.require("dijit.ColorPalette");
                 dojo.require("dijit.Menu");
                 dojo.require("dojo.parser");    // scan page for widgets and instantiate them
+
+        // Custom TreeNode implementation, useful for overriding templates,
+        // adding checkboxes, or doing other clever things.             
+        dojo.declare("MyNodeType", [dijit._TreeNode], {
+            // override something simple & obvious
+                setLabelNode: function(label){
+                        this.labelNode.innerHTML="";
+                        this.labelNode.appendChild(dojo.doc.createTextNode("[MYNODE] " + label));
+                }            
+        });
         </script>
 
 </head>
@@ -112 +122 @@
                         alert("Execute of node " + this.store.getLabel(item)
                                 +", population=" + continentStore.getValue(item, "population"));
                 </script>
-</div>
+    </div>
+    
+    <h2>A Tree with a custom TreeNode implementation</h2>
 
+    <p>Each label should start with "[MYNODE]"</p>
+        <div dojoType="dijit.Tree" id="customNodeTree"
+                store="continentStoreDecorated" labelAttr="name" childrenAttr="children"
+                openOnClick="true" nodeType="MyNodeType">
+                <script type="dojo/method" event="onClick" args="item">
+                        alert("Execute of node " + continentStore.getLabel(item)
+                                +", population=" + continentStore.getValue(item, "population"));
+                </script>
+        </div>
 </body>
 </html>

Tree.js

@@ -175 +175 @@
 
                         // Create _TreeNode widget for each specified tree node, unless one already
                         // exists and isn't being used (presumably it's from a DnD move and was recently
-                        // released
+                        // released. We use this.constructor() so that if we're not an actual TreeNode
+                        // it continues to work.
                         dojo.forEach(items, function(item){
                                 var id = store.getIdentity(item),
                                         existingNode = tree._itemNodeMap[id],
                                         node = 
                                                 ( existingNode && !existingNode.getParent() ) ?
                                                 existingNode :
-                                                new dijit._TreeNode({
+                                                new this.constructor({
                                                         item: item,
                                                         tree: this.tree,
                                                         isExpandable: this.tree.mayHaveChildren(item),
@@ -332 +333 @@
         onDndCancel:null,
         checkAcceptance:null,   
         checkItemAcceptance:null,
-
+        
+        // nodeType: Function
+        //  constructor function to use for the tree nodes, defaults to dijit._TreeNode
+        nodeType: dijit._TreeNode,
+        
         _publish: function(/*String*/ topicName, /*Object*/ message){
                 // summary:
                 //              Publish a message for this widget/topic
@@ -358 +363 @@
                         this.connect(this.store, "onDelete", "_onDeleteItem");
                         this.connect(this.store, "onSet", "_onSetItem");
                 }
+
+                // resolve a string nodeType into a function
+                if (dojo.isString(this.nodeType)) {
+                        this.nodeType = dojo.getObject(this.nodeType);
+                }
         },
 
         postCreate: function(){
@@ -409 +419 @@
                                         item = items[0];
                                 }
 
-                                var rn = this.rootNode = new dijit._TreeNode({
+                                var rn = this.rootNode = new this.nodeType({
                                         item: item,
                                         tree: this,
                                         isExpandable: true,