CLIENT GUI Framework
[vnfsdk/refrepo.git] / openo-portal / portal-common / src / main / webapp / common / thirdparty / zTree / api / en / setting.callback.onDrag.html
1 <div class="apiDetail">\r
2 <div>\r
3         <h2><span>Function(event, treeId, treeNodes)</span><span class="path">setting.callback.</span>onDrag</h2>\r
4         <h3>Overview<span class="h3_info">[ depends on <span class="highlight_green">jquery.ztree.exedit</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 drag event when drag node.</p>\r
9                         <p class="highlight_red">If you set 'setting.callback.beforeDrag',and return false, zTree will stop drag, and will not trigger the 'onDragMove' & 'onDrag' 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>, the tree is what the treeNodes are belong to, easy for users to control.</p>\r
19         <h4 class="topLine"><b>treeNodes</b><span>Array(JSON)</span></h4>\r
20         <p>A collection of the nodes which will be dragged</p>\r
21         </div>\r
22         <h3>Examples of setting & function</h3>\r
23         <h4>1. When drag nodes, alert the number of dragged nodes.</h4>\r
24         <pre xmlns=""><code>function zTreeOnDrag(event, treeId, treeNodes) {\r
25     alert(treeNodes.length);\r
26 };\r
27 var setting = {\r
28         callback: {\r
29                 onDrag: zTreeOnDrag\r
30         }\r
31 };\r
32 ......</code></pre>\r
33 </div>\r
34 </div>