ITPub博客

首页 > 应用开发 > Java > dhtmlxtree中文API说明书

dhtmlxtree中文API说明书

Java 作者:破棉袄 时间:2014-07-16 13:42:53 0 删除 编辑
Java代码 复制代码 收藏代码
  1. dhtmlXTree是一个功能比较强大的树控件,基本上能满足大部分常规需求,比较好用。   
  2.     当然,在使用过程中还是发现一点点问题。下面是我整理的一些里面常用函数的说明(只有简单的说明,如果要看详细的说明,自己查看原函数去):   
  3.   
  4. 构造函数   
  5. dhtmlXTreeObject(htmlObject, width, height, rootId)//rootId 虚拟根节点,在界面上不会显示,一般取值0   
  6.   
  7. replace IMG tag with background images - solve problem with IE image caching , not works for IE6 SP1   
  8. enableIEImageFix(mode)   
  9.   
  10. 析构函数   
  11. destructor()   
  12.   
  13. 实现继承   
  14. clone()   
  15.   
  16. 节点构造函数   
  17. dhtmlXTreeItemObject(itemId,itemText,parentObject,treeObject,actionHandler,mode)// mode - do not show images   
  18.   
  19. 从xml字符串加载树   
  20. loadXMLString(xmlString,afterCall)//afterCall - function which will be called after xml loading   
  21.   
  22. 从xml文件加载树   
  23. loadXML(file,afterCall)   
  24.   
  25. 新建子节点,前三个参数为必须的   
  26. insertNewItem(parentId,itemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs)   
  27. insertNewChild(parentId,itemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs)   
  28.   
  29. 节点展开与收缩:[1-close 2-open]   
  30. _HideShow(itemObject,mode)   
  31.   
  32. 获取节点状态:0 - 没有子节点, -1 - 节点合拢, 1 - 节点展开   
  33. _getOpenState(node)   
  34. getOpenState(itemId)   
  35.   
  36. 获取选中的节点Id   
  37. getSelectedItemId()   
  38.   
  39. 选中节点   
  40. _selectItem(node,e)   
  41.   
  42. 获取节点的index   
  43. getIndexById(itemId)   
  44.   
  45. 设置鼠标右键点击事件   
  46. setOnRightClickHandler(func)   
  47.   
  48. 设置鼠标点击事件   
  49. setOnClickHandler(func)   
  50.   
  51. 设置节点状态改变事件   
  52. setOnSelectStateChange(func)   
  53.   
  54. 设置允许动态加载xml文件(异步加载)   
  55. setXMLAutoLoading(filePath)   
  56.   
  57. 设置checkbox点击事件   
  58. setOnCheckHandler(func)   
  59.   
  60. 设置节点展开/合拢事件   
  61. setOnOpenHandler(func)   
  62.   
  63. 设置节点开始展/合拢开事件   
  64. setOnOpenStartHandler(func)   
  65.   
  66. 设置节点展开/合拢结束事件   
  67. setOnOpenEndHandler(func)   
  68.   
  69. 设置节点双击事件   
  70. setOnDblClickHandler(func)   
  71.   
  72. 展开节点及下面所有子节点   
  73. _xopenAll(node)   
  74.   
  75. //增加了不传递itemId的判断(1494)   
  76. openAllItems(itemId)//不传递itemId参数则合拢根节点   
  77.   
  78. 根据id获取节点   
  79. _globalIdStorageFind(itemId)   
  80.   
  81. 合拢节点及其下所有子节点   
  82. _xcloseAll(node)   
  83.   
  84. //修改了原来逻辑的一个错误(1521)   
  85. closeAllItems(itemId)//不传递itemId参数则合拢根节点   
  86.   
  87. 为节点增加用户自定义的数据   
  88. //修正一个错误(1548)   
  89. setUserData(itemId,name,value)   
  90.   
  91. 获取用户自定义的数据   
  92. getUserData(itemId,name)   
  93.   
  94. 获取节点颜色   
  95. getItemColor(itemId)   
  96.   
  97. 设置节点颜色   
  98. setItemColor(itemId,defaultColor,selectedColor)   
  99.   
  100. 获取节点名称--(with HTML formatting, if any)   
  101. getItemText(itemId)   
  102.   
  103. 获取父节点id   
  104. getParentId(itemId)   
  105.   
  106. 更改节点id   
  107. changeItemId(itemId,newItemId)   
  108.   
  109. 标记被剪切的节点   
  110. doCut()   
  111.   
  112. 粘贴被剪切的节点到新的父节点下   
  113. doPaste(itemId)   
  114.   
  115. 清空被剪切的节点   
  116. clearCut()   
  117.   
  118. 移动节点   
  119. _moveNode(itemObject,targetObject)   
  120.   
  121. 允许三种状态的复选框(全选、不选、部分选中)   
  122. enableThreeStateCheckboxes(mode)// 1 - on, 0 - off;   
  123.   
  124. 设置鼠标悬浮事件   
  125. setOnMouseInHandler(func)   
  126.   
  127. 设置鼠标移走事件   
  128. setOnMouseOutHandler(func)   
  129.   
  130. 设置是否允许显示树图片   
  131. enableTreeImages=function(mode)//1 - on, 0 - off   
  132.   
  133. 设置是否允许固定模式(对于显示复选框的界面美观一些,但没有水平滚动条)   
  134. enableFixedMode(mode)// - 1 - on, 0 - off   
  135.   
  136. 是否显示复选框   
  137. enableCheckBoxes(mode, hidden)//mode 0/1 hidden 0/1   
  138.   
  139. 设置节点图片   
  140. setStdImages(image1,image2,image3)//a0 - image for node without childrens a1 - image for closed node a2 - image for opened node   
  141.   
  142. 设置是否显示树线   
  143. enableTreeLines(mode)   
  144.   
  145. 设置图片   
  146. 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   
  147.   
  148. 展开当前节点(一节)   
  149. _openItem(node)   
  150. openItem(itemId)   
  151.   
  152. 合拢当前节点(一节)   
  153. closeItem(itemId)   
  154.   
  155. 获取节点的层节数   
  156. getLevel(itemId)   
  157.   
  158. 设置节点是否允许被合拢   
  159. setItemCloseable(itemId,flag)//flag 0/1   
  160.   
  161. 对于展开节点返回子节点数量,对于未加载子节点的节点(异步加载)返回true   
  162. hasChildren(itemId)   
  163.   
  164. 获取节点下的子节点数   
  165. _getLeafCount(itemNode)   
  166.   
  167. 设置节点名称   
  168. setItemText(itemId,newLabel,newTooltip)   
  169.   
  170. 获取节点tip   
  171. getItemTooltip(itemId)   
  172.   
  173. 刷新节点   
  174. refreshItem(itemId)   
  175.   
  176. 设置节点图片   
  177. setItemImage2(itemId, image1,image2,image3)//image1 - node without childrens image image2 - closed node image image3 - open node image   
  178.   
  179. 设置节点图片   
  180. setItemImage(itemId,image1,image2)//image1 - node without childrens image or closed node image (if image2 specified)  image2 - open node image (optional)   
  181.   
  182. 获取节点下所有子节点id以逗号分割   
  183. getSubItems(itemId)   
  184. getAllSubItems(itemId)   
  185.   
  186. 获取节点的所有子节点   
  187. _getAllScraggyItems(node)   
  188.   
  189. 获取选中节点的名称--(with HTML formatting, if any)   
  190. getSelectedItemText()   
  191.   
  192. 设置节点的选中状态   
  193. setCheck(itemId,state)//state - checkbox state (0/1/unsure)   
  194.   
  195. 设置节点及所有子节点的选中状态   
  196. setSubChecked(itemId,state)   
  197.   
  198. 获取节点的选中状态 return: node state (0 - unchecked,1 - checked, 2 - third state)   
  199. isItemChecked(itemId)   
  200.   
  201. 删除节点的所有子节点   
  202. deleteChildItems(itemId)   
  203.   
  204. 删除节点   
  205. deleteItem(itemId,selectParent) //selectParent - If true parent of deleted item get selection, else no selected items leaving in tree.   
  206.   
  207. 在节点下创建一个节点,前三个参数是必须的   
  208. insertNewNext(itemId,newItemId,itemText,itemActionHandler,image1,image2,image3,optionStr,childs)   
  209.   
  210. 根据index获取节点下子节点的id   
  211. getChildItemIdByIndex(itemId,index)//itemId 节点id   
  212.   
  213. 设置拖动事件   
  214. setDragHandler(func)   
  215.   
  216. 设置是否允许拖拽   
  217. //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 ]   
  218. //rmode - enabled/disabled drag and drop on super root   
  219. enableDragAndDrop(mode,rmode)   
  220.   
  221. 设置是否允许IE缓存   
  222. preventIECashing=function(mode)//mode - enable/disable random seed ( disabled by default )   
  223.   
  224. 设置是否允许选中节点名称高亮显示   
  225. enableHighlighting(mode)//mode - 1 - on, 0 - off   
  226.   
  227. 是否允许图片可点击和拖拽(clickable and dragable)   
  228. enableActiveImages(mode)// mode - 1 - on, 0 - off   
  229.   
  230. 设置节点获得焦点   
  231. focusItem(itemId)   
  232.   
  233. 获取所有无子节点的节点id   
  234. getAllChildless()   
  235. getAllLeafs()   
  236.   
  237. 获取所有有子节点的节点id   
  238. getAllItemsWithKids()   
  239.   
  240. 获取所有被选中节点id,不包括第三中状态的节点(部分选中的节点)   
  241. getAllChecked()   
  242.   
  243. 获取所有被选中节点id,包括第三中状态的节点(部分选中的节点)   
  244. getAllCheckedBranches()   
  245.   
  246. 获取节点下所有未选中的节点id,不传递itemId表示从根节点开始查找   
  247. getAllUnchecked(itemId)   
  248.   
  249. 获取所有部分选中的节点id(因部分子节点选中而被选中的节点)   
  250. getAllPartiallyChecked()   
  251.   
  252. 设置节点样式   
  253. setItemStyle(itemId,style_string)   
  254.   
  255. 设置是否允许拖拽图片   
  256. enableImageDrag(mode)   
  257. set function called when tree item draged over another item   
  258. setOnDragIn(func)   
  259.   
  260. 设置拖拽是是否允许自动滚动   
  261. enableDragAndDropScrolling(mode)   
  262.   
  263.   
  264. 补充说明:加载树时,必须确保所有节点的id不重复,否则控件会为重复id自动生成一个随机数(原id+"_"+当前日期)。   
  265. 增加了一个dhtmlXTreeExtend.js对原类进行扩展,增加了getAllCheckedLeaf(),getAllUcCheckedLeaf()两个函数   
  266. 修改了1个bug:   
  267. 1 增加没有选中节点时执行展开/收缩选定节点时报没有parentId的bug   
  268. dhtmlXTreeObject.prototype.setSubChecked=function(itemId,state){   
  269.    if(itemId)   
  270. {   
  271.   var sNode=this._globalIdStorageFind(itemId);   
  272.   this._setSubChecked(state,sNode);   
  273.   this._correctCheckStates(sNode.parentObject);   
  274. }   
  275. }   
  276.   
  277.   
  278. 1 增加了未传递itemId参数时默认从根节点展开   
  279. dhtmlXTreeObject.prototype.openAllItems=function(itemId)   
  280.    {   
  281.       if (itemId==window.undefined) itemId=this.rootId;   
  282.       var temp=this._globalIdStorageFind(itemId);   
  283.       if (!temp) return 0;   
  284.       this._xopenAll(temp);   
  285.    };  

来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/29754888/viewspace-1220292/ ,如需转载,请注明出处,否则将追究法律责任。

请登录后发表评论 登录
全部评论

注册时间:2014-07-16

  • 博文量
    180
  • 访问量
    1158175