portal-common/src/main/webapp/common/thirdparty/zTree/api/en/zTreeObj.checkNode.html

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