dhtmlXTree 中文API
转载出处
dhtmlXTree是一个功能比较强大的树控件，基本上能满足大部分常规需求，比较好用。
当然，在使用过程中还是发现一点点问题。下面是我整理的一些里面常用函数的说明（只有简单的说明，如果要看详细的说明，自己查看原函数去）：
| 函数 | 功能 | 解释 |
| dhtmlXTreeObject(htmlObject, width, height, rootId) | 构造函数 | rootId 虚拟根节点，在界面上不会显示，一般取值0 |
| destructor() | 析构函数 | |
| clone() | 实现继承 | |
| dhtmlXTreeItemObject(itemId,itemText,parentObject,treeObject,actionHandler,mode) | 节点构造函数 | mode - do not show images |
| loadXMLString(xmlString,afterCall) | 从xml字符串加载树 | afterCall - function which will be called after xml loading |
| loadXML(file,afterCall) | 从xml文件加载树 | |
| insertNewItem(parentId,itemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs) | 新建子节点，前三个参数为必须的 | |
| insertNewChild(parentId,itemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs) | 新建子节点，前三个参数为必须的 | |
| _HideShow(itemObject,mode) | 节点展开与收缩：[1-close 2-open] | |
| _getOpenState(node) getOpenState(itemId) |
获取节点状态：0 - 没有子节点, -1 - 节点合拢, 1 - 节点展开 | |
| getSelectedItemId() | 获取选中的节点Id | |
| _selectItem(node,e) | 选中节点 | |
| getIndexById(itemId) | 获取节点的index | |
| setOnRightClickHandler(func) | 设置鼠标右键点击事件 | |
| setOnClickHandler(func) | 设置鼠标点击事件 | |
| setOnSelectStateChange(func) | 设置节点状态改变事件 | |
| setXMLAutoLoading(filePath) | 设置允许动态加载xml文件（异步加载） | |
| setOnCheckHandler(func) | 设置checkbox点击事件 | |
| setOnOpenHandler(func) | 设置节点展开/合拢事件 | |
| setOnOpenStartHandler(func) | 设置节点开始展/合拢开事件 | |
| setOnOpenEndHandler(func) | 设置节点展开/合拢结束事件 | |
| setOnDblClickHandler(func) | 设置节点双击事件 | |
| _xopenAll(node) | 展开节点及下面所有子节点 | |
| openAllItems(itemId) | 增加了不传递itemId的判断（1494 | 不传递itemId参数则合拢根节点 |
| _globalIdStorageFind(itemId | 根据id获取节点 | |
| _xcloseAll(node) | 合拢节点及其下所有子节点 | |
| closeAllItems(itemId) | 修改了原来逻辑的一个错误（1521） | 不传递itemId参数则合拢根节点 |
| setUserData(itemId,name,value) | 为节点增加用户自定义的数据 | |
| getUserData(itemId,name) | 获取用户自定义的数据 | |
| getItemColor(itemId) | 获取节点颜色 | |
| setItemColor(itemId,defaultColor,selectedColor) | 设置节点颜色 | |
| getItemText(itemId) | 获取节点名称--(with HTML formatting, if any) | |
| getParentId(itemId) | 获取父节点id | |
| changeItemId(itemId,newItemId) | 更改节点id | |
| doCut() | 标记被剪切的节点 | |
| doPaste(itemId) | 粘贴被剪切的节点到新的父节点下 | |
| clearCut() | 清空被剪切的节点 | |
| _moveNode(itemObject,targetObject) | 移动节点 | |
| enableThreeStateCheckboxes(mode)// 1 - on, 0 - off; | 允许三种状态的复选框（全选、不选、部分选中） | |
| setOnMouseInHandler(func) | 设置鼠标悬浮事件 | |
| setOnMouseOutHandler(func) | 设置鼠标移走事件 | |
| enableTreeImages=function(mode)//1 - on, 0 - off | 设置是否允许显示树图片 | |
| enableFixedMode(mode)// - 1 - on, 0 - off | 设置是否允许固定模式(对于显示复选框的界面美观一些，但没有水平滚动条) | |
| enableCheckBoxes(mode, hidden)//mode 0/1 hidden 0/1 | 是否显示复选框 | |
| setStdImages(image1,image2,image3)//a0 - image for node without childrens a1 - image for closed node a2 - image for opened node | 设置节点图片 | |
| enableTreeLines(mode) | 设置是否显示树线 | |
| setImageArrays(arrayName,image1,image2,image3,image4,image5)//image1 - line crossed image image2 - image with top line image3 - image with bottom line image4 - image without line image5 - single root image | 设置图片 | |
| _openItem(node) openItem(itemId) |
展开当前节点（一节） | |
| closeItem(itemId) | 合拢当前节点（一节） | |
| getLevel(itemId) | 获取节点的层节数 | |
| setItemCloseable(itemId,flag)//flag 0/1 | 设置节点是否允许被合拢 | |
| hasChildren(itemId) | 对于展开节点返回子节点数量，对于未加载子节点的节点（异步加载）返回true | |
| _getLeafCount(itemNode) | 获取节点下的子节点数 | |
| setItemText(itemId,newLabel,newTooltip) | 设置节点名称 | |
| getItemTooltip(itemId) | 获取节点tip | |
| refreshItem(itemId) | 刷新节点 | |
| setItemImage2(itemId, image1,image2,image3)//image1 - node without childrens image image2 - closed node image image3 - open node image | 设置节点图片 | |
| setItemImage(itemId,image1,image2)//image1 - node without childrens image or closed node image (if image2 specified) image2 - open node image (optional) | 设置节点图片 | |
getSubItems(itemId) getAllSubItems(itemId) |
获取节点下所有子节点id以逗号分割 | |
| _getAllScraggyItems(node) | 获取节点的所有子节点 | |
| getSelectedItemText() | 获取选中节点的名称--(with HTML formatting, if any) | |
| setCheck(itemId,state)//state - checkbox state (0/1/unsure) | 设置节点的选中状态 | |
| setSubChecked(itemId,state) | 设置节点及所有子节点的选中状态 | |
| isItemChecked(itemId) | 获取节点的选中状态 return: node state (0 - unchecked,1 - checked, 2 - third state) | |
| deleteChildItems(itemId) | 删除节点的所有子节点 | |
| deleteItem(itemId,selectParent) //selectParent - If true parent of deleted item get selection, else no selected items leaving in tree. | 删除节点 | |
| insertNewNext(itemId,newItemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs) | 在节点下创建一个节点，前三个参数是必须的 | |
| getChildItemIdByIndex(itemId,index)//itemId 节点id | 根据index获取节点下子节点的id | |
| setDragHandler(func) | 设置拖动事件 | |
| //mode - enabled/disabled [ can be true/false/temporary_disabled - last value mean that tree can be D-n-D can be switched to true later ] //rmode - enabled/disabled drag and drop on super root enableDragAndDrop(mode,rmode) |
设置是否允许拖拽 | |
| preventIECashing=function(mode)//mode - enable/disable random seed ( disabled by default ) | 设置是否允许IE缓存 | |
| enableHighlighting(mode)//mode - 1 - on, 0 - off | 设置是否允许选中节点名称高亮显示 | |
| enableActiveImages(mode)// mode - 1 - on, 0 - off | 是否允许图片可点击和拖拽(clickable and dragable) | |
| focusItem(itemId) | 设置节点获得焦点 | |
| getAllChildless() getAllLeafs() |
获取所有无子节点的节点id | |
| getAllItemsWithKids（） | 获取所有有子节点的节点id | |
| getAllChecked() | 获取所有被选中节点id，不包括第三中状态的节点（部分选中的节点） | |
| getAllCheckedBranches() | 获取所有被选中节点id，包括第三中状态的节点（部分选中的节点） | |
| getAllUnchecked(itemId) | 获取节点下所有未选中的节点id，不传递itemId表示从根节点开始查找 | |
| getAllPartiallyChecked() | 获取所有部分选中的节点id（因部分子节点选中而被选中的节点） | |
| setItemStyle(itemId,style_string) | 设置节点样式 | |
| enableImageDrag(mode) set function called when tree item draged over another item setOnDragIn(func) |
设置是否允许拖拽图片 | |
| enableDragAndDropScrolling(mode) | 设置拖拽是是否允许自动滚动 |
补充说明：加载树时，必须确保所有节点的id不重复，否则控件会为重复id自动生成一个随机数（原id+"_"+当前日期）。
增加了一个dhtmlXTreeExtend.js对原类进行扩展，增加了getAllCheckedLeaf()，getAllUcCheckedLeaf()两个函数
修改了1个bug：
1 增加没有选中节点时执行展开/收缩选定节点时报没有parentId的bug
dhtmlXTreeObject.prototype.setSubChecked=function(itemId,state){
if(itemId)
{
var sNode=this._globalIdStorageFind(itemId);
this._setSubChecked(state,sNode);
this._correctCheckStates(sNode.parentObject);
}
}
1 增加了未传递itemId参数时默认从根节点展开
dhtmlXTreeObject.prototype.openAllItems=function(itemId)
{
if (itemId==window.undefined) itemId=this.rootId;
var temp=this._globalIdStorageFind(itemId);
if (!temp) return 0;
this._xopenAll(temp);
};