CLIENT GUI Framework
[vnfsdk/refrepo.git] / portal-common / src / main / webapp / common / thirdparty / zTree / api / en / zTreeObj.cancelSelectedNode.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Function(treeNode)</span><span class="path">zTreeObj.</span>cancelSelectedNode</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>To cancel the selected node.</p>\r
9                         <p class="highlight_red">zTree v3.x support to select multiple nodes, so you can cancel a single selected node, and you can cancel all of the selected nodes too.</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 cancel selected.</p>\r
17         <p class="highlight_red">Please ensure that this data object is an internal node data object in zTree.</p>\r
18         <p class="highlight_red">If you omit this parameter,  zTree will cancel all of the selected nodes.</p>\r
19         <h4 class="topLine"><b>Return </b><span>none</span></h4>\r
20         <p>no return value</p>\r
21         </div>\r
22         <h3>Examples of function</h3>\r
23         <h4>1. Cancel all of the selected nodes</h4>\r
24         <pre xmlns=""><code>var treeObj = $.fn.zTree.getZTreeObj("tree");\r
25 treeObj.cancelSelectedNode();\r
26 </code></pre>\r
27         <h4>2. Cancel the first node of the selected nodes</h4>\r
28         <pre xmlns=""><code>var treeObj = $.fn.zTree.getZTreeObj("tree");\r
29 var nodes = treeObj.getSelectedNode();\r
30 if (nodes.length>0) { \r
31         treeObj.cancelSelectedNode(nodes[0]);\r
32 }\r
33 </code></pre>\r
34 </div>\r
35 </div>