openo-portal/portal-common/src/main/webapp/common/thirdparty/zTree/api/en/setting.callback.onDrop.html

   1 <div class="apiDetail">\r
   2 <div>\r
   3         <h2><span>Function(event, treeId, treeNodes, targetNode, moveType, isCopy)</span><span class="path">setting.callback.</span>onDrop</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 drop event when drag-drop node.</p>\r
   9                         <p class="highlight_red">If you set 'setting.callback.beforeDrop',and return false, zTree will restore the dragged nodes, and will not trigger the 'onDrop' 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 targetNode is 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 has been dragged</p>\r
  21         <p class="highlight_red">The treeNodes are the data of the nodes which be dragged, when move nodes.</p>\r
  22         <p class="highlight_red">The treeNodes are the clone data of the nodes which be dragged, when copy nodes.</p>\r
  23         <h4 class="topLine"><b>targetNode</b><span>JSON</span></h4>\r
  24         <p>JSON data object of the target node which treeNodes are drag-dropped.</p>\r
  25         <p class="highlight_red">If the treeNodes will be root node, the targetNode = null</p>\r
  26         <h4 class="topLine"><b>moveType</b><span>String</span></h4>\r
  27         <p>the relative position of move to the target node</p>\r
  28         <p class="highlight_red">"inner": will be child of targetNode</p>\r
  29         <p class="highlight_red">"prev": will be sibling node, and be in front of targetNode</p>\r
  30         <p class="highlight_red">"next":  will be sibling node, and be behind targetNode</p>\r
  31         <p class="highlight_red">If moveType is null, means drag & drop is cancel.</p>\r
  32         <h4 class="topLine"><b>isCopy</b><span>Boolean</span></h4>\r
  33         <p>the flag used to judge copy node or move node</p>\r
  34         <p class="highlight_red">true: copy node; false: move node</p>\r
  35         </div>\r
  36         <h3>Examples of setting & function</h3>\r
  37         <h4>1. When drag-drop nodes complete, alert the number of dragged nodes and info about targetNode.</h4>\r
  38         <pre xmlns=""><code>function zTreeOnDrop(event, treeId, treeNodes, targetNode, moveType) {\r
  39     alert(treeNodes.length + "," + (targetNode ? (targetNode.tId + ", " + targetNode.name) : "isRoot" ));\r
  40 };\r
  41 var setting = {\r
  42         callback: {\r
  43                 onDrop: zTreeOnDrop\r
  44         }\r
  45 };\r
  46 ......</code></pre>\r
  47 </div>\r
  48 </div>