CLIENT GUI Framework
[vnfsdk/refrepo.git] / portal-common / src / main / webapp / common / thirdparty / zTree / api / en / setting.callback.onClick.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Function(event, treeId, treeNode, clickFlag)</span><span class="path">setting.callback.</span>onClick</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>Used to capture the click event when click node.</p>\r
9                         <p class="highlight_red">If you set 'setting.callback.beforeClick',and return false, zTree will not change selected state, and will not trigger the 'onClick' callback.</p>\r
10                         <p>Default: null</p>\r
11                 </div>\r
12         </div>\r
13         <h3>Function Parameter Descriptions</h3>\r
14         <div class="desc">\r
15         <h4><b>event</b><span>js event Object</span></h4>\r
16         <p>event Object</p>\r
17         <h4 class="topLine"><b>treeId</b><span>String</span></h4>\r
18         <p>zTree unique identifier: <b class="highlight_red">treeId</b>, easy for users to control.</p>\r
19         <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>\r
20         <p>JSON data object of the node which is clicked</p>\r
21         <h4 class="topLine"><b>clickFlag</b><span>Number</span></h4>\r
22         <p>Node is selected or deselected state, please see table below for details</p>\r
23         <table width="100%" border="0" cellspacing="1" cellpadding="0">\r
24                 <thead><tr><td>clickFlag</td><td title="Whether to allow multi-select">selectedMulti</td><td title="Whether to press Ctrl-key or Cmd-key">autoCancelSelected<br/>&&<br/>event.ctrlKey / metaKey</td><td title="Node's selection state">isSelected</td><td>operate for selected</td></tr></thead>\r
25                 <tbody>\r
26                         <tr><td>1</td><td>true</td><td>false</td><td>false</td><td>node is selected (single)</td></tr>\r
27                         <tr><td>1</td><td>true</td><td>false</td><td>true</td><td>node is selected (single)</td></tr>\r
28                         <tr><td>2</td><td>true</td><td>true</td><td>false</td><td>node is selected (multi)</td></tr>\r
29                         <tr><td>0</td><td>true</td><td>true</td><td>true</td><td>node is deselected</td></tr>\r
30                         <tr><td>1</td><td>false</td><td>false</td><td>false</td><td>node is selected (single)</td></tr>\r
31                         <tr><td>1</td><td>false</td><td>false</td><td>true</td><td>node is selected (single)</td></tr>\r
32                         <tr><td>1</td><td>false</td><td>true</td><td>false</td><td>node is selected (single)</td></tr>\r
33                         <tr><td>0</td><td>false</td><td>true</td><td>true</td><td>node is deselected</td></tr>\r
34                 </tbody>\r
35         </table>\r
36         </div>\r
37         <h3>Examples of setting & function</h3>\r
38         <h4>1. When click node, alert info about 'tId' and 'name'.</h4>\r
39         <pre xmlns=""><code>function zTreeOnClick(event, treeId, treeNode) {\r
40     alert(treeNode.tId + ", " + treeNode.name);\r
41 };\r
42 var setting = {\r
43         callback: {\r
44                 onClick: zTreeOnClick\r
45         }\r
46 };\r
47 ......</code></pre>\r
48 </div>\r
49 </div>