zTreeObj.checkNode.html 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. <div class="apiDetail">
  2. <div>
  3. <h2><span>Function(treeNode, checked, checkTypeFlag, callbackFlag)</span><span class="path">zTreeObj.</span>checkNode
  4. </h2>
  5. <h3>Overview<span class="h3_info">[ depends on <span
  6. class="highlight_green">jquery.ztree.excheck</span> js ]</span></h3>
  7. <div class="desc">
  8. <p></p>
  9. <div class="longdesc">
  10. <p>Check or unCheck a single node. It is valid when <span class="highlight_red">[setting.check.enable = true]</span>
  11. </p>
  12. <p class="highlight_red">Use checkNode() method of zTree v3.x can trigger 'beforeCheck' or 'onCheck'
  13. callback function. for reduce redundant code.</p>
  14. <p class="highlight_red">Please use zTree object to executing the method.</p>
  15. </div>
  16. </div>
  17. <h3>Function Parameter Descriptions</h3>
  18. <div class="desc">
  19. <h4><b>treeNode</b><span>JSON</span></h4>
  20. <p>JSON data object of the node which need to be checked or unchecked.</p>
  21. <p class="highlight_red">Please ensure that this data object is an internal node data object in zTree.</p>
  22. <h4 class="topLine"><b>checked</b><span>Boolean</span></h4>
  23. <p>checked = true means: check node.</p>
  24. <p>checked = false means: uncheck node.</p>
  25. <p class="highlight_red">If this parameter is omitted, then toggle check or uncheck depend this node's
  26. expanded state.</p>
  27. <p class="highlight_red">Don't affect the node which 'nocheck' attribute is true.</p>
  28. <h4 class="topLine"><b>checkTypeFlag</b><span>Boolean</span></h4>
  29. <p>checkTypeFlag = true means: According to 'setting.check.chkboxType' attribute automatically check or
  30. uncheck the parent and child nodes.</p>
  31. <p>checkTypeFlag = false means: only check or uncheck this node, don't affect its parent and child
  32. nodes.</p>
  33. <p class="highlight_red">When checkTypeFlag = false and treeNode.checked = checked, will not trigger
  34. callback function.</p>
  35. <p class="highlight_red">Don't affect the parent and child nodes which 'nocheck' attribute is true.</p>
  36. <h4 class="topLine"><b>callbackFlag</b><span>Boolean</span></h4>
  37. <p>callbackFlag = true means: call this method, will trigger 'beforeCheck' & 'onCheck' callback.</p>
  38. <p>callbackFlag = false means: call this method, will not trigger callback.</p>
  39. <p class="highlight_red">If this parameter is omitted, it is same as 'callbackFlag = false'</p>
  40. <h4 class="topLine"><b>Return </b><span>none</span></h4>
  41. <p>no return value</p>
  42. </div>
  43. <h3>Examples of function</h3>
  44. <h4>1. check the selected nodes</h4>
  45. <pre xmlns=""><code>var treeObj = $.fn.zTree.getZTreeObj("tree");
  46. var nodes = treeObj.getSelectedNodes();
  47. for (var i=0, l=nodes.length; i < l; i++) {
  48. treeObj.checkNode(nodes[i], true, true);
  49. }
  50. </code></pre>
  51. </div>
  52. </div>