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

   1 <div class="apiDetail">\r
   2 <div>\r
   3         <h2><span>Function(treeNode, expandFlag, sonSign, focus, callbackFlag)</span><span class="path">zTreeObj.</span>expandNode</h2>\r
   4         <h3>Overview<span class="h3_info">[ depends on <span class="highlight_green">jquery.ztree.core</span> js ]</span></h3>\r
   5         <div class="desc">\r
   6                 <p></p>\r
   7                 <div class="longdesc">\r
   8                         <p>Expand or collapse single node.</p>\r
   9                         <p class="highlight_red">Use expandNode() method of zTree v3.x can trigger 'beforeExpand / onExpand' or 'beforeCollapse / onCollapse' 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 will be expanded or collapsed</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>expandFlag</b><span>Boolean</span></h4>\r
  19         <p>expandFlag = true means: expand the node.</p>\r
  20         <p>expandFlag = false means: collapse the node.</p>\r
  21         <p class="highlight_red">If this parameter is omitted, then toggle expand or collapse depend this node's expanded state.</p>\r
  22         <h4 class="topLine"><b>sonSign</b><span>Boolean</span></h4>\r
  23         <p>sonSign = true means: expand or collapse all of the child nodes depend the 'expandFlag' parameter.</p>\r
  24         <p>sonSign = false means: only expand or collapse this node.</p>\r
  25         <p class="highlight_red">When sonSign = false and treeNode.open = expandFlag, will not trigger the callback.</p>\r
  26         <p class="highlight_red">If this parameter is omitted, it is same as 'sonSign = false'.</p>\r
  27         <h4 class="topLine"><b>focus</b><span>Boolean</span></h4>\r
  28         <p>focus = true means: after expand or collapse, set the focus of this node for view.</p>\r
  29         <p>focus =  false means: after expand or coolapse, don't set the focus of this node.</p>\r
  30         <p class="highlight_red">If this parameter is omitted, it is same as 'focus = true'.</p>\r
  31         <h4 class="topLine"><b>callbackFlag</b><span>Boolean</span></h4>\r
  32         <p>callbackFlag = true means: call this method, will trigger 'beforeExpand / onExpand' or 'beforeCollapse / onCollapse' callback.</p>\r
  33         <p>callbackFlag = false means: call this method, will not trigger callback.</p>\r
  34         <p class="highlight_red">If this parameter is omitted, it is same as 'callbackFlag = false'</p>\r
  35         <h4 class="topLine"><b>Return </b><span>Boolean</span></h4>\r
  36         <p>return the result of expand or collapse.</p>\r
  37         <p>true means: expand node</p>\r
  38         <p>false means: collapse node</p>\r
  39         <p>null means: the node is not parent node.</p>\r
  40         </div>\r
  41         <h3>Examples of function</h3>\r
  42         <h4>1. Expand the first selected node. (and expand this node's child nodes)</h4>\r
  43         <pre xmlns=""><code>var treeObj = $.fn.zTree.getZTreeObj("tree");\r
  44 var nodes = treeObj.getSelectedNodes();\r
  45 if (nodes.length>0) {\r
  46         treeObj.expandNode(nodes[0], true, true, true);\r
  47 }\r
  48 </code></pre>\r
  49 </div>\r
  50 </div>