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

   1 <div class="apiDetail">\r
   2 <div>\r
   3         <h2><span>Function(event, treeId, treeNode, msg)</span><span class="path">setting.callback.</span>onAsyncSuccess</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 complete success event when execute ajax.</p>\r
   9                         <p class="highlight_red">If you set 'setting.callback.beforeAsync',and return false, zTree will not execute ajax, and will not trigger the 'onAsyncSuccess / onAsyncError' 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 parent node</p>\r
  21         <p class="highlight_red">When load root nodes, treeNode = null</p>\r
  22         <h4 class="topLine"><b>msg</b><span>String / Object</span></h4>\r
  23         <p>The actualnode data which got by ajax. User-friendly debugging.</p>\r
  24         <p class="highlight_red">The actual data's type of msg is affected by 'setting.async.dataType', please refer to JQuery API documentation.</p>\r
  25         </div>\r
  26         <h3>Examples of setting & function</h3>\r
  27         <h4>1. When execute ajax complete success, alert message.</h4>\r
  28         <pre xmlns=""><code>function zTreeOnAsyncSuccess(event, treeId, treeNode, msg) {\r
  29     alert(msg);\r
  30 };\r
  31 var setting = {\r
  32         callback: {\r
  33                 onAsyncSuccess: zTreeOnAsyncSuccess\r
  34         }\r
  35 };\r
  36 ......</code></pre>\r
  37 </div>\r
  38 </div>