CLIENT GUI Framework
[vnfsdk/refrepo.git] / portal-common / src / main / webapp / common / thirdparty / zTree / api / en / treeNode.getCheckStatus.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Function()</span><span class="path">treeNode.</span>getCheckStatus</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 node's half-checked status of checkbox or radio. It is valid when <span class="highlight_red">[setting.check.enable = true]</span></p>\r
9                         <p class="highlight_red">Do not initialize or modify it, it is created by the zTree.</p>\r
10                 </div>\r
11         </div>\r
12         <h3>Function Parameter Descriptions</h3>\r
13         <div class="desc">\r
14         <h4><b>Return</b><span>JSON</span></h4>\r
15         <pre xmlns=""><code>{\r
16         checked: true, //As same as 'treeNode.checked'\r
17         half: true  //Rule the table below\r
18 }</code></pre>\r
19         <table width="100%" border="0" cellspacing="1" cellpadding="0">\r
20                 <thead>\r
21                         <tr><td colspan="4">setting.check.checkType = "checkbox"</td></tr>\r
22                         <tr><td>treeNode.checked</td><td>treeNode.check_Child_State</td><td>treeNode.halfCheck</td><td> half </td></tr>\r
23                 </thead>\r
24                 <tbody>\r
25                         <tr><td>-</td><td>-</td><td>true</td><td>true</td></tr>\r
26                         <tr><td colspan="4">&nbsp;</td></tr>\r
27                         <tr><td>true</td><td>-1</td><td>false</td><td>false</td></tr>\r
28                         <tr><td>true</td><td>0</td><td>false</td><td>true</td></tr>\r
29                         <tr><td>true</td><td>1</td><td>false</td><td>true</td></tr>\r
30                         <tr><td>true</td><td>2</td><td>false</td><td>false</td></tr>\r
31                         <tr><td colspan="4">&nbsp;</td></tr>\r
32                         <tr><td>false</td><td>-1</td><td>false</td><td>false</td></tr>\r
33                         <tr><td>false</td><td>0</td><td>false</td><td>false</td></tr>\r
34                         <tr><td>false</td><td>1</td><td>false</td><td>true</td></tr>\r
35                         <tr><td>false</td><td>2</td><td>false</td><td>true</td></tr>\r
36                 </tbody>\r
37         </table>\r
38         <br/>\r
39         <table width="100%" border="0" cellspacing="1" cellpadding="0">\r
40                 <thead>\r
41                         <tr><td colspan="4">setting.check.checkType = "radio"</td></tr>\r
42                         <tr><td>treeNode.checked</td><td>treeNode.check_Child_State</td><td>treeNode.halfCheck</td><td> half </td></tr>\r
43                 </thead>\r
44                 <tbody>\r
45                         <tr><td>-</td><td>-</td><td>true</td><td>true</td></tr>\r
46                         <tr><td colspan="4">&nbsp;</td></tr>\r
47                         <tr><td>true</td><td>-1</td><td>false</td><td>false</td></tr>\r
48                         <tr><td>true</td><td>0</td><td>false</td><td>false</td></tr>\r
49                         <tr><td>true</td><td>2</td><td>false</td><td>true</td></tr>\r
50                         <tr><td colspan="4">&nbsp;</td></tr>\r
51                         <tr><td>false</td><td>-1</td><td>false</td><td>false</td></tr>\r
52                         <tr><td>false</td><td>0</td><td>false</td><td>false</td></tr>\r
53                         <tr><td>false</td><td>2</td><td>false</td><td>true</td></tr>\r
54                 </tbody>\r
55         </table>\r
56         </div>\r
57         <h3>Examples of treeNode</h3>\r
58         <h4>1. Get the first root node's half-checked status</h4>\r
59         <pre xmlns=""><code>var treeObj = $.fn.zTree.getZTreeObj("tree");\r
60 var halfCheck = treeObj.getNodes()[0].getCheckStatus();\r
61 </code></pre>\r
62 </div>\r
63 </div>