Merge "GSO-35"
[vnfsdk/refrepo.git] / openo-portal / portal-common / src / main / webapp / common / thirdparty / zTree / api / en / setting.callback.beforeDblClick.html
1 <div class="apiDetail">
2 <div>
3         <h2><span>Function(treeId, treeNode)</span><span class="path">setting.callback.</span>beforeDblClick</h2>
4         <h3>Overview<span class="h3_info">[ depends on <span class="highlight_green">jquery.ztree.core</span> js ]</span></h3>
5         <div class="desc">
6                 <p></p>
7                 <div class="longdesc">
8                         <p>Used to capture the dblclick event before the 'onDblClick' callback, zTree based on return value to determine whether to trigger the 'onDblClick' callback.</p>
9                         <p>Default: null</p>
10                 </div>
11         </div>
12         <h3>Function Parameter Descriptions</h3>
13         <div class="desc">
14         <h4><b>treeId</b><span>String</span></h4>
15         <p>zTree unique identifier: <b class="highlight_red">treeId</b>, easy for users to control.</p>
16         <h4 class="topLine"><b>treeNode</b><span>JSON</span></h4>
17         <p>JSON data object of the node which is double clicked</p>
18         <p class="highlight_red">If the DOM which dblclicked isn't a node, it will return null.</p>
19         <h4 class="topLine"><b>Return </b><span>Boolean</span></h4>
20         <p>return true or false</p>
21         <p class="highlight_red">If return false, ztree will not trigger the 'onDblClick' callback, no effect on other operations.</p>
22         <p class="highlight_red">This callback function does not affect the dblclick the parent node to auto expand, please refer to setting.view.dblClickExpand properties.</p>
23         </div>
24         <h3>Examples of setting & function</h3>
25         <h4>1. disable to trigger the 'onDblClick' callback</h4>
26         <pre xmlns=""><code>function zTreeBeforeDblClick(treeId, treeNode) {
27     return false;
28 };
29 var setting = {
30         callback: {
31                 beforeDblClick: zTreeBeforeDblClick
32         }
33 };
34 ......</code></pre>
35 </div>
36 </div>