CLIENT GUI Framework
[vnfsdk/refrepo.git] / portal-common / src / main / webapp / common / thirdparty / zTree / api / en / zTreeObj.removeChildNodes.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Function(parentNode)</span><span class="path">zTreeObj.</span>removeChildNodes</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>Remove a parent node's child nodes</p>\r
9                         <p class="highlight_red">1. After remove child nodes, the parent node will become a leaf node. Such as the need to maintain the parent node is still a parent node, set 'setting.data.keep.parent' attribute.</p>\r
10                         <p class="highlight_red">2. Do not use this method to empty the root. If you need to empty the root, you can initialization zTree, and set the initial nodes is null.</p>\r
11                         <p class="highlight_red">3. This method does not trigger any callback function.</p>\r
12                         <p class="highlight_red">Please use zTree object to executing the method.</p>\r
13                 </div>\r
14         </div>\r
15         <h3>Function Parameter Descriptions</h3>\r
16         <div class="desc">\r
17         <h4><b>parentNode</b><span>JSON</span></h4>\r
18         <p>The parent node which need to clear its child nodes.</p>\r
19         <p class="highlight_red">Please ensure that this data object is an internal node data object in zTree.</p>\r
20         <h4 class="topLine"><b>Return </b><span>Array(JSON)</span></h4>\r
21         <p>Return the parent node's child nodes which have been removed. If has no child nodes, return null.</p>\r
22         </div>\r
23         <h3>Examples of function</h3>\r
24         <h4>1. Remove the first selected node's child nodes</h4>\r
25         <pre xmlns=""><code>var treeObj = $.fn.zTree.getZTreeObj("tree");\r
26 var nodes = treeObj.getSelectedNodes();\r
27 if (nodes && nodes.length>0) {\r
28         treeObj.removeChildNodes(nodes[0]);\r
29 }\r
30 </code></pre>\r
31 </div>\r
32 </div>