Dojo树使用心得

感谢reedseutozte的投稿，一篇关于dijit.Tree的使用方法介绍，非常好的文章，也很能体现出Dojo的核心设计思想。作为最常用的一个控件，相信这篇文章能帮助到很多同学。再次感谢reedseutozte，为Dojo中文博客带来了第一篇投稿文章：）

概述

Dojo的dijit.tree的代码结构完全遵循MVC结构，结构非常严谨：

M：model使用了dojo基础包提供的dojo.data.itemFileReadStore（只读）或者dojo.data.itemFileWriteStore（可读写）。Tree并不直接使用Store而是通过dijit.tree.TreeStoreModel这个类将sotre和树形结构所需要的结构的进行串接。

V：view就是tree.js中定义的dijit.tree和dijit_TreeNode。这个类主要完成前台的界面渲染，以及树上节点对象之间的管理。

C：_dndSelector.js这个文件名称开始迷惑了我，后来才发现即使不使用拖拽特性，该类中的代码依然会被调用，这个类定义选中节点，删除节点，增加节点，托拽节点的操作。

网上关于tree 的资料根多，而且dojo自身也提供了丰富的样例，这里介绍一些其样例中没有涉及的一些用法。

树的懒加载(lazy load)
其实懒加载本身没什么太多的问题，只是有两点需要说明


图标处理
Dojo对于叶子／非叶子节点的图标处理时会做自动判断。在懒加载时由于有些节点没有加载子节点，dojo在处理这些节点的图标的时候会显示默认的叶子图标，所以这里需要重  新实现treemodel的mayHaveChildren方法，代码如下
[javascript]  view plain copy

1. var treeModel = new dijit.tree.ForestMode({    
2.     .......    
3. });    
4. treeModel.mayHaveChildren = function(item)    
5. {    
6.     //item为对应节点的数据项，该函数返回true表示该节点为非叶子节点，dojo就会为这个节点附着上非叶子图标    
7.     if(item.root)    
8.     {    
9.         return true;    
10.     }    
11.     else    
12.     {    
13.         //这里认为初始化树的时候对于每一个节点的数据项中都有type属性，根据属性判断    
14.         return (treeModel.store.getValue(item, 'type') != 'xxxx')    
15.     }    
16. }    

节点加载
 Dojo树最大的特点就是完全可以靠数据驱动，因此节点的加载，完全可以通过往对应的 父节点的数据项中增加childran实现，参见如如下代码：
[javascript]  view plain copy

1. var oldExpand = dijit.Tree.prototype._onExpandoClick;    
2. dojo.extend(dijit.Tree, {    
3.     _onExpandoClick: function(message)    
4.     {    
5.         var node = message.node;    
6.         reloadNode(node);    
7.         oldExpand.apply(this, arguments);    
8.     }    
9. });        
10. function reloadNode(node)    
11. {    
12.     var store = node.tree.model.store;    
13.     var nodeItem = node.item;    
14.     //假设我们通过这个方法从后台取得了改node的子节点数据    
15.     var dataList = getChildList();    
16.     dojo.forEach(dataList, function(x){    
17.         ......    
18.         x.type = 'yyy';    
19.         //以上的代码可以看需要添加,上面一行代码的作用是可以通过store.getValue方法访问该节点对应的item的type属性    
20.         store.newItem(x,{parent:nodeItem, attribute: 'children'});    
21.     });    
22. }    

增加／删除／修改节点
之前已经说过dojo的tree采用了MVC模式，因此上述操作完全可以通过对store的操作实现
1. 增加
上面的懒加载代码已经列出这里不再赘述

2. 修改：
  假设需要修改的节点的treeNode对象实例为node
[javascript]  view plain copy

1. tree.model.store.setValue(node.item, 'name'/*取决于定义store时的label属性*/, newName)    

3. 删除
假设需要删除的节点的treeNode对象实例为node
[javascript]  view plain copy

1. tree.model.store.deleteItem(node.item)    

鼠标函数
上面说了很多，可以发现所有操作都需要获取树节点对应的dojo对象才可以进行。那么这个对象如何获得呢？我们知道对树的操作分为两种，左键点击或者右键菜单，鼠标点中了相对应的节点就可继续往下操作，因此下面介绍如何通过鼠标事件获得节点对象

click
[javascript]  view plain copy

1. tree.connect(tree, 'onClick', clickTreeNode);    
2. function clickTreeNode(item/*点中节点对应的数据项*/, node/*点中的对象，这里node.item就是的第一个参数*/,evt/*事件*/)    
3. {    
4. ................    
5. }    

                        
rightClick
右击一般是打开菜单，这里的菜单也是dojo的，因此判断函数为
[javascript]  view plain copy

1. dojo.connect(pMenu, '_openMyself', function(e){    
2.     var node = dijit.getEnclosingWidget(e.target); /*node就是节点对象*/        
3. });    

代码选中节点
[javascript]  view plain copy

1. tree.dndController.setSelection([node])    

托拽控制
Dojo的树提供托拽功能，使用托拽功能需要在实例化tree的时候将tree的dndController属性定义为’dijit.tree.dndSource' 。betweenThreshold为0表示不允许同目录下拖动。

实际应用中我们要增加一些限制，这坐介绍两种

i）选中的对象是否允许拖拽
[javascript]  view plain copy

1. dojo.connect(tree.dndController, 'onMouseDown', function(e){    
2.     //如果你的树上有滚动条，请加入如下代码，否则如果你选中了节点后拖动滚动条会出现节点拖拽精灵    
3.     if (dijit.getEnclosingWidget(e.target) == tree)    
4.     {    
5.         tree.dndController.mousedown = false;    
6.         return;            
7.     }    
8.     //tree.dndController.mousedown为true表示允许拖拽，反之就是不允许，e为鼠标事件对象    
9.     //tree的selectedNodes属性可以返回选中的节点列表,这里的代码表示每个选中节点的数据项中的type属性都是xxx才能拖动    
10.     tree.dndController.mousedown = dojo.every(tree.selectedNodes, function(node){    
11.         return (tree.model.store.getValue(node.item, 'type') == 'xxx')    
12.     });      
13. });    

ii）判断目标节点是否接受正在拖拽的对象
[javascript]  view plain copy

1. tree.checkItemAcceptance = function(target, source, position)    
2. {    
3. //target: DomNode 目标节点对应的dom, 用dijit.getEnclosingWidget(target)可以获得TreeNode对象    
4. //source: dijit.tree.dndSource 被拖动的treeNode对象，是一个列表，因为tree允许一次拖动多个节点    
5. //position: 'over', 'before', 'after'    
6. //返回true表示允许drop    
7. }