CLIENT GUI Framework
[vnfsdk/refrepo.git] / openo-portal / portal-common / src / main / webapp / common / thirdparty / zTree / api / en / zTreeObj.getCheckedNodes.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Function(checked)</span><span class="path">zTreeObj.</span>getCheckedNodes</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>Get the collection of nodes which be checked or unchecked. It is valid when <span class="highlight_red">[setting.check.enable = true]</span></p>\r
9                         <p class="highlight_red">Please use zTree object to executing the method.</p>\r
10                 </div>\r
11         </div>\r
12         <h3>Function Parameter Descriptions</h3>\r
13         <div class="desc">\r
14         <h4><b>checked</b><span>Boolean</span></h4>\r
15         <p>checked = true means: get the collection of nodes which be checked</p>\r
16         <p>checked = false means: get the collection of nodes which be unchecked</p>\r
17         <p class="highlight_red">If this parameter is omitted, it is same as 'checked = true'</p>\r
18         <p class="highlight_red">Don't get the nodes which 'nochecked' attribute is true.</p>\r
19         <h4 class="topLine"><b>Return </b><span>Array(JSON)</span></h4>\r
20         <p>return the collection of nodes which be checked or unchecked. (Array)</p>\r
21         </div>\r
22         <h3>Examples of function</h3>\r
23         <h4>1. Get the collection of nodes which be checked.</h4>\r
24         <pre xmlns=""><code>var treeObj = $.fn.zTree.getZTreeObj("tree");\r
25 var nodes = treeObj.getCheckedNodes(true);\r
26 </code></pre>\r
27 </div>\r
28 </div>