jstree-rails 0.0.2 → 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- data/INSTALLER.sh +1 -0
- data/docs/c.gif +0 -0
- data/docs/e.gif +0 -0
- data/docs/files/_lib/jquery-js.html +50 -0
- data/docs/files/_license-txt.html +38 -0
- data/docs/files/_usage-txt.html +57 -0
- data/docs/files/jstree-checkbox-js.html +40 -0
- data/docs/files/jstree-contextmenu-js.html +40 -0
- data/docs/files/jstree-core-js.html +313 -0
- data/docs/files/jstree-dnd-js.html +40 -0
- data/docs/files/jstree-hotkeys-js.html +40 -0
- data/docs/files/jstree-html-js.html +40 -0
- data/docs/files/jstree-js.html +309 -0
- data/docs/files/jstree-json-js.html +40 -0
- data/docs/files/jstree-rules-js.html +40 -0
- data/docs/files/jstree-sort-js.html +40 -0
- data/docs/files/jstree-state-js.html +40 -0
- data/docs/files/jstree-themes-js.html +62 -0
- data/docs/files/jstree-ui-js.html +40 -0
- data/docs/files/jstree-unique-js.html +40 -0
- data/docs/files/jstree-xml-js.html +40 -0
- data/docs/files/vakata-js.html +260 -0
- data/docs/index.html +1 -0
- data/docs/index/Classes.html +33 -0
- data/docs/index/Events.html +41 -0
- data/docs/index/Files.html +37 -0
- data/docs/index/Functions.html +105 -0
- data/docs/index/General.html +65 -0
- data/docs/index/General2.html +73 -0
- data/docs/index/Variables.html +73 -0
- data/docs/javascript/main.js +841 -0
- data/docs/javascript/prettify.js +1526 -0
- data/docs/javascript/searchdata.js +182 -0
- data/docs/logo.png +0 -0
- data/docs/m.gif +0 -0
- data/docs/main.jpg +0 -0
- data/docs/p.gif +0 -0
- data/docs/search/ClassesJ.html +20 -0
- data/docs/search/EventsC.html +20 -0
- data/docs/search/EventsD.html +20 -0
- data/docs/search/EventsSymbols.html +20 -0
- data/docs/search/FilesH.html +20 -0
- data/docs/search/FilesJ.html +20 -0
- data/docs/search/FunctionsA.html +20 -0
- data/docs/search/FunctionsC.html +20 -0
- data/docs/search/FunctionsD.html +20 -0
- data/docs/search/FunctionsE.html +20 -0
- data/docs/search/FunctionsF.html +20 -0
- data/docs/search/FunctionsG.html +20 -0
- data/docs/search/FunctionsH.html +20 -0
- data/docs/search/FunctionsI.html +20 -0
- data/docs/search/FunctionsL.html +20 -0
- data/docs/search/FunctionsM.html +20 -0
- data/docs/search/FunctionsO.html +20 -0
- data/docs/search/FunctionsP.html +20 -0
- data/docs/search/FunctionsR.html +20 -0
- data/docs/search/FunctionsS.html +20 -0
- data/docs/search/FunctionsSymbols.html +20 -0
- data/docs/search/FunctionsT.html +20 -0
- data/docs/search/FunctionsU.html +20 -0
- data/docs/search/FunctionsV.html +20 -0
- data/docs/search/FunctionsX.html +20 -0
- data/docs/search/GeneralA.html +20 -0
- data/docs/search/GeneralC.html +20 -0
- data/docs/search/GeneralD.html +20 -0
- data/docs/search/GeneralE.html +20 -0
- data/docs/search/GeneralF.html +20 -0
- data/docs/search/GeneralG.html +20 -0
- data/docs/search/GeneralH.html +20 -0
- data/docs/search/GeneralI.html +20 -0
- data/docs/search/GeneralJ.html +20 -0
- data/docs/search/GeneralL.html +20 -0
- data/docs/search/GeneralM.html +20 -0
- data/docs/search/GeneralO.html +20 -0
- data/docs/search/GeneralP.html +20 -0
- data/docs/search/GeneralR.html +20 -0
- data/docs/search/GeneralS.html +20 -0
- data/docs/search/GeneralSymbols.html +20 -0
- data/docs/search/GeneralT.html +20 -0
- data/docs/search/GeneralU.html +20 -0
- data/docs/search/GeneralV.html +20 -0
- data/docs/search/GeneralX.html +20 -0
- data/docs/search/NoResults.html +15 -0
- data/docs/search/VariablesC.html +20 -0
- data/docs/search/VariablesD.html +20 -0
- data/docs/search/VariablesH.html +20 -0
- data/docs/search/VariablesI.html +20 -0
- data/docs/search/VariablesJ.html +20 -0
- data/docs/search/VariablesL.html +20 -0
- data/docs/search/VariablesP.html +20 -0
- data/docs/search/VariablesS.html +20 -0
- data/docs/search/VariablesT.html +20 -0
- data/docs/search/VariablesU.html +20 -0
- data/docs/search/VariablesV.html +20 -0
- data/docs/styles/1.css +828 -0
- data/docs/styles/2.css +36 -0
- data/docs/styles/main.css +2 -0
- data/lib/jstree-rails/version.rb +1 -1
- metadata +97 -1
data/INSTALLER.sh
CHANGED
data/docs/c.gif
ADDED
|
Binary file
|
data/docs/e.gif
ADDED
|
Binary file
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
|
|
2
|
+
|
|
3
|
+
<html><head><title>D:\xampp\htdocs\jstree1\_lib\jquery.js - jstree</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/prettify.js"></script><script language=JavaScript src="../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
|
|
4
|
+
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
|
|
5
|
+
|
|
6
|
+
<!-- Generated by Natural Docs, version 1.5 -->
|
|
7
|
+
<!-- http://www.naturaldocs.org -->
|
|
8
|
+
|
|
9
|
+
<!-- saved from url=(0026)http://www.naturaldocs.org -->
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="jquery.js"></a>jquery.js</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#jquery.js" >jquery.js</a></td><td class=SDescription></td></tr><tr class="SGroup"><td class=SEntry><a href="#Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$(html).$(array)" >$(html) -> $(array)</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#$(#id)" >$(“#id”)</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$(expr,$(.))" >$(expr, $(...))</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#$(expr,context)" >$(expr, context)</a></td><td class=SDescription>(which is just equivalent to: $(context).find(expr)</td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$(function)" >$(function)</a></td><td class=SDescription>Shortcut for document ready</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
|
|
15
|
+
|
|
16
|
+
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Variables"></a>Variables</h3></div></div>
|
|
17
|
+
|
|
18
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$(html).$(array)"></a>$(html) -> $(array)</h3></div></div>
|
|
19
|
+
|
|
20
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$(#id)"></a>$(“#id”)</h3></div></div>
|
|
21
|
+
|
|
22
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$(expr,$(.))"></a>$(expr, $(...))</h3></div></div>
|
|
23
|
+
|
|
24
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$(expr,context)"></a>$(expr, context)</h3><div class=CBody><p>(which is just equivalent to: $(context).find(expr)</p></div></div></div>
|
|
25
|
+
|
|
26
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$(function)"></a>$(function)</h3><div class=CBody><p>Shortcut for document ready</p></div></div></div>
|
|
27
|
+
|
|
28
|
+
</div><!--Content-->
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
<div id=Footer>Copyright © 2010 Ivan Bozhanov · Updated March 20th, 2011 · <a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
<div id=Menu><div class=MTitle>jstree<div class=MSubTitle>jquery treeview plugin</div></div><div class=MEntry><div class=MFile><a href="../_usage-txt.html">USAGE</a></div></div><div class=MEntry><div class=MFile><a href="../_license-txt.html">LICENSE</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Core</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../jstree-core-js.html">jstree.<wbr>core.js</a></div></div><div class=MEntry><div class=MFile><a href="../vakata-js.html">Helper functions</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Plugins</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../jstree-themes-js.html">jstree.<wbr>themes.js</a></div></div><div class=MEntry><div class=MFile><a href="../jstree-ui-js.html">jstree.<wbr>ui.js</a></div></div></div></div></div><div class=MEntry><div class=MFile id=MSelected>_lib\<wbr>jquery.js</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Index</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MIndex><a href="../../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Events.html">Events</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Classes.html">Classes</a></div></div></div></div></div><script type="text/javascript"><!--
|
|
35
|
+
var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
|
|
36
|
+
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div></div><!--Menu-->
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<!--START_ND_TOOLTIPS-->
|
|
41
|
+
<!--END_ND_TOOLTIPS-->
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<script language=JavaScript><!--
|
|
50
|
+
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
|
|
2
|
+
|
|
3
|
+
<html><head><title>License - jstree</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
|
|
4
|
+
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
|
|
5
|
+
|
|
6
|
+
<!-- Generated by Natural Docs, version 1.5 -->
|
|
7
|
+
<!-- http://www.naturaldocs.org -->
|
|
8
|
+
|
|
9
|
+
<!-- saved from url=(0026)http://www.naturaldocs.org -->
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
<div id=Content><div class="CSection"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="License"></a>License</h1><div class=CBody><p><b><a href="http://jstree.com/" class=LURL target=_top>jstree</a> is licensed same as <a href="http://jquery.com" class=LURL target=_top>jQuery</a>.</b></p><p>The MIT License is recommended for most projects. It is simple and easy to understand and it places almost no restrictions on what you can do with <a href="http://jstree.com/" class=LURL target=_top>jstree</a>.</p><p>If the GPL suits your project better you are also free to use <a href="http://jstree.com/" class=LURL target=_top>jstree</a> under that license.</p><p>You don’t have to do anything special to choose one license or the other and you don’t have to notify anyone which license you are using. You are free to use <a href="http://jstree.com/" class=LURL target=_top>jstree</a> in commercial projects as long as the copyright header is left intact.</p><p><b>Licenses</b></p><ul><li><a href="http://github.com/jquery/jquery/blob/master/MIT-LICENSE.txt" class=LURL target=_top>MIT License</a> (<a href="http://en.wikipedia.org/wiki/MIT_License" class=LURL target=_top>More Information</a>)</li><li><a href="http://github.com/jquery/jquery/blob/master/GPL-LICENSE.txt" class=LURL target=_top>GPL License</a> (<a href="http://en.wikipedia.org/wiki/GNU_General_Public_License" class=LURL target=_top>More Information</a>)</li></ul><p># Copyright © 2010 Ivan Bozhanov (<a href="http://vakata.com" class=LURL target=_top>http://vakata.com</a>)</p></div></div></div>
|
|
15
|
+
|
|
16
|
+
</div><!--Content-->
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
<div id=Footer>Copyright © 2010 Ivan Bozhanov · Updated December 19th, 2011 · <a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
<div id=Menu><div class=MTitle>jstree<div class=MSubTitle>jquery treeview plugin</div></div><div class=MEntry><div class=MFile id=MSelected>LICENSE</div></div><div class=MEntry><div class=MFile><a href="_usage-txt.html">USAGE</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Core</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="jstree-core-js.html">jstree.<wbr>core.js</a></div></div><div class=MEntry><div class=MFile><a href="vakata-js.html">Helper functions</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Plugins</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="jstree-html-js.html">jstree.<wbr>html.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-json-js.html">jstree.<wbr>json.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-themes-js.html">jstree.<wbr>themes.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-ui-js.html">jstree.<wbr>ui.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-state-js.html">jstree.<wbr>state.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-contextmenu-js.html">jstree.<wbr>contextmenu.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-hotkeys-js.html">jstree.<wbr>hotkeys.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-sort-js.html">jstree.<wbr>sort.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-dnd-js.html">jstree.<wbr>dnd.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-unique-js.html">jstree.<wbr>unique.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-checkbox-js.html">jstree.<wbr>checkbox.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-xml-js.html">jstree.<wbr>xml.js</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Index</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Events.html">Events</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div></div></div></div><script type="text/javascript"><!--
|
|
23
|
+
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
|
|
24
|
+
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div></div><!--Menu-->
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
<!--START_ND_TOOLTIPS-->
|
|
29
|
+
<!--END_ND_TOOLTIPS-->
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
<script language=JavaScript><!--
|
|
38
|
+
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
|
|
2
|
+
|
|
3
|
+
<html><head><title>Usage - jstree</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
|
|
4
|
+
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
|
|
5
|
+
|
|
6
|
+
<!-- Generated by Natural Docs, version 1.5 -->
|
|
7
|
+
<!-- http://www.naturaldocs.org -->
|
|
8
|
+
|
|
9
|
+
<!-- saved from url=(0026)http://www.naturaldocs.org -->
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
<div id=Content><div class="CSection"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="Usage"></a>Usage</h1><div class=CBody><p><b>Introduction</b></p><ul><li>jsTree is a <b>javascript based, cross browser tree component</b>. It is packaged as a <a href="http://jquery.com" class=LURL target=_top>jQuery</a> plugin.</li><li>jsTree <b>is absolutely free</b></li><li>jsTree is a <a href="http://vakata.com" class=LURL target=_top>one man</a> project and relies on <a href="http://groups.google.com/group/jstree" class=LURL target=_top>its great community</a> for <a href="https://github.com/vakata/jstree" class=LURL target=_top>feature requests & bug reports</a>. Join in!</li><li>jsTree passes <a href="http://jslint.com" class=LURL target=_top>jslint validation</a>, minifies nicely and does not modify the global scope in any way.</li><li>jsTree uses plugins so feel free to remove any plugins you do not use (or use the <a href="http://jstree.com" class=LURL target=_top>download builder</a>) or create your own plugins.</li></ul><p><b>Features at a glance</b></p><ul><li>Various data sources - HTML, JSON, XML</li><li>Supports AJAX loading</li><li>Drag & drop support</li><li>Highly configurable</li><li>Theme support + included themes</li><li>Uses jQuery’s event system</li><li>Optional keyboard navigation</li><li>Inline editing</li><li>Open/close optional animation</li><li>Define node types and fine tune them</li><li>Configurable multitree drag & drop</li><li>Optional checkbox tree support</li><li>Search function</li><li>Supports plugins</li><li>Optional state saving using cookies</li><li>RTL support</li><li>Optional sorting / unique management</li></ul><p><b>Including the files</b></p><p>First of all, as jsTree is a jQuery component, you need to include jQuery itself. jsTree v.1.0 requires jQuery version 1.4.4</p><blockquote><pre class="prettyprint"><script type="text/javascript" src="_lib/jquery.js"></script></pre></blockquote><p>Then you need to include jstree itself</p><blockquote><pre class="prettyprint"><script type="text/javascript" src="jquery.jstree.js"></script></pre></blockquote><p>You may change the path to whatever you like, but it is recommended not to rename <u>jquery.tree.js</u> (or <u>jquery.tree.min.js</u>) as the filename may be used for path autodetection (for example in the <a href="jstree-themes-js.html#jstree.themes.js" class=LFile id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">jstree.themes.js</a> plugin, however all official plugins will provide an alternative way of specifying any needed path manually).</p><p>Additionally some plugins have dependencies. If a plugin detects that a dependency is missing, it will throw an error.</p><p><b>Creating and configuring an instance</b></p><p>You can create a tree in the following manner (<a href="jstree-core-js.html#$().jstree" class=LGroup id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">$().jstree</a>) :</p><blockquote><pre class="prettyprint">jQuery("some-selector-to-container-node-here").jstree([ config_object ]);</pre></blockquote><p>In the optional config object you specify all the options that you want to set. Each plugin will describe its configuration and defaults. Each plugin’s options (even the core) are set in their own subobject, which is named after the plugin. For example all of the core’s options are set in the <u>core</u> key of the config object.</p><blockquote><pre class="prettyprint">jQuery("some-selector-to-container-node-here")
|
|
15
|
+
.jstree({
|
|
16
|
+
core : {
|
|
17
|
+
/* core options go here */
|
|
18
|
+
}
|
|
19
|
+
});</pre></blockquote><p><b>Please note that if your options for a given plugin are the same as the defaults you may omit those options or omit the subobject completely (if you do not need to modify the defaults).</b></p><p>The special <u>plugins</u> config option is not part of any plugin, it defines a list of active plugins for the instance being created. Although many plugins may be included, only the ones listed in this option will be active.</p><blockquote><pre class="prettyprint">jQuery("some-selector-to-container-node-here")
|
|
20
|
+
.jstree({
|
|
21
|
+
core : { /* core options go here */ },
|
|
22
|
+
plugins : [ "themes", "html_data", "some-other-plugin" ]
|
|
23
|
+
});</pre></blockquote><p><b>Interacting with the tree</b></p><p>To perform an operation programatically on a given instance you can use two methods (<a href="jstree-core-js.html#$().jstree" class=LGroup id=link3 onMouseOver="ShowTip(event, 'tt2', 'link3')" onMouseOut="HideTip('tt2')">$().jstree</a>, <a href="jstree-core-js.html#$.jstree._reference" class=LFunction id=link4 onMouseOver="ShowTip(event, 'tt3', 'link4')" onMouseOut="HideTip('tt3')">$.jstree._reference</a>).</p><blockquote><pre class="prettyprint">/* METHOD ONE */
|
|
24
|
+
jQuery("some-selector-to-container-node-here")
|
|
25
|
+
.jstree("operation_name" [, argument_1, argument_2, ...]);
|
|
26
|
+
|
|
27
|
+
/* METHOD TWO */
|
|
28
|
+
jQuery.jstree._reference(needle)
|
|
29
|
+
.operation_name([ argument_1, argument_2, ...]);</pre></blockquote><p><b>Events</b></p><p>jsTree uses events to notify of any changes happening in the tree. All events fire on the tree container in the <u>jstree</u> namespace and are named after the function that triggered them.</p><blockquote><pre class="prettyprint">jQuery("some-container")
|
|
30
|
+
.jstree({ /* configuration here */ })
|
|
31
|
+
.bind("__ready.jstree", function (event, data) {
|
|
32
|
+
alert("TREE IS LOADED");
|
|
33
|
+
})</pre></blockquote><p>Please note the second parameter data. Read the documentation on each event to see what it contains.</p><p><b>Data</b></p><p>TODO: a step by step guide to: HTML (no data plugin), HTML with plugin + AJAX, JSON, JSON + AJAX, XML, XML + AJAX TODO: progressive render / unload</p><p><b>States</b></p><p>TODO: explain about passing states along with the data and the special data-jstree- attributes.</p></div></div></div>
|
|
34
|
+
|
|
35
|
+
</div><!--Content-->
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<div id=Footer>Copyright © 2010 Ivan Bozhanov · Updated December 19th, 2011 · <a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
<div id=Menu><div class=MTitle>jstree<div class=MSubTitle>jquery treeview plugin</div></div><div class=MEntry><div class=MFile><a href="_license-txt.html">LICENSE</a></div></div><div class=MEntry><div class=MFile id=MSelected>USAGE</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Core</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="jstree-core-js.html">jstree.<wbr>core.js</a></div></div><div class=MEntry><div class=MFile><a href="vakata-js.html">Helper functions</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Plugins</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="jstree-html-js.html">jstree.<wbr>html.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-json-js.html">jstree.<wbr>json.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-themes-js.html">jstree.<wbr>themes.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-ui-js.html">jstree.<wbr>ui.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-state-js.html">jstree.<wbr>state.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-contextmenu-js.html">jstree.<wbr>contextmenu.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-hotkeys-js.html">jstree.<wbr>hotkeys.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-sort-js.html">jstree.<wbr>sort.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-dnd-js.html">jstree.<wbr>dnd.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-unique-js.html">jstree.<wbr>unique.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-checkbox-js.html">jstree.<wbr>checkbox.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-xml-js.html">jstree.<wbr>xml.js</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Index</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Events.html">Events</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div></div></div></div><script type="text/javascript"><!--
|
|
42
|
+
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
|
|
43
|
+
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div></div><!--Menu-->
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
<!--START_ND_TOOLTIPS-->
|
|
48
|
+
<div class=CToolTip id="tt1"><div class=CFile>Controls the looks of jstree, without this plugin you will get a functional tree, but it will look just like an ordinary UL list</div></div><div class=CToolTip id="tt2"><div class=CGroup>The actual plugin wrapper, use this to create instances or execute functions on created instances.</div></div><div class=CToolTip id="tt3"><div class=CFunction>Returns an instance</div></div><!--END_ND_TOOLTIPS-->
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
<script language=JavaScript><!--
|
|
57
|
+
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
|
|
2
|
+
|
|
3
|
+
<html><head><title>jstree.checkbox.js - jstree</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
|
|
4
|
+
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
|
|
5
|
+
|
|
6
|
+
<!-- Generated by Natural Docs, version 1.5 -->
|
|
7
|
+
<!-- http://www.naturaldocs.org -->
|
|
8
|
+
|
|
9
|
+
<!-- saved from url=(0026)http://www.naturaldocs.org -->
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="jstree.checkbox.js"></a>jstree.<wbr>checkbox.js</h1><div class=CBody><p>Adds checkboxes to the tree.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#jstree.checkbox.js" >jstree.<wbr>checkbox.js</a></td><td class=SDescription>Adds checkboxes to the tree.</td></tr><tr class="SGroup"><td class=SEntry><a href="#CHECKBOX_functions" >CHECKBOX functions</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
|
|
15
|
+
|
|
16
|
+
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="CHECKBOX_functions"></a>CHECKBOX functions</h3></div></div>
|
|
17
|
+
|
|
18
|
+
</div><!--Content-->
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<div id=Footer>Copyright © 2010 Ivan Bozhanov · Updated June 7th, 2012 · <a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<div id=Menu><div class=MTitle>jstree<div class=MSubTitle>jquery treeview plugin</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Core</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="jstree-js.html">jstree.js</a></div></div><div class=MEntry><div class=MFile><a href="vakata-js.html">vakata.js</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Plugins</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="jstree-html-js.html">jstree.<wbr>html.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-json-js.html">jstree.<wbr>json.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-themes-js.html">jstree.<wbr>themes.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-ui-js.html">jstree.<wbr>ui.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-state-js.html">jstree.<wbr>state.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-contextmenu-js.html">jstree.<wbr>contextmenu.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-hotkeys-js.html">jstree.<wbr>hotkeys.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-sort-js.html">jstree.<wbr>sort.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-dnd-js.html">jstree.<wbr>dnd.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-unique-js.html">jstree.<wbr>unique.js</a></div></div><div class=MEntry><div class=MFile id=MSelected>jstree.<wbr>checkbox.js</div></div><div class=MEntry><div class=MFile><a href="jstree-xml-js.html">jstree.<wbr>xml.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-rules-js.html">jstree.<wbr>rules.js</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Index</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Events.html">Events</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div></div></div></div><script type="text/javascript"><!--
|
|
25
|
+
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
|
|
26
|
+
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div></div><!--Menu-->
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
<!--START_ND_TOOLTIPS-->
|
|
31
|
+
<!--END_ND_TOOLTIPS-->
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
<script language=JavaScript><!--
|
|
40
|
+
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
|
|
2
|
+
|
|
3
|
+
<html><head><title>jstree.contextmenu.js - jstree</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
|
|
4
|
+
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
|
|
5
|
+
|
|
6
|
+
<!-- Generated by Natural Docs, version 1.5 -->
|
|
7
|
+
<!-- http://www.naturaldocs.org -->
|
|
8
|
+
|
|
9
|
+
<!-- saved from url=(0026)http://www.naturaldocs.org -->
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="jstree.contextmenu.js"></a>jstree.<wbr>contextmenu.js</h1><div class=CBody><p>Enables a rightclick contextmenu.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#jstree.contextmenu.js" >jstree.<wbr>contextmenu.js</a></td><td class=SDescription>Enables a rightclick contextmenu.</td></tr><tr class="SGroup"><td class=SEntry><a href="#jstree_sort_plugin" >jstree sort plugin</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
|
|
15
|
+
|
|
16
|
+
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="jstree_sort_plugin"></a>jstree sort plugin</h3></div></div>
|
|
17
|
+
|
|
18
|
+
</div><!--Content-->
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<div id=Footer>Copyright © 2010 Ivan Bozhanov · Updated June 7th, 2012 · <a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<div id=Menu><div class=MTitle>jstree<div class=MSubTitle>jquery treeview plugin</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Core</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="jstree-js.html">jstree.js</a></div></div><div class=MEntry><div class=MFile><a href="vakata-js.html">vakata.js</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Plugins</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="jstree-html-js.html">jstree.<wbr>html.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-json-js.html">jstree.<wbr>json.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-themes-js.html">jstree.<wbr>themes.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-ui-js.html">jstree.<wbr>ui.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-state-js.html">jstree.<wbr>state.js</a></div></div><div class=MEntry><div class=MFile id=MSelected>jstree.<wbr>contextmenu.js</div></div><div class=MEntry><div class=MFile><a href="jstree-hotkeys-js.html">jstree.<wbr>hotkeys.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-sort-js.html">jstree.<wbr>sort.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-dnd-js.html">jstree.<wbr>dnd.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-unique-js.html">jstree.<wbr>unique.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-checkbox-js.html">jstree.<wbr>checkbox.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-xml-js.html">jstree.<wbr>xml.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-rules-js.html">jstree.<wbr>rules.js</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Index</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Events.html">Events</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div></div></div></div><script type="text/javascript"><!--
|
|
25
|
+
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
|
|
26
|
+
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div></div><!--Menu-->
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
<!--START_ND_TOOLTIPS-->
|
|
31
|
+
<!--END_ND_TOOLTIPS-->
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
<script language=JavaScript><!--
|
|
40
|
+
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
|
|
@@ -0,0 +1,313 @@
|
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
|
|
2
|
+
|
|
3
|
+
<html><head><title>jstree.core.js - jstree</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
|
|
4
|
+
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
|
|
5
|
+
|
|
6
|
+
<!-- Generated by Natural Docs, version 1.5 -->
|
|
7
|
+
<!-- http://www.naturaldocs.org -->
|
|
8
|
+
|
|
9
|
+
<!-- saved from url=(0026)http://www.naturaldocs.org -->
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="jstree.core.js"></a>jstree.<wbr>core.js</h1><div class=CBody><p>The only required part of jstree it consists of a few functions bound to the $.jstree object, the actual plugin function and a few core functions for manipulating a tree.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#jstree.core.js" >jstree.<wbr>core.js</a></td><td class=SDescription>The only required part of jstree it consists of a few functions bound to the $.jstree object, the actual plugin function and a few core functions for manipulating a tree.</td></tr><tr class="SGroup"><td class=SEntry><a href="#$.jstree" >$.jstree.</a></td><td class=SDescription>Some static functions and variables, unless you know exactly what you are doing do not use these, but <a href="#$().jstree" class=LGroup id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">$().jstree</a> instead.</td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.jstree" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">$.jstree</a></td><td class=SDescription><b>object</b> Contains all static functions and variables used by jstree, some plugins also append variables.</td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#$.jstree.VERSION" >$.jstree.<wbr>VERSION</a></td><td class=SDescription><b>string</b> the version of jstree</td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.jstree.IS_IE6" >$.jstree.<wbr>IS_IE6</a></td><td class=SDescription><b>boolean</b> indicating if the client is running Internet Explorer 6</td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#$.jstree.IS_IE7" >$.jstree.<wbr>IS_IE7</a></td><td class=SDescription><b>boolean</b> indicating if the client is running Internet Explorer 7</td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.jstree.IS_FF2" >$.jstree.<wbr>IS_FF2</a></td><td class=SDescription><b>boolean</b> indicating if the client is running Firefox 2</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#$.jstree.__construct" >$.jstree.<wbr>__construct</a></td><td class=SDescription>Creates a new jstree instance, any arguments after the first one are merged and used to configure the tree.</td></tr><tr class="SGroup"><td class=SEntry><a href="#$.jstree" >$.jstree.</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.jstree.__destruct" >$.jstree.<wbr>__destruct</a></td><td class=SDescription>Destroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#$.jstree.__call" >$.jstree.<wbr>__call</a></td><td class=SDescription>Call a function on the instance and return the result</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.jstree._reference" >$.jstree.<wbr>_reference</a></td><td class=SDescription>Returns an instance</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#$.jstree._focused" >$.jstree.<wbr>_focused</a></td><td class=SDescription>Returns the currently focused instance (by default once an instance is created it is focused)</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.jstree._focus" >$.jstree.<wbr>_focus</a></td><td class=SDescription>Make an instance focused (which defocuses the previously focused instance)</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#$.jstree.plugin" >$.jstree.<wbr>plugin</a></td><td class=SDescription>Register a plugin</td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.jstree.defaults" >$.jstree.<wbr>defaults</a></td><td class=SDescription><b>object</b> storing all the default configuration options for every plugin and the core. </td></tr><tr class="SGroup"><td class=SEntry><a href="#$().jstree" >$().jstree()</a></td><td class=SDescription>The actual plugin wrapper, use this to create instances or execute functions on created instances.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$().jstree" id=link3 onMouseOver="ShowTip(event, 'tt1', 'link3')" onMouseOut="HideTip('tt1')">$().jstree</a></td><td class=SDescription>Creates an instance using the specified objects for containers, or executes a command on an instance, specified by a container.</td></tr><tr class="SGroup"><td class=SEntry><a href="#$.jstree" >$.jstree.</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.jstree.SCROLLBAR_WIDTH" id=link4 onMouseOver="ShowTip(event, 'tt3', 'link4')" onMouseOut="HideTip('tt3')">$.jstree.<wbr>SCROLLBAR_WIDTH</a></td><td class=SDescription><b>integer</b> indicating the width of the client scrollbar</td></tr><tr class="SClass"><td class=SEntry><a href="#jstree" >jstree</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#jstree.data" >data</a></td><td class=SDescription><b>object</b> Provides storage for plugins (aside from private variables). </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.get_index" >get_index</a></td><td class=SDescription>Returns an <b>integer</b>, which is the instance’s index. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.get_container" >get_container</a></td><td class=SDescription>Returns the jQuery extended container of the tree (the element you used when constructing the tree).</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.get_container_ul" >get_container_ul</a></td><td class=SDescription>Returns the jQuery extended first UL node inside the container of the tree.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.get_settings" >get_settings</a></td><td class=SDescription>Returns the settings for the tree.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.__trigger" >__trigger</a></td><td class=SDescription>Used internally to trigger events on the container node.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#jstree.CORE_options" >CORE options</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#jstree.config.core.strings" >config.<wbr>core.<wbr>strings</a></td><td class=SDescription><b>mixed</b> used to store all localization strings. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#jstree.CORE_functions" >CORE functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree._get_string" id=link5 onMouseOver="ShowTip(event, 'tt4', 'link5')" onMouseOut="HideTip('tt4')">_get_string</a></td><td class=SDescription>Used to get the common string in the tree.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.init" >init</a></td><td class=SDescription>Used internally. </td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#jstree.__loaded" >__loaded</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when data is first rendered in the tree. </td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.__ready" >__ready</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when all initial loading is done. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.lock" >lock</a></td><td class=SDescription>Used to lock the tree. </td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.lock" >lock</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when the tree is locked.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.unlock" >unlock</a></td><td class=SDescription>Used to unlock the tree. </td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.unlock" >unlock</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when the tree is unlocked.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.is_locked" id=link6 onMouseOver="ShowTip(event, 'tt5', 'link6')" onMouseOut="HideTip('tt5')">is_locked</a></td><td class=SDescription>Used to get the locked status of the tree.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.get_node" id=link7 onMouseOver="ShowTip(event, 'tt6', 'link7')" onMouseOut="HideTip('tt6')">get_node</a></td><td class=SDescription>Get a hold of the LI node (which represents the jstree node).</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.get_next" id=link8 onMouseOver="ShowTip(event, 'tt7', 'link8')" onMouseOut="HideTip('tt7')">get_next</a></td><td class=SDescription>Get the next sibling of a node</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.get_prev" id=link9 onMouseOver="ShowTip(event, 'tt8', 'link9')" onMouseOut="HideTip('tt8')">get_prev</a></td><td class=SDescription>Get the previous sibling of a node</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.get_parent" id=link10 onMouseOver="ShowTip(event, 'tt9', 'link10')" onMouseOut="HideTip('tt9')">get_parent</a></td><td class=SDescription>Get the parent of a node</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.get_children" id=link11 onMouseOver="ShowTip(event, 'tt10', 'link11')" onMouseOut="HideTip('tt10')">get_children</a></td><td class=SDescription>Get all the children of a node</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.is_parent" id=link12 onMouseOver="ShowTip(event, 'tt11', 'link12')" onMouseOut="HideTip('tt11')">is_parent</a></td><td class=SDescription>Check if a node is a parent.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.is_loaded" id=link13 onMouseOver="ShowTip(event, 'tt12', 'link13')" onMouseOut="HideTip('tt12')">is_loaded</a></td><td class=SDescription>Check if a node is loaded.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.is_loading" id=link14 onMouseOver="ShowTip(event, 'tt13', 'link14')" onMouseOut="HideTip('tt13')">is_loading</a></td><td class=SDescription>Check if a node is currently loading.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.is_open" id=link15 onMouseOver="ShowTip(event, 'tt14', 'link15')" onMouseOut="HideTip('tt14')">is_open</a></td><td class=SDescription>Check if a node is currently open.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.is_closed" id=link16 onMouseOver="ShowTip(event, 'tt15', 'link16')" onMouseOut="HideTip('tt15')">is_closed</a></td><td class=SDescription>Check if a node is currently closed.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.is_leaf" id=link17 onMouseOver="ShowTip(event, 'tt16', 'link17')" onMouseOut="HideTip('tt16')">is_leaf</a></td><td class=SDescription>Check if a node is a leaf node (has no children).</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.load_node" >load_node</a></td><td class=SDescription>Load the children of a node.</td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.load_node" >load_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is loaded (succesfully or not).</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree._load_node" id=link18 onMouseOver="ShowTip(event, 'tt17', 'link18')" onMouseOut="HideTip('tt17')">_load_node</a></td><td class=SDescription>Load the children of a node, but as opposed to <a href="#jstree.load_node" class=LFunction id=link19 onMouseOver="ShowTip(event, 'tt18', 'link19')" onMouseOut="HideTip('tt18')">load_node</a> does not change any visual properties or trigger events. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.open_node" >open_node</a></td><td class=SDescription>Open a node so that its children are visible. </td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#jstree.open_node" >open_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is successfully opened (but if animation is used this event is triggered BEFORE the animation completes). </td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.__after_open" >__after_open</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is successfully opened AFTER the animation completes). </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.close_node" >close_node</a></td><td class=SDescription>Close a node so that its children are not visible.</td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.close_node" >close_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is closed (but if animation is used this event is triggered BEFORE the animation completes). </td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#jstree.__after_close" >__after_close</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is closed AFTER the animation completes). </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.toggle_node" id=link20 onMouseOver="ShowTip(event, 'tt19', 'link20')" onMouseOut="HideTip('tt19')">toggle_node</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.open_all" >open_all</a></td><td class=SDescription>Open all nodes from a certain node down.</td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.open_all" >open_all</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when an open_all call completes.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.close_all" >close_all</a></td><td class=SDescription>Close all nodes from a certain node down.</td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.close_all" >close_all</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a close_all call completes.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.clean_node" id=link21 onMouseOver="ShowTip(event, 'tt20', 'link21')" onMouseOut="HideTip('tt20')">clean_node</a></td><td class=SDescription>This function converts inserted nodes to the required by jsTree format. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.correct_node" >correct_node</a></td><td class=SDescription>This function corrects the open/closed/leaf state as data changes (as the user interacts with the tree). </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.scroll_to_node" id=link22 onMouseOver="ShowTip(event, 'tt21', 'link22')" onMouseOut="HideTip('tt21')">scroll_to_node</a></td><td class=SDescription>This function scrolls the container to the desired node (if needed).</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.get_state" id=link23 onMouseOver="ShowTip(event, 'tt22', 'link23')" onMouseOut="HideTip('tt22')">get_state</a></td><td class=SDescription>This function returns the current state of the tree (as collected from all active plugins). </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.set_state" >set_state</a></td><td class=SDescription>This function returns sets the state of the tree. </td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.set_state" >set_state</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a set_state call completes.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.refresh" >refresh</a></td><td class=SDescription>This function saves the current state, reloads the complete tree and returns it to the saved state.</td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.refresh" >refresh</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a refresh call completes.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.get_text" id=link24 onMouseOver="ShowTip(event, 'tt23', 'link24')" onMouseOut="HideTip('tt23')">get_text</a></td><td class=SDescription>This function returns the title of the node.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.set_text" >set_text</a></td><td class=SDescription>This function sets the title of the node. </td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#jstree.set_text" >set_text</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a set_text call completes.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.parse_json" id=link25 onMouseOver="ShowTip(event, 'tt24', 'link25')" onMouseOut="HideTip('tt24')">parse_json</a></td><td class=SDescription>This function returns a jQuery node after parsing a JSON object (a LI node for single elements or an UL node for multiple). </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.get_json" id=link26 onMouseOver="ShowTip(event, 'tt25', 'link26')" onMouseOut="HideTip('tt25')">get_json</a></td><td class=SDescription>This function returns the whole tree (or a single node) in JSON format. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.create_node" >create_node</a></td><td class=SDescription>This function creates a new node.</td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#jstree.create_node" >create_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a new node is created.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.rename_node" >rename_node</a></td><td class=SDescription>This function renames a new node.</td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#jstree.rename_node" >rename_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is renamed.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.delete_node" >delete_node</a></td><td class=SDescription>This function deletes a node.</td></tr><tr class="SEvent SIndent2 SMarked"><td class=SEntry><a href="#jstree.delete_node" >delete_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is deleted.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#jstree.check" id=link27 onMouseOver="ShowTip(event, 'tt26', 'link27')" onMouseOut="HideTip('tt26')">check</a></td><td class=SDescription>This function checks if a structure modification is valid.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.move_node" >move_node</a></td><td class=SDescription>This function moves a node.</td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.move_node" >move_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is moved.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#jstree.copy_node" >copy_node</a></td><td class=SDescription>This function copies a node.</td></tr><tr class="SEvent SIndent2"><td class=SEntry><a href="#jstree.copy_node" >copy_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is copied.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
|
|
15
|
+
|
|
16
|
+
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="$.jstree"></a>$.jstree.</h3><div class=CBody><p>Some static functions and variables, unless you know exactly what you are doing do not use these, but <a href="#$().jstree" class=LGroup id=link28 onMouseOver="ShowTip(event, 'tt1', 'link28')" onMouseOut="HideTip('tt1')">$().jstree</a> instead.</p></div></div></div>
|
|
17
|
+
|
|
18
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.jstree"></a>$.jstree</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.jstree</td></tr></table></blockquote><p><b>object</b> Contains all static functions and variables used by jstree, some plugins also append variables.</p></div></div></div>
|
|
19
|
+
|
|
20
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.jstree.VERSION"></a>$.jstree.<wbr>VERSION</h3><div class=CBody><p><b>string</b> the version of jstree</p></div></div></div>
|
|
21
|
+
|
|
22
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.jstree.IS_IE6"></a>$.jstree.<wbr>IS_IE6</h3><div class=CBody><p><b>boolean</b> indicating if the client is running Internet Explorer 6</p></div></div></div>
|
|
23
|
+
|
|
24
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.jstree.IS_IE7"></a>$.jstree.<wbr>IS_IE7</h3><div class=CBody><p><b>boolean</b> indicating if the client is running Internet Explorer 7</p></div></div></div>
|
|
25
|
+
|
|
26
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.jstree.IS_FF2"></a>$.jstree.<wbr>IS_FF2</h3><div class=CBody><p><b>boolean</b> indicating if the client is running Firefox 2</p></div></div></div>
|
|
27
|
+
|
|
28
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.jstree.__construct"></a>$.jstree.<wbr>__construct</h3><div class=CBody><p>Creates a new jstree instance, any arguments after the first one are merged and used to configure the tree.</p><p>`.data(“jstree”)` is also called on the container and is used for configuration (keep in mind you can specify this data using a “data-jstree” attribute)</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>container</td><td class=CDLDescription><b>mixed</b> the container of the tree (this should not be the UL node, but a wrapper) - DOM node, jQuery object or selector</td></tr></table></div></div></div>
|
|
29
|
+
|
|
30
|
+
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="$.jstree"></a>$.jstree.</h3></div></div>
|
|
31
|
+
|
|
32
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.jstree.__destruct"></a>$.jstree.<wbr>__destruct</h3><div class=CBody><p>Destroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>instance</td><td class=CDLDescription><b>mixed</b> the instance to destroy (this argument is passed to <a href="#$.jstree._reference" class=LFunction id=link29 onMouseOver="ShowTip(event, 'tt27', 'link29')" onMouseOut="HideTip('tt27')">$.jstree._reference</a> to get the instance)</td></tr></table><h4 class=CHeading>See also</h4><p><a href="#$.jstree._reference" class=LFunction id=link30 onMouseOver="ShowTip(event, 'tt27', 'link30')" onMouseOut="HideTip('tt27')">$.jstree._reference</a></p></div></div></div>
|
|
33
|
+
|
|
34
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.jstree.__call"></a>$.jstree.<wbr>__call</h3><div class=CBody><p>Call a function on the instance and return the result</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>instance</td><td class=CDLDescription><b>mixed</b> the instance to destroy (this argument is passed to <a href="#$.jstree._reference" class=LFunction id=link31 onMouseOver="ShowTip(event, 'tt27', 'link31')" onMouseOut="HideTip('tt27')">$.jstree._reference</a> to get the instance)</td></tr><tr><td class=CDLEntry>operation</td><td class=CDLDescription><b>string</b> the operation to execute</td></tr><tr><td class=CDLEntry>args</td><td class=CDLDescription><b>array</b> the arguments to pass to the function</td></tr></table><h4 class=CHeading>See also</h4><p><a href="#$.jstree._reference" class=LFunction id=link32 onMouseOver="ShowTip(event, 'tt27', 'link32')" onMouseOut="HideTip('tt27')">$.jstree._reference</a></p></div></div></div>
|
|
35
|
+
|
|
36
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.jstree._reference"></a>$.jstree.<wbr>_reference</h3><div class=CBody><p>Returns an instance</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>needle</td><td class=CDLDescription><b>mixed</b> - integer, DOM node contained inside a jstree container, ID string, jQuery object, selector</td></tr></table></div></div></div>
|
|
37
|
+
|
|
38
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.jstree._focused"></a>$.jstree.<wbr>_focused</h3><div class=CBody><p>Returns the currently focused instance (by default once an instance is created it is focused)</p></div></div></div>
|
|
39
|
+
|
|
40
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.jstree._focus"></a>$.jstree.<wbr>_focus</h3><div class=CBody><p>Make an instance focused (which defocuses the previously focused instance)</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>instance</td><td class=CDLDescription><b>mixed</b> the instance to focus (this argument is passed to <a href="#$.jstree._reference" class=LFunction id=link33 onMouseOver="ShowTip(event, 'tt27', 'link33')" onMouseOut="HideTip('tt27')">$.jstree._reference</a> to get the instance)</td></tr></table><h4 class=CHeading>See also</h4><p><a href="#$.jstree._reference" class=LFunction id=link34 onMouseOver="ShowTip(event, 'tt27', 'link34')" onMouseOut="HideTip('tt27')">$.jstree._reference</a></p></div></div></div>
|
|
41
|
+
|
|
42
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.jstree.plugin"></a>$.jstree.<wbr>plugin</h3><div class=CBody><p>Register a plugin</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>plugin_name</td><td class=CDLDescription><b>string</b> the name of the new plugin (it will be used as a key in an object - make sure it is valid)</td></tr><tr><td class=CDLEntry>plugin_data</td><td class=CDLDescription><b>object</b> consists of 4 keys. Default is:</td></tr></table><blockquote><pre class="prettyprint">{
|
|
43
|
+
__construct : $.noop, // this function will be executed when a new instance is created
|
|
44
|
+
__destuct : $.noop, // this function will be executed when an instance is destroyed
|
|
45
|
+
_fn : { }, // each key of this object should be a function that will extend the jstree prototype
|
|
46
|
+
defaults : false // the default configuration for the plugin (if any)
|
|
47
|
+
}</pre></blockquote></div></div></div>
|
|
48
|
+
|
|
49
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.jstree.defaults"></a>$.jstree.<wbr>defaults</h3><div class=CBody><p><b>object</b> storing all the default configuration options for every plugin and the core. If this is modified all instances created after the modification, which do not explicitly specify some other value will use the new default.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">// this instance will use the _default_ theme
|
|
50
|
+
$("#div0").jstree({ plugins : ["themes"] });
|
|
51
|
+
$.jstree.defaults.themes.theme = "classic";
|
|
52
|
+
// this instance will use the _classic_ theme
|
|
53
|
+
$("#div1").jstree({ plugins : ["themes"] });
|
|
54
|
+
// this instance will use the _apple_ theme
|
|
55
|
+
$("#div2").jstree({ themes : { "theme" : "apple" }, plugins : ["themes"] });</pre></blockquote></div></div></div>
|
|
56
|
+
|
|
57
|
+
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="$().jstree"></a>$().jstree()</h3><div class=CBody><p>The actual plugin wrapper, use this to create instances or execute functions on created instances.</p></div></div></div>
|
|
58
|
+
|
|
59
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$().jstree"></a>$().jstree</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>$.fn.jstree = function (</td><td class=PParameter nowrap>settings</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates an instance using the specified objects for containers, or executes a command on an instance, specified by a container.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>settings</td><td class=CDLDescription><b>mixed</b></td></tr></table><ul><li>if you pass an <b>object</b> a new instance will be created (using <a href="#$.jstree.__construct" class=LFunction id=link35 onMouseOver="ShowTip(event, 'tt28', 'link35')" onMouseOut="HideTip('tt28')">$.jstree.__construct</a>) for each of the objects in the jquery collection, if an instance already exists on the container it will be destroyed first</li><li>if you pass a <b>string</b> it will be executed using <a href="#$.jstree.__call" class=LFunction id=link36 onMouseOver="ShowTip(event, 'tt29', 'link36')" onMouseOut="HideTip('tt29')">$.jstree.__call</a> on each instance</li></ul><h4 class=CHeading>Examples</h4><blockquote><pre class="prettyprint">// this creates an instance
|
|
60
|
+
$("#some-id").jstree({
|
|
61
|
+
plugins : [ "html_data", "themes", "ui" ]
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
// this executes a function on the instance
|
|
65
|
+
$("#some-id").jstree("select_node", "#the-id-to-select");</pre></blockquote><h4 class=CHeading>See also</h4><p><a href="#$.jstree.__construct" class=LFunction id=link37 onMouseOver="ShowTip(event, 'tt28', 'link37')" onMouseOut="HideTip('tt28')">$.jstree.__construct</a>, <a href="#$.jstree.__destruct" class=LFunction id=link38 onMouseOver="ShowTip(event, 'tt30', 'link38')" onMouseOut="HideTip('tt30')">$.jstree.__destruct</a>, <a href="#$.jstree.__call" class=LFunction id=link39 onMouseOver="ShowTip(event, 'tt29', 'link39')" onMouseOut="HideTip('tt29')">$.jstree.__call</a></p></div></div></div>
|
|
66
|
+
|
|
67
|
+
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="$.jstree"></a>$.jstree.</h3></div></div>
|
|
68
|
+
|
|
69
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.jstree.SCROLLBAR_WIDTH"></a>$.jstree.<wbr>SCROLLBAR_WIDTH</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.jstree.SCROLLBAR_WIDTH</td></tr></table></blockquote><p><b>integer</b> indicating the width of the client scrollbar</p></div></div></div>
|
|
70
|
+
|
|
71
|
+
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="jstree"></a>jstree</h2><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SVariable"><td class=SEntry><a href="#jstree.data" >data</a></td><td class=SDescription><b>object</b> Provides storage for plugins (aside from private variables). </td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#jstree.get_index" >get_index</a></td><td class=SDescription>Returns an <b>integer</b>, which is the instance’s index. </td></tr><tr class="SFunction"><td class=SEntry><a href="#jstree.get_container" >get_container</a></td><td class=SDescription>Returns the jQuery extended container of the tree (the element you used when constructing the tree).</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#jstree.get_container_ul" >get_container_ul</a></td><td class=SDescription>Returns the jQuery extended first UL node inside the container of the tree.</td></tr><tr class="SFunction"><td class=SEntry><a href="#jstree.get_settings" >get_settings</a></td><td class=SDescription>Returns the settings for the tree.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#jstree.__trigger" >__trigger</a></td><td class=SDescription>Used internally to trigger events on the container node.</td></tr><tr class="SGroup"><td class=SEntry><a href="#jstree.CORE_options" >CORE options</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#jstree.config.core.strings" >config.<wbr>core.<wbr>strings</a></td><td class=SDescription><b>mixed</b> used to store all localization strings. </td></tr><tr class="SGroup"><td class=SEntry><a href="#jstree.CORE_functions" >CORE functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree._get_string" id=link40 onMouseOver="ShowTip(event, 'tt4', 'link40')" onMouseOut="HideTip('tt4')">_get_string</a></td><td class=SDescription>Used to get the common string in the tree.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.init" >init</a></td><td class=SDescription>Used internally. </td></tr><tr class="SEvent SIndent1 SMarked"><td class=SEntry><a href="#jstree.__loaded" >__loaded</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when data is first rendered in the tree. </td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.__ready" >__ready</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when all initial loading is done. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.lock" >lock</a></td><td class=SDescription>Used to lock the tree. </td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.lock" >lock</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when the tree is locked.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.unlock" >unlock</a></td><td class=SDescription>Used to unlock the tree. </td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.unlock" >unlock</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when the tree is unlocked.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.is_locked" id=link41 onMouseOver="ShowTip(event, 'tt5', 'link41')" onMouseOut="HideTip('tt5')">is_locked</a></td><td class=SDescription>Used to get the locked status of the tree.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.get_node" id=link42 onMouseOver="ShowTip(event, 'tt6', 'link42')" onMouseOut="HideTip('tt6')">get_node</a></td><td class=SDescription>Get a hold of the LI node (which represents the jstree node).</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.get_next" id=link43 onMouseOver="ShowTip(event, 'tt7', 'link43')" onMouseOut="HideTip('tt7')">get_next</a></td><td class=SDescription>Get the next sibling of a node</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.get_prev" id=link44 onMouseOver="ShowTip(event, 'tt8', 'link44')" onMouseOut="HideTip('tt8')">get_prev</a></td><td class=SDescription>Get the previous sibling of a node</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.get_parent" id=link45 onMouseOver="ShowTip(event, 'tt9', 'link45')" onMouseOut="HideTip('tt9')">get_parent</a></td><td class=SDescription>Get the parent of a node</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.get_children" id=link46 onMouseOver="ShowTip(event, 'tt10', 'link46')" onMouseOut="HideTip('tt10')">get_children</a></td><td class=SDescription>Get all the children of a node</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.is_parent" id=link47 onMouseOver="ShowTip(event, 'tt11', 'link47')" onMouseOut="HideTip('tt11')">is_parent</a></td><td class=SDescription>Check if a node is a parent.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.is_loaded" id=link48 onMouseOver="ShowTip(event, 'tt12', 'link48')" onMouseOut="HideTip('tt12')">is_loaded</a></td><td class=SDescription>Check if a node is loaded.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.is_loading" id=link49 onMouseOver="ShowTip(event, 'tt13', 'link49')" onMouseOut="HideTip('tt13')">is_loading</a></td><td class=SDescription>Check if a node is currently loading.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.is_open" id=link50 onMouseOver="ShowTip(event, 'tt14', 'link50')" onMouseOut="HideTip('tt14')">is_open</a></td><td class=SDescription>Check if a node is currently open.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.is_closed" id=link51 onMouseOver="ShowTip(event, 'tt15', 'link51')" onMouseOut="HideTip('tt15')">is_closed</a></td><td class=SDescription>Check if a node is currently closed.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.is_leaf" id=link52 onMouseOver="ShowTip(event, 'tt16', 'link52')" onMouseOut="HideTip('tt16')">is_leaf</a></td><td class=SDescription>Check if a node is a leaf node (has no children).</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.load_node" >load_node</a></td><td class=SDescription>Load the children of a node.</td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.load_node" >load_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is loaded (succesfully or not).</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree._load_node" id=link53 onMouseOver="ShowTip(event, 'tt17', 'link53')" onMouseOut="HideTip('tt17')">_load_node</a></td><td class=SDescription>Load the children of a node, but as opposed to <a href="#jstree.load_node" class=LFunction id=link54 onMouseOver="ShowTip(event, 'tt18', 'link54')" onMouseOut="HideTip('tt18')">load_node</a> does not change any visual properties or trigger events. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.open_node" >open_node</a></td><td class=SDescription>Open a node so that its children are visible. </td></tr><tr class="SEvent SIndent1 SMarked"><td class=SEntry><a href="#jstree.open_node" >open_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is successfully opened (but if animation is used this event is triggered BEFORE the animation completes). </td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.__after_open" >__after_open</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is successfully opened AFTER the animation completes). </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.close_node" >close_node</a></td><td class=SDescription>Close a node so that its children are not visible.</td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.close_node" >close_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is closed (but if animation is used this event is triggered BEFORE the animation completes). </td></tr><tr class="SEvent SIndent1 SMarked"><td class=SEntry><a href="#jstree.__after_close" >__after_close</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is closed AFTER the animation completes). </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.toggle_node" id=link55 onMouseOver="ShowTip(event, 'tt19', 'link55')" onMouseOut="HideTip('tt19')">toggle_node</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.open_all" >open_all</a></td><td class=SDescription>Open all nodes from a certain node down.</td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.open_all" >open_all</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when an open_all call completes.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.close_all" >close_all</a></td><td class=SDescription>Close all nodes from a certain node down.</td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.close_all" >close_all</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a close_all call completes.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.clean_node" id=link56 onMouseOver="ShowTip(event, 'tt20', 'link56')" onMouseOut="HideTip('tt20')">clean_node</a></td><td class=SDescription>This function converts inserted nodes to the required by jsTree format. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.correct_node" >correct_node</a></td><td class=SDescription>This function corrects the open/closed/leaf state as data changes (as the user interacts with the tree). </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.scroll_to_node" id=link57 onMouseOver="ShowTip(event, 'tt21', 'link57')" onMouseOut="HideTip('tt21')">scroll_to_node</a></td><td class=SDescription>This function scrolls the container to the desired node (if needed).</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.get_state" id=link58 onMouseOver="ShowTip(event, 'tt22', 'link58')" onMouseOut="HideTip('tt22')">get_state</a></td><td class=SDescription>This function returns the current state of the tree (as collected from all active plugins). </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.set_state" >set_state</a></td><td class=SDescription>This function returns sets the state of the tree. </td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.set_state" >set_state</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a set_state call completes.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.refresh" >refresh</a></td><td class=SDescription>This function saves the current state, reloads the complete tree and returns it to the saved state.</td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.refresh" >refresh</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a refresh call completes.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.get_text" id=link59 onMouseOver="ShowTip(event, 'tt23', 'link59')" onMouseOut="HideTip('tt23')">get_text</a></td><td class=SDescription>This function returns the title of the node.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.set_text" >set_text</a></td><td class=SDescription>This function sets the title of the node. </td></tr><tr class="SEvent SIndent1 SMarked"><td class=SEntry><a href="#jstree.set_text" >set_text</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a set_text call completes.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.parse_json" id=link60 onMouseOver="ShowTip(event, 'tt24', 'link60')" onMouseOut="HideTip('tt24')">parse_json</a></td><td class=SDescription>This function returns a jQuery node after parsing a JSON object (a LI node for single elements or an UL node for multiple). </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.get_json" id=link61 onMouseOver="ShowTip(event, 'tt25', 'link61')" onMouseOut="HideTip('tt25')">get_json</a></td><td class=SDescription>This function returns the whole tree (or a single node) in JSON format. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.create_node" >create_node</a></td><td class=SDescription>This function creates a new node.</td></tr><tr class="SEvent SIndent1 SMarked"><td class=SEntry><a href="#jstree.create_node" >create_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a new node is created.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.rename_node" >rename_node</a></td><td class=SDescription>This function renames a new node.</td></tr><tr class="SEvent SIndent1 SMarked"><td class=SEntry><a href="#jstree.rename_node" >rename_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is renamed.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.delete_node" >delete_node</a></td><td class=SDescription>This function deletes a node.</td></tr><tr class="SEvent SIndent1 SMarked"><td class=SEntry><a href="#jstree.delete_node" >delete_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is deleted.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#jstree.check" id=link62 onMouseOver="ShowTip(event, 'tt26', 'link62')" onMouseOut="HideTip('tt26')">check</a></td><td class=SDescription>This function checks if a structure modification is valid.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.move_node" >move_node</a></td><td class=SDescription>This function moves a node.</td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.move_node" >move_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is moved.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#jstree.copy_node" >copy_node</a></td><td class=SDescription>This function copies a node.</td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#jstree.copy_node" >copy_node</a></td><td class=SDescription>This event is triggered in the <b>jstree</b> namespace when a node is copied.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
|
|
72
|
+
|
|
73
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="jstree.data"></a>data</h3><div class=CBody><p><b>object</b> Provides storage for plugins (aside from private variables). Every plugin has an key in this object.</p><blockquote><pre class="prettyprint">this.data.<plugin_name>;</pre></blockquote><p>This is useful for detecting if some plugin is included in the instance (plugins also use this for dependencies and enhancements).</p></div></div></div>
|
|
74
|
+
|
|
75
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_index"></a>get_index</h3><div class=CBody><p>Returns an <b>integer</b>, which is the instance’s index. Every instance on the page has an unique index, when destroying an intance the index will not be reused.</p></div></div></div>
|
|
76
|
+
|
|
77
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_container"></a>get_container</h3><div class=CBody><p>Returns the jQuery extended container of the tree (the element you used when constructing the tree).</p></div></div></div>
|
|
78
|
+
|
|
79
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_container_ul"></a>get_container_ul</h3><div class=CBody><p>Returns the jQuery extended first UL node inside the container of the tree.</p></div></div></div>
|
|
80
|
+
|
|
81
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_settings"></a>get_settings</h3><div class=CBody><p>Returns the settings for the tree.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>writable</td><td class=CDLDescription><b>boolean</b> whether to return a copy of the settings object or a reference to it.</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("#div1").jstree("get_settings"); // will return a copy
|
|
82
|
+
$.jstree._reference("#div1").get_settings(); // same as above
|
|
83
|
+
$.jstree._focused().get_settings(true); // a reference. BE CAREFUL!</pre></blockquote></div></div></div>
|
|
84
|
+
|
|
85
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.__trigger"></a>__trigger</h3><div class=CBody><p>Used internally to trigger events on the container node.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event_name</td><td class=CDLDescription>the name of the event to trigger (the <b>jstree</b> namespace will be appended to it)</td></tr><tr><td class=CDLEntry>data</td><td class=CDLDescription>the additional object to pass along with the event. By default <u>data.inst</u> will be the current instance, so when you bind to the event, you can access the instance easily.</td></tr></table><blockquote><pre class="prettyprint">$("div").bind("some-event.jstree", function (e, data) { data.inst.some_function(); });</pre></blockquote></div></div></div>
|
|
86
|
+
|
|
87
|
+
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="jstree.CORE_options"></a>CORE options</h3></div></div>
|
|
88
|
+
|
|
89
|
+
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="jstree.config.core.strings"></a>config.<wbr>core.<wbr>strings</h3><div class=CBody><p><b>mixed</b> used to store all localization strings. Default is <u>false</u>.</p><h4 class=CHeading>Example 1</h4><blockquote><pre class="prettyprint">$("div").jstree({
|
|
90
|
+
core : {
|
|
91
|
+
strings : function (s) {
|
|
92
|
+
if(s === "Loading ...") { s = "Please wait ..."; }
|
|
93
|
+
return s;
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
});</pre></blockquote><h4 class=CHeading>Example 2</h4><blockquote><pre class="prettyprint">$("div").jstree({
|
|
97
|
+
core : {
|
|
98
|
+
strings : {
|
|
99
|
+
"Loading ..." : "Please wait ..."
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
});</pre></blockquote><h4 class=CHeading>See also</h4><p><a href="#jstree._get_string" class=LFunction id=link63 onMouseOver="ShowTip(event, 'tt4', 'link63')" onMouseOut="HideTip('tt4')">_get_string</a></p></div></div></div>
|
|
103
|
+
|
|
104
|
+
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="jstree.CORE_functions"></a>CORE functions</h3></div></div>
|
|
105
|
+
|
|
106
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree._get_string"></a>_get_string</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>_get_string : function (</td><td class=PParameter nowrap>s</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Used to get the common string in the tree.</p><p>If <a href="#jstree.config.core.strings" class=LVariable id=link64 onMouseOver="ShowTip(event, 'tt31', 'link64')" onMouseOut="HideTip('tt31')">config.core.strings</a> is set to a function, that function is called with a single parameter (the needed string), the response is returned.</p><p>If <a href="#jstree.config.core.strings" class=LVariable id=link65 onMouseOver="ShowTip(event, 'tt31', 'link65')" onMouseOut="HideTip('tt31')">config.core.strings</a> is set to an object, the key named as the needed string is returned.</p><p>If <a href="#jstree.config.core.strings" class=LVariable id=link66 onMouseOver="ShowTip(event, 'tt31', 'link66')" onMouseOut="HideTip('tt31')">config.core.strings</a> is not set, the the needed string is returned.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>needed_string</td><td class=CDLDescription><b>string</b> the needed string</td></tr></table></div></div></div>
|
|
107
|
+
|
|
108
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.init"></a>init</h3><div class=CBody><p>Used internally. This function is called once the core plugin is constructed.</p><h4 class=CHeading>Triggers</h4><p><a href="#jstree.__loaded" class=LEvent id=link67 onMouseOver="ShowTip(event, 'tt32', 'link67')" onMouseOut="HideTip('tt32')">__loaded</a></p></div></div></div>
|
|
109
|
+
|
|
110
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.__loaded"></a>__loaded</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when data is first rendered in the tree. It won’t be triggered after a refresh. Fires only once.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("__loaded.jstree", function (e, data) { data.inst.do_something(); });</pre></blockquote></div></div></div>
|
|
111
|
+
|
|
112
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.__ready"></a>__ready</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when all initial loading is done. It won’t be triggered after a refresh. Fires only once.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr></table></div></div></div>
|
|
113
|
+
|
|
114
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.lock"></a>lock</h3><div class=CBody><p>Used to lock the tree. When the tree is in a locked state, no functions can be called on the instance (except <a href="#jstree.is_locked" class=LFunction id=link68 onMouseOver="ShowTip(event, 'tt5', 'link68')" onMouseOut="HideTip('tt5')">is_locked</a> and <a href="#jstree.unlock" class=LFunction id=link69 onMouseOver="ShowTip(event, 'tt33', 'link69')" onMouseOut="HideTip('tt33')">unlock</a>). Additionally a <u>jstree-locked</u> class is applied on the container.</p><h4 class=CHeading>Triggers</h4><p><a href="#jstree.lock" class=LFunction id=link70 onMouseOver="ShowTip(event, 'tt34', 'link70')" onMouseOut="HideTip('tt34')">lock</a></p></div></div></div>
|
|
115
|
+
|
|
116
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.lock"></a>lock</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when the tree is locked.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else).</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><u>null</u></td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("lock.jstree", function (e, data) { data.inst.do_something(); });</pre></blockquote></div></div></div>
|
|
117
|
+
|
|
118
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.unlock"></a>unlock</h3><div class=CBody><p>Used to unlock the tree. Instance can be used normally again. The <u>jstree-locked</u> class is removed from the container.</p><h4 class=CHeading>Triggers</h4><p><a href="#jstree.unlock" class=LFunction id=link71 onMouseOver="ShowTip(event, 'tt33', 'link71')" onMouseOut="HideTip('tt33')">unlock</a></p></div></div></div>
|
|
119
|
+
|
|
120
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.unlock"></a>unlock</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when the tree is unlocked.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else).</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><u>null</u></td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("unlock.jstree", function (e, data) { data.inst.do_something(); });</pre></blockquote></div></div></div>
|
|
121
|
+
|
|
122
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.is_locked"></a>is_locked</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>is_locked : function ()</td></tr></table></blockquote><p>Used to get the locked status of the tree.</p><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>locked</td><td class=CDLDescription><b>boolean</b> <u>true</u> if tree is locked, <u>false</u> otherwise</td></tr></table></div></div></div>
|
|
123
|
+
|
|
124
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_node"></a>get_node</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_node : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get a hold of the LI node (which represents the jstree node).</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>jquery collection</td><td class=CDLDescription>node was found, the collection contains the LI node</td></tr><tr><td class=CDLEntry>-1</td><td class=CDLDescription>the tree container was referenced</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription>on failure (obj is not part of a tree, or does not exists in the DOM)</td></tr></table></div></div></div>
|
|
125
|
+
|
|
126
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_next"></a>get_next</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_next : function (</td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>strict</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get the next sibling of a node</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr><tr><td class=CDLEntry>strict</td><td class=CDLDescription><b>boolean</b> if set to <u>true</u> jstree will only return immediate siblings, otherwise, if <u>obj</u> is the last child of its parent, the parent’s next sibling is returned.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>jquery collection</td><td class=CDLDescription>node was found, the collection contains the LI node</td></tr><tr><td class=CDLEntry>-1</td><td class=CDLDescription>the tree container was referenced</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription>node was not found, or failure (obj is not part of a tree, or does not exists in the DOM)</td></tr></table></div></div></div>
|
|
127
|
+
|
|
128
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_prev"></a>get_prev</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_prev : function (</td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>strict</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get the previous sibling of a node</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr><tr><td class=CDLEntry>strict</td><td class=CDLDescription><b>boolean</b> if set to <u>true</u> jstree will only return immediate siblings, otherwise, if <u>obj</u> is the first child of its parent, the parent’s previous sibling is returned.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>jquery collection</td><td class=CDLDescription>node was found, the collection contains the LI node</td></tr><tr><td class=CDLEntry>-1</td><td class=CDLDescription>the tree container was referenced</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription>node was not found, or failure (obj is not part of a tree, or does not exists in the DOM)</td></tr></table></div></div></div>
|
|
129
|
+
|
|
130
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_parent"></a>get_parent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_parent : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get the parent of a node</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>jquery collection</td><td class=CDLDescription>node was found, the collection contains the LI node</td></tr><tr><td class=CDLEntry>-1</td><td class=CDLDescription>when <u>obj</u> was a root node</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription>on failure (obj is not part of a tree, or does not exists in the DOM)</td></tr></table></div></div></div>
|
|
131
|
+
|
|
132
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_children"></a>get_children</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_children : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get all the children of a node</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc. If <u>-1</u> is used all root nodes are returned.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>jquery collection</td><td class=CDLDescription>node was found, the collection contains the LI nodes of all immediate children</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription>on failure (obj is not part of a tree, or does not exists in the DOM)</td></tr></table></div></div></div>
|
|
133
|
+
|
|
134
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.is_parent"></a>is_parent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_parent : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Check if a node is a parent.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>true</td><td class=CDLDescription><u>obj</u> has children or is closed (will be loaded)</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription><u>obj</u> is not a valid node or has no children (leaf node)</td></tr></table></div></div></div>
|
|
135
|
+
|
|
136
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.is_loaded"></a>is_loaded</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_loaded : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Check if a node is loaded.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>true</td><td class=CDLDescription><u>obj</u> has children or is leaf</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription><u>obj</u> is currently loading or is not a leaf, but has no children</td></tr></table></div></div></div>
|
|
137
|
+
|
|
138
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.is_loading"></a>is_loading</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_loading : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Check if a node is currently loading.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>true</td><td class=CDLDescription><u>obj</u> is currently loading</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription><u>obj</u> is not currently loading</td></tr></table></div></div></div>
|
|
139
|
+
|
|
140
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.is_open"></a>is_open</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_open : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Check if a node is currently open.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>true</td><td class=CDLDescription><u>obj</u> is currently open</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription><u>obj</u> is not currently open</td></tr></table></div></div></div>
|
|
141
|
+
|
|
142
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.is_closed"></a>is_closed</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_closed : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Check if a node is currently closed.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>true</td><td class=CDLDescription><u>obj</u> is currently closed</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription><u>obj</u> is not currently closed</td></tr></table></div></div></div>
|
|
143
|
+
|
|
144
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.is_leaf"></a>is_leaf</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_leaf : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Check if a node is a leaf node (has no children).</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>true</td><td class=CDLDescription><u>obj</u> is a leaf node</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription><u>obj</u> is not a leaf node</td></tr></table></div></div></div>
|
|
145
|
+
|
|
146
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.load_node"></a>load_node</h3><div class=CBody><p>Load the children of a node.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc. Use -1 to load the root nodes.</td></tr><tr><td class=CDLEntry>callback</td><td class=CDLDescription>a function to be executed in the tree’s scope. Receives two arguments: <u>obj</u> (the same node used to call load_node), <u>status</u> (a boolean indicating if the node was loaded successfully.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>true</td><td class=CDLDescription><u>obj</u> is a valid node and will try loading it</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription><u>obj</u> is not a valid node</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.load_node" class=LFunction id=link72 onMouseOver="ShowTip(event, 'tt18', 'link72')" onMouseOut="HideTip('tt18')">load_node</a></p><h4 class=CHeading>See also</h4><p><a href="#jstree._load_node" class=LFunction id=link73 onMouseOver="ShowTip(event, 'tt17', 'link73')" onMouseOut="HideTip('tt17')">_load_node</a></p></div></div></div>
|
|
147
|
+
|
|
148
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.load_node"></a>load_node</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a node is loaded (succesfully or not).</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else).</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains two keys <u>obj</u> (the loaded node) and <u>status</u> - whether the node was loaded successfully.</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("load_node.jstree", function (e, data) { if(data.rslt.status) { data.inst.open_node(data.rslt.obj); } });</pre></blockquote></div></div></div>
|
|
149
|
+
|
|
150
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree._load_node"></a>_load_node</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>_load_node : function (</td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>callback</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Load the children of a node, but as opposed to <a href="#jstree.load_node" class=LFunction id=link74 onMouseOver="ShowTip(event, 'tt18', 'link74')" onMouseOut="HideTip('tt18')">load_node</a> does not change any visual properties or trigger events. This function is used in <a href="#jstree.load_node" class=LFunction id=link75 onMouseOver="ShowTip(event, 'tt18', 'link75')" onMouseOut="HideTip('tt18')">load_node</a> internally. The idea is for data source plugins to overwrite this function. This implementation (from the <b>core</b>) only uses markup found in the tree container, and does not load async.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc. Use -1 to load the root nodes.</td></tr><tr><td class=CDLEntry>callback</td><td class=CDLDescription>a function to be executed in the tree’s scope. Receives one argument: <u>status</u> (a boolean indicating if the node was loaded successfully).</td></tr></table></div></div></div>
|
|
151
|
+
|
|
152
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.open_node"></a>open_node</h3><div class=CBody><p>Open a node so that its children are visible. If the node is not loaded try loading it first.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr><tr><td class=CDLEntry>callback</td><td class=CDLDescription>a function to be executed in the tree’s scope. Receives two arguments: <u>obj</u> (the node being opened) and <u>status</u> (a boolean indicating if the node was opened successfully).</td></tr><tr><td class=CDLEntry>animation</td><td class=CDLDescription>the duration in miliseconds of the slideDown animation. If not supplied the jQuery default is used. Please note that on IE6 a <u>0</u> is enforced here due to performance issues.</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.open_node" class=LFunction id=link76 onMouseOver="ShowTip(event, 'tt35', 'link76')" onMouseOut="HideTip('tt35')">open_node</a>, <a href="#jstree.__after_open" class=LEvent id=link77 onMouseOver="ShowTip(event, 'tt36', 'link77')" onMouseOut="HideTip('tt36')">__after_open</a></p></div></div></div>
|
|
153
|
+
|
|
154
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.open_node"></a>open_node</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a node is successfully opened (but if animation is used this event is triggered BEFORE the animation completes). See <a href="#jstree.__after_open" class=LEvent id=link78 onMouseOver="ShowTip(event, 'tt36', 'link78')" onMouseOut="HideTip('tt36')">__after_open</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else).</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a single key: <u>obj</u> (the opened node).</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("open_node.jstree", function (e, data) {
|
|
155
|
+
data.rslt.obj.find('> ul > .jstree-closed').each(function () {
|
|
156
|
+
data.inst.open_node(this);
|
|
157
|
+
}
|
|
158
|
+
});</pre></blockquote></div></div></div>
|
|
159
|
+
|
|
160
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.__after_open"></a>__after_open</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a node is successfully opened AFTER the animation completes). See <a href="#jstree.open_node" class=LFunction id=link79 onMouseOver="ShowTip(event, 'tt35', 'link79')" onMouseOut="HideTip('tt35')">open_node</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a single key: <u>obj</u> (the opened node).</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("__after_open.jstree", function (e, data) {
|
|
161
|
+
data.rslt.obj.find('> ul > .jstree-closed').each(function () {
|
|
162
|
+
data.inst.open_node(this);
|
|
163
|
+
}
|
|
164
|
+
});</pre></blockquote></div></div></div>
|
|
165
|
+
|
|
166
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.close_node"></a>close_node</h3><div class=CBody><p>Close a node so that its children are not visible.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr><tr><td class=CDLEntry>animation</td><td class=CDLDescription>the duration in miliseconds of the slideDown animation. If not supplied the jQuery default is used. Please note that on IE6 a <u>0</u> is enforced here due to performance issues.</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.close_node" class=LFunction id=link80 onMouseOver="ShowTip(event, 'tt37', 'link80')" onMouseOut="HideTip('tt37')">close_node</a>, <a href="#jstree.__after_close" class=LEvent id=link81 onMouseOver="ShowTip(event, 'tt38', 'link81')" onMouseOut="HideTip('tt38')">__after_close</a></p></div></div></div>
|
|
167
|
+
|
|
168
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.close_node"></a>close_node</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a node is closed (but if animation is used this event is triggered BEFORE the animation completes). See <a href="#jstree.__after_close" class=LEvent id=link82 onMouseOver="ShowTip(event, 'tt38', 'link82')" onMouseOut="HideTip('tt38')">__after_close</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else).</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a single key: <u>obj</u> (the closed node).</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("close_node.jstree", function (e, data) {
|
|
169
|
+
data.rslt.obj.children('ul').remove();
|
|
170
|
+
});</pre></blockquote></div></div></div>
|
|
171
|
+
|
|
172
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.__after_close"></a>__after_close</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a node is closed AFTER the animation completes). See <a href="#jstree.close_node" class=LFunction id=link83 onMouseOver="ShowTip(event, 'tt37', 'link83')" onMouseOut="HideTip('tt37')">close_node</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a single key: <u>obj</u> (the opened node).</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("__after_close.jstree", function (e, data) {
|
|
173
|
+
data.rslt.obj.children('ul').remove();
|
|
174
|
+
});</pre></blockquote></div></div></div>
|
|
175
|
+
|
|
176
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.toggle_node"></a>toggle_node</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>toggle_node : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>If a node is closed</td><td class=CDLDescription>open it, if it is open - close it.</td></tr></table><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr></table></div></div></div>
|
|
177
|
+
|
|
178
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.open_all"></a>open_all</h3><div class=CBody><p>Open all nodes from a certain node down.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc. If <u>-1</u> is used or is omitted all nodes in the tree are opened.</td></tr><tr><td class=CDLEntry>animation</td><td class=CDLDescription>the duration of the slideDown animation when opening the nodes. If not set <u>0</u> is enforced for performance issues.</td></tr><tr><td class=CDLEntry>original_obj</td><td class=CDLDescription>used internally to keep track of the recursion - do not set manually!</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.open_all" class=LFunction id=link84 onMouseOver="ShowTip(event, 'tt39', 'link84')" onMouseOut="HideTip('tt39')">open_all</a></p></div></div></div>
|
|
179
|
+
|
|
180
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.open_all"></a>open_all</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when an open_all call completes.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else).</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a single key: <u>obj</u> (the node used in the call).</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("open_all.jstree", function (e, data) {
|
|
181
|
+
alert('DONE');
|
|
182
|
+
});</pre></blockquote></div></div></div>
|
|
183
|
+
|
|
184
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.close_all"></a>close_all</h3><div class=CBody><p>Close all nodes from a certain node down.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc. If <u>-1</u> is used or is omitted all nodes in the tree are closed.</td></tr><tr><td class=CDLEntry>animation</td><td class=CDLDescription>the duration of the slideDown animation when closing the nodes. If not set <u>0</u> is enforced for performance issues.</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.close_all" class=LFunction id=link85 onMouseOver="ShowTip(event, 'tt40', 'link85')" onMouseOut="HideTip('tt40')">close_all</a></p></div></div></div>
|
|
185
|
+
|
|
186
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.close_all"></a>close_all</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a close_all call completes.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else).</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a single key: <u>obj</u> (the node used in the call).</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("close_all.jstree", function (e, data) {
|
|
187
|
+
alert('DONE');
|
|
188
|
+
});</pre></blockquote></div></div></div>
|
|
189
|
+
|
|
190
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.clean_node"></a>clean_node</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>clean_node : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>This function converts inserted nodes to the required by jsTree format. It takes care of converting a simple unodreder list to the internally used markup. The core calls this function automatically when new data arrives (by binding to the <a href="#jstree.load_node" class=LFunction id=link86 onMouseOver="ShowTip(event, 'tt18', 'link86')" onMouseOut="HideTip('tt18')">load_node</a> event). Each plugin may override this function to include its own source, but keep in mind to do it like that:</p><blockquote><pre class="prettyprint">clean_node : function(obj) {
|
|
191
|
+
obj = this.__call_old();
|
|
192
|
+
obj.each(function () {
|
|
193
|
+
// do your stuff here
|
|
194
|
+
});
|
|
195
|
+
}</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc. If <u>-1</u> is used or is omitted all nodes in the tree are cleaned.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>jQuery collection</td><td class=CDLDescription>the cleaned children of the original node.</td></tr></table></div></div></div>
|
|
196
|
+
|
|
197
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.correct_node"></a>correct_node</h3><div class=CBody><p>This function corrects the open/closed/leaf state as data changes (as the user interacts with the tree). The core calls this function automatically when a node is opened, deleted or moved.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc. If <u>-1</u> is used or is omitted the root nodes are processed.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>jQuery collection</td><td class=CDLDescription>the processed children of the original node.</td></tr></table></div></div></div>
|
|
198
|
+
|
|
199
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.scroll_to_node"></a>scroll_to_node</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>scroll_to_node : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>This function scrolls the container to the desired node (if needed).</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr></table></div></div></div>
|
|
200
|
+
|
|
201
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_state"></a>get_state</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>get_state : function ()</td></tr></table></blockquote><p>This function returns the current state of the tree (as collected from all active plugins). Plugin authors: pay special attention to the way this function is extended for new plugins. In your plugin code write:</p><blockquote><pre class="prettyprint">get_state : function () {
|
|
202
|
+
var state = this.__call_old();
|
|
203
|
+
state.your-plugin-name = <some-value-you-collect>;
|
|
204
|
+
return state;
|
|
205
|
+
}</pre></blockquote><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>object</td><td class=CDLDescription>the current state of the instance</td></tr></table></div></div></div>
|
|
206
|
+
|
|
207
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.set_state"></a>set_state</h3><div class=CBody><p>This function returns sets the state of the tree. Plugin authors: pay special attention to the way this function is extended for new plugins. In your plugin code write:</p><blockquote><pre class="prettyprint">set_state : function (state, callback) {
|
|
208
|
+
if(this.__call_old()) {
|
|
209
|
+
if(state.your-plugin-name) {
|
|
210
|
+
|
|
211
|
+
// restore using `state.your-plugin-name`
|
|
212
|
+
// if you need some async activity so that you return to this bit of code
|
|
213
|
+
// do not delete state.your-plugin-name and return false (see core's function for example)
|
|
214
|
+
|
|
215
|
+
delete state.your-plugin-name;
|
|
216
|
+
this.set_state(state, callback);
|
|
217
|
+
return false;
|
|
218
|
+
}
|
|
219
|
+
return true;
|
|
220
|
+
}
|
|
221
|
+
return false;
|
|
222
|
+
}</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><b>object</b> the state to restore to</td></tr><tr><td class=CDLEntry>callback</td><td class=CDLDescription><b>function</b> this will be executed in the instance’s scope once restoring is done</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>boolean</td><td class=CDLDescription>the return value is used to determine the phase of restoration</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.set_state" class=LFunction id=link87 onMouseOver="ShowTip(event, 'tt41', 'link87')" onMouseOut="HideTip('tt41')">set_state</a></p></div></div></div>
|
|
223
|
+
|
|
224
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.set_state"></a>set_state</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a set_state call completes.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else)</td></tr></table></div></div></div>
|
|
225
|
+
|
|
226
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.refresh"></a>refresh</h3><div class=CBody><p>This function saves the current state, reloads the complete tree and returns it to the saved state.</p><h4 class=CHeading>Triggers</h4><p><a href="#jstree.refresh" class=LFunction id=link88 onMouseOver="ShowTip(event, 'tt42', 'link88')" onMouseOut="HideTip('tt42')">refresh</a></p></div></div></div>
|
|
227
|
+
|
|
228
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.refresh"></a>refresh</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a refresh call completes.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr></table></div></div></div>
|
|
229
|
+
|
|
230
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_text"></a>get_text</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_text : function (</td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>remove_html</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>This function returns the title of the node.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr><tr><td class=CDLEntry>remove_html</td><td class=CDLDescription><b>boolean</b> set to <u>true</u> to return plain text instead of HTML</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>string</td><td class=CDLDescription>the title of the node, specified by <u>obj</u></td></tr></table></div></div></div>
|
|
231
|
+
|
|
232
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.set_text"></a>set_text</h3><div class=CBody><p>This function sets the title of the node. This is a low-level function, you’d be better off using <rename>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> this is used as a jquery selector - can be jQuery object, DOM node, string, etc.</td></tr><tr><td class=CDLEntry>val</td><td class=CDLDescription><b>string</b> the new title of the node (can be HTMl too)</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>boolean</td><td class=CDLDescription>was the rename successfull</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.set_text" class=LFunction id=link89 onMouseOver="ShowTip(event, 'tt43', 'link89')" onMouseOut="HideTip('tt43')">set_text</a></p></div></div></div>
|
|
233
|
+
|
|
234
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.set_text"></a>set_text</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a set_text call completes.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else)</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a two keys: <u>obj</u> (the node) and <u>val</u> (the new title).</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("set_text.jstree", function (e, data) {
|
|
235
|
+
alert("Renamed to: " + data.rslt.val);
|
|
236
|
+
});</pre></blockquote></div></div></div>
|
|
237
|
+
|
|
238
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.parse_json"></a>parse_json</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>parse_json : function (</td><td class=PParameter nowrap>node</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>This function returns a jQuery node after parsing a JSON object (a LI node for single elements or an UL node for multiple). This function will use the default title from <a href="#jstree.config.core.strings" class=LVariable id=link90 onMouseOver="ShowTip(event, 'tt31', 'link90')" onMouseOut="HideTip('tt31')">jstree.config.core.strings</a> if none is specified.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>node</td><td class=CDLDescription><b>mixed</b> the input to parse</td></tr></table><blockquote><pre class="prettyprint">// can be a string
|
|
239
|
+
"The title of the parsed node"
|
|
240
|
+
// array of strings
|
|
241
|
+
[ "Node 1", "Node 2" ]
|
|
242
|
+
// an object
|
|
243
|
+
{ "title" : "The title of the parsed node" }
|
|
244
|
+
// you can manipulate the output
|
|
245
|
+
{ "title" : "The title of the parsed node", "li_attr" : { "id" : "id_for_li" }, "a_attr" : { "href" : "http://jstree.com" } }
|
|
246
|
+
// you can supply metadata, which you can later access using $(the_li_node).data()
|
|
247
|
+
{ "title" : "The title of the parsed node", "data" : { <some-values-here> } }
|
|
248
|
+
// you can supply children (they can be objects too)
|
|
249
|
+
{ "title" : "The title of the parsed node", "children" : [ "Node 1", { "title" : "Node 2" } ] }</pre></blockquote><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>jQuery</td><td class=CDLDescription>the LI (or UL) node which was produced from the JSON</td></tr></table></div></div></div>
|
|
250
|
+
|
|
251
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.get_json"></a>get_json</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_json : function (</td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>is_callback</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>This function returns the whole tree (or a single node) in JSON format. Each plugin may override this function to include its own source, but keep in mind to do it like that:</p><blockquote><pre class="prettyprint">get_json : function(obj, is_callback) {
|
|
252
|
+
var r = this.__call_old();
|
|
253
|
+
if(is_callback) {
|
|
254
|
+
if(<some-condition>) { r.data.jstree.<some-key> = <some-value-this-plugin-will-process>; }
|
|
255
|
+
}
|
|
256
|
+
return r;
|
|
257
|
+
}</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> the input to parse</td></tr><tr><td class=CDLEntry>is_callback</td><td class=CDLDescription>do not modify this, jstree uses this parameter to keep track of the recursion</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>Array</td><td class=CDLDescription>an array consisting of objects (one for each node)</td></tr></table></div></div></div>
|
|
258
|
+
|
|
259
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.create_node"></a>create_node</h3><div class=CBody><p>This function creates a new node.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>parent</td><td class=CDLDescription><b>mixed</b> the parent for the newly created node. This is used as a jquery selector, can be jQuery object, DOM node, string, etc. Use -1 to create a new root node.</td></tr><tr><td class=CDLEntry>node</td><td class=CDLDescription><b>mixed</b> the input to parse, check <a href="#jstree.parse_json" class=LFunction id=link91 onMouseOver="ShowTip(event, 'tt24', 'link91')" onMouseOut="HideTip('tt24')">parse_json</a> for description</td></tr><tr><td class=CDLEntry>position</td><td class=CDLDescription><b>mixed</b> where to create the new node. Can be one of “before”, “after”, “first”, “last”, “inside” or a numerical index.</td></tr><tr><td class=CDLEntry>callback</td><td class=CDLDescription>optional function to be executed once the node is created</td></tr><tr><td class=CDLEntry>is_loaded</td><td class=CDLDescription>used internally when a node needs to be loaded - do not pass this</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>jQuery</td><td class=CDLDescription>the LI node which was produced from the JSON (may return <u>undefined</u> if the parent node is not yet loaded, but will create the node)</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.create_node" class=LFunction id=link92 onMouseOver="ShowTip(event, 'tt44', 'link92')" onMouseOut="HideTip('tt44')">create_node</a></p></div></div></div>
|
|
260
|
+
|
|
261
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.create_node"></a>create_node</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a new node is created.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else)</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a three keys: <u>obj</u> (the node), <u>parent</u> (the parent) and <u>position</u> which is the numerical index.</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("create_node.jstree", function (e, data) {
|
|
262
|
+
alert("Created `" + data.inst.get_text(data.rslt.obj) + "` inside `" + (data.rslt.parent === -1 ? 'the main container' : data.inst.get_text(data.rslt.parent)) + "` at index " + data.rslt.position);
|
|
263
|
+
});</pre></blockquote></div></div></div>
|
|
264
|
+
|
|
265
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.rename_node"></a>rename_node</h3><div class=CBody><p>This function renames a new node.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> the node to rename. This is used as a jquery selector, can be jQuery object, DOM node, string, etc.</td></tr><tr><td class=CDLEntry>val</td><td class=CDLDescription><b>string</b> the new title</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.rename_node" class=LFunction id=link93 onMouseOver="ShowTip(event, 'tt45', 'link93')" onMouseOut="HideTip('tt45')">rename_node</a></p></div></div></div>
|
|
266
|
+
|
|
267
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.rename_node"></a>rename_node</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a node is renamed.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else)</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a three keys: <u>obj</u> (the node), <u>title</u> (the new title), <u>old</u> (the old title)</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("rename_node.jstree", function (e, data) {
|
|
268
|
+
alert("Node rename from `" + data.rslt.old + "` to `" + data.rslt.title "`");
|
|
269
|
+
});</pre></blockquote></div></div></div>
|
|
270
|
+
|
|
271
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.delete_node"></a>delete_node</h3><div class=CBody><p>This function deletes a node.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> the node to remove. This is used as a jquery selector, can be jQuery object, DOM node, string, etc.</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>mixed</td><td class=CDLDescription>the removed node on success, <u>false</u> on failure</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.delete_node" class=LFunction id=link94 onMouseOver="ShowTip(event, 'tt46', 'link94')" onMouseOut="HideTip('tt46')">delete_node</a></p></div></div></div>
|
|
272
|
+
|
|
273
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.delete_node"></a>delete_node</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a node is deleted.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else)</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a three keys: <u>obj</u> (the removed node), <u>prev</u> (the previous sibling of the removed node), <u>parent</u> (the parent of the removed node)</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("delete_node.jstree", function (e, data) {
|
|
274
|
+
alert("Node deleted!");
|
|
275
|
+
});</pre></blockquote></div></div></div>
|
|
276
|
+
|
|
277
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.check"></a>check</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>check : function (</td><td class=PParameter nowrap>chk,</td></tr><tr><td></td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>par,</td></tr><tr><td></td><td class=PParameter nowrap>pos</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>This function checks if a structure modification is valid.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>chk</td><td class=CDLDescription><b>string</b> what are we checking (copy_node, move_node, rename_node, create_node, delete_node)</td></tr><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> the node.</td></tr><tr><td class=CDLEntry>par</td><td class=CDLDescription><b>mixed</b> the parent (if dealing with a move or copy - the new parent).</td></tr><tr><td class=CDLEntry>pos</td><td class=CDLDescription><b>mixed</b> the index among the parent’s children (or the new name if dealing with a rename)</td></tr><tr><td class=CDLEntry>is_copy</td><td class=CDLDescription><b>boolean</b> is this a copy or a move call</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>boolean</td><td class=CDLDescription><u>true</u> if the move is valid, <u>false</u> otherwise</td></tr></table></div></div></div>
|
|
278
|
+
|
|
279
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.move_node"></a>move_node</h3><div class=CBody><p>This function moves a node.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> the node to move. This is used as a jquery selector, can be jQuery object, DOM node, string, etc.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription><b>mixed</b> the new parent. This is used as a jquery selector, can be jQuery object, DOM node, string, etc. Use -1 to promote to a root node.</td></tr><tr><td class=CDLEntry>position</td><td class=CDLDescription><b>mixed</b> where to create the new node. Can be one of “before”, “after”, “first”, “last”, “inside” or a numerical index.</td></tr><tr><td class=CDLEntry>callback</td><td class=CDLDescription>optional function to be executed once the node is moved</td></tr><tr><td class=CDLEntry>is_loaded</td><td class=CDLDescription>used internally when a node needs to be loaded - do not pass this</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>boolean</td><td class=CDLDescription>indicating if the move was successfull (may return <u>undefined</u> if the parent node is not yet loaded, but will move the node)</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.move_node" class=LFunction id=link95 onMouseOver="ShowTip(event, 'tt47', 'link95')" onMouseOut="HideTip('tt47')">move_node</a></p></div></div></div>
|
|
280
|
+
|
|
281
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.move_node"></a>move_node</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a node is moved.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else)</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a five keys: <u>obj</u> (the node), <u>parent</u> (the new parent) and <u>position</u> which is the numerical index, <u>old parent</u> (the old parent) and is_multi (a boolean indicating if the node is coming from another tree instance)</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("move_node.jstree", function (e, data) {
|
|
282
|
+
alert("Moved `" + data.inst.get_text(data.rslt.obj) + "` inside `" + (data.rslt.parent === -1 ? 'the main container' : data.inst.get_text(data.rslt.parent)) + "` at index " + data.rslt.position);
|
|
283
|
+
});</pre></blockquote></div></div></div>
|
|
284
|
+
|
|
285
|
+
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="jstree.copy_node"></a>copy_node</h3><div class=CBody><p>This function copies a node.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>obj</td><td class=CDLDescription><b>mixed</b> the node to copy. This is used as a jquery selector, can be jQuery object, DOM node, string, etc.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription><b>mixed</b> the new parent. This is used as a jquery selector, can be jQuery object, DOM node, string, etc. Use -1 to promote to a root node.</td></tr><tr><td class=CDLEntry>position</td><td class=CDLDescription><b>mixed</b> where to create the new node. Can be one of “before”, “after”, “first”, “last”, “inside” or a numerical index.</td></tr><tr><td class=CDLEntry>callback</td><td class=CDLDescription>optional function to be executed once the node is moved</td></tr><tr><td class=CDLEntry>is_loaded</td><td class=CDLDescription>used internally when a node needs to be loaded - do not pass this</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>boolean</td><td class=CDLDescription>indicating if the move was successfull (may return <u>undefined</u> if the parent node is not yet loaded, but will move the node)</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#jstree.copy_node" class=LFunction id=link96 onMouseOver="ShowTip(event, 'tt48', 'link96')" onMouseOut="HideTip('tt48')">copy_node</a></p></div></div></div>
|
|
286
|
+
|
|
287
|
+
<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="jstree.copy_node"></a>copy_node</h3><div class=CBody><p>This event is triggered in the <b>jstree</b> namespace when a node is copied.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.inst</td><td class=CDLDescription>the instance</td></tr><tr><td class=CDLEntry>data.args</td><td class=CDLDescription><b>array</b> the arguments passed to the function</td></tr><tr><td class=CDLEntry>data.plugin</td><td class=CDLDescription><b>string</b> the function’s plugin (here it will be <u>”core”</u> but if the function is extended it may be something else)</td></tr><tr><td class=CDLEntry>data.rslt</td><td class=CDLDescription><b>object</b> which contains a five keys: <u>obj</u> (the node), <u>parent</u> (the new parent) and <u>position</u> which is the numerical index, <u>original</u> (the original object) and is_multi (a boolean indicating if the node is coming from another tree instance)</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$("div").bind("copy_node.jstree", function (e, data) {
|
|
288
|
+
alert("Copied `" + data.inst.get_text(data.rslt.original) + "` inside `" + (data.rslt.parent === -1 ? 'the main container' : data.inst.get_text(data.rslt.parent)) + "` at index " + data.rslt.position);
|
|
289
|
+
});</pre></blockquote></div></div></div>
|
|
290
|
+
|
|
291
|
+
</div><!--Content-->
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<div id=Footer>Copyright © 2010 Ivan Bozhanov · Updated December 19th, 2011 · <a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
<div id=Menu><div class=MTitle>jstree<div class=MSubTitle>jquery treeview plugin</div></div><div class=MEntry><div class=MFile><a href="_license-txt.html">LICENSE</a></div></div><div class=MEntry><div class=MFile><a href="_usage-txt.html">USAGE</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Core</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile id=MSelected>jstree.<wbr>core.js</div></div><div class=MEntry><div class=MFile><a href="vakata-js.html">Helper functions</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Plugins</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="jstree-html-js.html">jstree.<wbr>html.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-json-js.html">jstree.<wbr>json.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-themes-js.html">jstree.<wbr>themes.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-ui-js.html">jstree.<wbr>ui.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-state-js.html">jstree.<wbr>state.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-contextmenu-js.html">jstree.<wbr>contextmenu.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-hotkeys-js.html">jstree.<wbr>hotkeys.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-sort-js.html">jstree.<wbr>sort.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-dnd-js.html">jstree.<wbr>dnd.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-unique-js.html">jstree.<wbr>unique.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-checkbox-js.html">jstree.<wbr>checkbox.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-xml-js.html">jstree.<wbr>xml.js</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Index</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Events.html">Events</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div></div></div></div><script type="text/javascript"><!--
|
|
298
|
+
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
|
|
299
|
+
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div></div><!--Menu-->
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<!--START_ND_TOOLTIPS-->
|
|
304
|
+
<div class=CToolTip id="tt1"><div class=CGroup>The actual plugin wrapper, use this to create instances or execute functions on created instances.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.jstree</td></tr></table></blockquote><b>object</b> Contains all static functions and variables used by jstree, some plugins also append variables.</div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.jstree.SCROLLBAR_WIDTH</td></tr></table></blockquote><b>integer</b> indicating the width of the client scrollbar</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>_get_string : function (</td><td class=PParameter nowrap>s</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Used to get the common string in the tree.</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>is_locked : function ()</td></tr></table></blockquote>Used to get the locked status of the tree.</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_node : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get a hold of the LI node (which represents the jstree node).</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_next : function (</td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>strict</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get the next sibling of a node</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_prev : function (</td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>strict</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get the previous sibling of a node</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_parent : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get the parent of a node</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_children : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Get all the children of a node</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_parent : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Check if a node is a parent.</div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_loaded : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Check if a node is loaded.</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_loading : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Check if a node is currently loading.</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_open : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Check if a node is currently open.</div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_closed : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Check if a node is currently closed.</div></div><div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>is_leaf : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Check if a node is a leaf node (has no children).</div></div><div class=CToolTip id="tt17"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>_load_node : function (</td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>callback</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Load the children of a node, but as opposed to load_node does not change any visual properties or trigger events. </div></div><div class=CToolTip id="tt18"><div class=CFunction>Load the children of a node.</div></div><div class=CToolTip id="tt19"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>toggle_node : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>clean_node : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>This function converts inserted nodes to the required by jsTree format. </div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>scroll_to_node : function (</td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>This function scrolls the container to the desired node (if needed).</div></div><div class=CToolTip id="tt22"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>get_state : function ()</td></tr></table></blockquote>This function returns the current state of the tree (as collected from all active plugins). </div></div><div class=CToolTip id="tt23"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_text : function (</td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>remove_html</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>This function returns the title of the node.</div></div><div class=CToolTip id="tt24"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>parse_json : function (</td><td class=PParameter nowrap>node</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>This function returns a jQuery node after parsing a JSON object (a LI node for single elements or an UL node for multiple). </div></div><div class=CToolTip id="tt25"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>get_json : function (</td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>is_callback</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>This function returns the whole tree (or a single node) in JSON format. </div></div><div class=CToolTip id="tt26"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>check : function (</td><td class=PParameter nowrap>chk,</td></tr><tr><td></td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>par,</td></tr><tr><td></td><td class=PParameter nowrap>pos</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>This function checks if a structure modification is valid.</div></div><div class=CToolTip id="tt27"><div class=CFunction>Returns an instance</div></div><div class=CToolTip id="tt28"><div class=CFunction>Creates a new jstree instance, any arguments after the first one are merged and used to configure the tree.</div></div><div class=CToolTip id="tt29"><div class=CFunction>Call a function on the instance and return the result</div></div><div class=CToolTip id="tt30"><div class=CFunction>Destroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace</div></div><div class=CToolTip id="tt31"><div class=CVariable><b>mixed</b> used to store all localization strings. </div></div><div class=CToolTip id="tt32"><div class=CEvent>This event is triggered in the <b>jstree</b> namespace when data is first rendered in the tree. </div></div><div class=CToolTip id="tt33"><div class=CFunction>Used to unlock the tree. </div></div><div class=CToolTip id="tt34"><div class=CFunction>Used to lock the tree. </div></div><div class=CToolTip id="tt35"><div class=CFunction>Open a node so that its children are visible. </div></div><div class=CToolTip id="tt36"><div class=CEvent>This event is triggered in the <b>jstree</b> namespace when a node is successfully opened AFTER the animation completes). </div></div><div class=CToolTip id="tt37"><div class=CFunction>Close a node so that its children are not visible.</div></div><div class=CToolTip id="tt38"><div class=CEvent>This event is triggered in the <b>jstree</b> namespace when a node is closed AFTER the animation completes). </div></div><div class=CToolTip id="tt39"><div class=CFunction>Open all nodes from a certain node down.</div></div><div class=CToolTip id="tt40"><div class=CFunction>Close all nodes from a certain node down.</div></div><div class=CToolTip id="tt41"><div class=CFunction>This function returns sets the state of the tree. </div></div><div class=CToolTip id="tt42"><div class=CFunction>This function saves the current state, reloads the complete tree and returns it to the saved state.</div></div><div class=CToolTip id="tt43"><div class=CFunction>This function sets the title of the node. </div></div><div class=CToolTip id="tt44"><div class=CFunction>This function creates a new node.</div></div><div class=CToolTip id="tt45"><div class=CFunction>This function renames a new node.</div></div><div class=CToolTip id="tt46"><div class=CFunction>This function deletes a node.</div></div><div class=CToolTip id="tt47"><div class=CFunction>This function moves a node.</div></div><div class=CToolTip id="tt48"><div class=CFunction>This function copies a node.</div></div><!--END_ND_TOOLTIPS-->
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<script language=JavaScript><!--
|
|
313
|
+
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
|