diff --git a/README.txt b/README.txt index 17b93255..5070d25e 100644 --- a/README.txt +++ b/README.txt @@ -5,4 +5,12 @@ Copyright (c) 2011 Ivan Bozhanov (vakata.com) Dual licensed under the MIT and GPL licenses: http://www.opensource.org/licenses/mit-license.php - http://www.gnu.org/licenses/gpl.html \ No newline at end of file + http://www.gnu.org/licenses/gpl.html + +A list of useful pages: + http://www.jstree.com/demo + http://www.jstree.com/documentation + https://groups.google.com/forum/#!forum/jstree + +You can support the project on PayPal: + http://bit.ly/jNIuWd \ No newline at end of file diff --git a/_docs/files/_license-txt.html b/_docs/files/_license-txt.html index eff53412..d77caeb3 100644 --- a/_docs/files/_license-txt.html +++ b/_docs/files/_license-txt.html @@ -11,15 +11,15 @@ -

License

jstree is licensed same as jQuery.

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 jstree.

If the GPL suits your project better you are also free to use jstree under that license.

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 jstree in commercial projects as long as the copyright header is left intact.

Licenses

+

License

jstree is licensed same as jQuery.

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 jstree.

If the GPL suits your project better you are also free to use jstree under that license.

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 jstree in commercial projects as long as the copyright header is left intact.

Licenses

# Copyright © 2010 Ivan Bozhanov (http://vakata.com)

- + - diff --git a/_docs/files/_usage-txt.html b/_docs/files/_usage-txt.html index b6259c3b..296e21fa 100644 --- a/_docs/files/_usage-txt.html +++ b/_docs/files/_usage-txt.html @@ -11,7 +11,7 @@ -

Usage

Introduction

Features at a glance

  • Various data sources - HTML, JSON, XML
  • Supports AJAX loading
  • Drag & drop support
  • Highly configurable
  • Theme support + included themes
  • Uses jQuery’s event system
  • Optional keyboard navigation
  • Maintain the same tree in many languages
  • Inline editing
  • Open/close optional animation
  • Define node types and fine tune them
  • Configurable multitree drag & drop
  • Optional checkbox tree support
  • Search function
  • Supports plugins
  • Optional state saving using cookies
  • RTL support
  • Optional sorting / unique management

Including the files

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 :

<script type="text/javascript" src="_lib/jquery.js"></script>

Then you need to include jstree itself :

<script type="text/javascript" src="jquery.jstree.js"></script>

You may change the path to whatever you like, but it is recommended not to rename jquery.tree.js (or jquery.tree.min.js) as the filename may be used for path autodetection (for example in the jstree.themes.js plugin, however all official plugins will provide an alternative way of specifying any needed path manually).

Additionally some plugins have dependencies.  If a plugin detects that a dependency is missing, it will throw an error.

Creating and configuring an instance

You can create a tree in the following manner ($().jstree) :

jQuery("some-selector-to-container-node-here").jstree([ config_object ]);

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 core key of the config object.

jQuery("some-selector-to-container-node-here")
+

Usage

Introduction

Features at a glance

  • Various data sources - HTML, JSON, XML
  • Supports AJAX loading
  • Drag & drop support
  • Highly configurable
  • Theme support + included themes
  • Uses jQuery’s event system
  • Optional keyboard navigation
  • Inline editing
  • Open/close optional animation
  • Define node types and fine tune them
  • Configurable multitree drag & drop
  • Optional checkbox tree support
  • Search function
  • Supports plugins
  • Optional state saving using cookies
  • RTL support
  • Optional sorting / unique management

Including the files

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

<script type="text/javascript" src="_lib/jquery.js"></script>

Then you need to include jstree itself

<script type="text/javascript" src="jquery.jstree.js"></script>

You may change the path to whatever you like, but it is recommended not to rename jquery.tree.js (or jquery.tree.min.js) as the filename may be used for path autodetection (for example in the jstree.themes.js plugin, however all official plugins will provide an alternative way of specifying any needed path manually).

Additionally some plugins have dependencies.  If a plugin detects that a dependency is missing, it will throw an error.

Creating and configuring an instance

You can create a tree in the following manner ($().jstree) :

jQuery("some-selector-to-container-node-here").jstree([ config_object ]);

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 core key of the config object.

jQuery("some-selector-to-container-node-here")
    .jstree({
        core : {
            /* core options go here */
@@ -26,19 +26,19 @@
 
 /* METHOD TWO */
 jQuery.jstree._reference(needle)
-   .operation_name([ argument_1, argument_2, ...]);

jsTree uses events to notify of any changes happening in the tree.  All events fire on the tree container in the jstree namespace and are named after the function that triggered them.  Personally I believe it is best to bind to the events and then create the instance.

jQuery("some-container")
+   .operation_name([ argument_1, argument_2, ...]);

Events

jsTree uses events to notify of any changes happening in the tree.  All events fire on the tree container in the jstree namespace and are named after the function that triggered them.  Personally I believe it is best to bind to the events and then create the instance.

jQuery("some-container")
    .bind("loaded.jstree", function (event, data) {
        alert("TREE IS LOADED");
    })
-   .jstree({ /* configuration here */ });

Please note the second parameter data.  Read the documentation on each event to see what it contains.

+ .jstree({ /* configuration here */ });

Please note the second parameter data.  Read the documentation on each event to see what it contains.

TODO;

- + - diff --git a/_docs/files/jstree-core-js.html b/_docs/files/jstree-core-js.html index 41e015a1..ca66074d 100644 --- a/_docs/files/jstree-core-js.html +++ b/_docs/files/jstree-core-js.html @@ -11,12 +11,14 @@ -

jstree.core.js

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.

Summary
jstree.core.jsThe 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.
$.jstree.Some static functions and variables, unless you know exactly what you are doing do not use these, but $().jstree instead.
$.jstreeobject Contains all static functions and variables used by jstree, some plugins also append variables.
$.jstree.IS_IE6boolean indicating if the client is running Internet Explorer 6
$.jstree.IS_IE7boolean indicating if the client is running Internet Explorer 7
$.jstree.IS_FF2boolean indicating if the client is running Firefox 2
$.jstree.__constructCreates a new jstree instance, any arguments after the first one are merged and used to configure the tree.
$.jstree.
$.jstree.__destructDestroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace
$.jstree.__callCall a function on the instance and return the result
$.jstree._referenceReturns an instance
$.jstree._focusedReturns the currently focused instance (by default once an instance is created it is focused)
$.jstree._focusMake an instance focused (which defocuses the previously focused instance)
$.jstree.pluginRegister a plugin
$.jstree.defaultsobject storing all the default configuration options for every plugin and the core.
$().jstree()The actual plugin wrapper, use this to create instances or execute functions on created instances.
$().jstreeCreates an instance using the specified objects for containers, or executes a command on an instance, specified by a container.
$.jstree.
$.jstree.SCROLLBAR_WIDTHinteger indicating the width of the client scrollbar
jstree
dataobject Provides storage for plugins (aside from private variables).
get_indexReturns an integer, which is the instance’s index.
get_containerReturns the jQuery extended container of the tree (the element you used when constructing the tree).
get_container_ulReturns the jQuery extended first UL node inside the container of the tree.
get_settingsReturns the settings for the tree.
__triggerUsed internally to trigger events on the container node.
CORE options
config.core.stringsmixed used to store all localization strings.
CORE functions
_get_stringUsed to get the common string in the tree.
initUsed internally.
__loadedThis event is triggered in the jstree namespace when data is first rendered in the tree.
lockUsed to lock the tree.
lockThis event is triggered in the jstree namespace when the tree is locked.
unlockUsed to unlock the tree.
unlockThis event is triggered in the jstree namespace when the tree is unlocked.
is_lockedUsed to get the locked status of the tree.
get_nodeGet a hold of the LI node (which represents the jstree node).
get_nextGet the next sibling of a node
get_prevGet the previous sibling of a node
get_parentGet the parent of a node
get_childrenGet all the children of a node
is_parentCheck if a node is a parent.
is_loadedCheck if a node is loaded.
is_loadingCheck if a node is currently loading.
is_openCheck if a node is currently open.
is_closedCheck if a node is currently closed.
is_leafCheck if a node is a leaf node (has no children).
load_nodeLoad the children of a node.
load_nodeThis event is triggered in the jstree namespace when a node is loaded (succesfully or not).
_load_nodeLoad the children of a node, but as opposed to load_node does not change any visual properties or trigger events.
open_nodeOpen a node so that its children are visible.
open_nodeThis event is triggered in the jstree namespace when a node is successfully opened (but if animation is used this event is triggered BEFORE the animation completes).
__after_openThis event is triggered in the jstree namespace when a node is successfully opened AFTER the animation completes).
close_nodeClose a node so that its children are not visible.
close_nodeThis event is triggered in the jstree namespace when a node is closed (but if animation is used this event is triggered BEFORE the animation completes).
__after_closeThis event is triggered in the jstree namespace when a node is closed AFTER the animation completes).
toggle_node
open_allOpen all nodes from a certain node down.
open_allThis event is triggered in the jstree namespace when an open_all call completes.
close_allClose all nodes from a certain node down.
close_allThis event is triggered in the jstree namespace when a close_all call completes.
clean_nodeThis function converts inserted nodes to the required by jsTree format.
correct_nodeThis function corrects the open/closed/leaf state as data changes (as the user interacts with the tree).
+

jstree.core.js

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.

Summary
jstree.core.jsThe 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.
$.jstree.Some static functions and variables, unless you know exactly what you are doing do not use these, but $().jstree instead.
$.jstreeobject Contains all static functions and variables used by jstree, some plugins also append variables.
$.jstree.VERSIONstring the version of jstree
$.jstree.IS_IE6boolean indicating if the client is running Internet Explorer 6
$.jstree.IS_IE7boolean indicating if the client is running Internet Explorer 7
$.jstree.IS_FF2boolean indicating if the client is running Firefox 2
$.jstree.__constructCreates a new jstree instance, any arguments after the first one are merged and used to configure the tree.
$.jstree.
$.jstree.__destructDestroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace
$.jstree.__callCall a function on the instance and return the result
$.jstree._referenceReturns an instance
$.jstree._focusedReturns the currently focused instance (by default once an instance is created it is focused)
$.jstree._focusMake an instance focused (which defocuses the previously focused instance)
$.jstree.pluginRegister a plugin
$.jstree.defaultsobject storing all the default configuration options for every plugin and the core.
$().jstree()The actual plugin wrapper, use this to create instances or execute functions on created instances.
$().jstreeCreates an instance using the specified objects for containers, or executes a command on an instance, specified by a container.
$.jstree.
$.jstree.SCROLLBAR_WIDTHinteger indicating the width of the client scrollbar
jstree
dataobject Provides storage for plugins (aside from private variables).
get_indexReturns an integer, which is the instance’s index.
get_containerReturns the jQuery extended container of the tree (the element you used when constructing the tree).
get_container_ulReturns the jQuery extended first UL node inside the container of the tree.
get_settingsReturns the settings for the tree.
__triggerUsed internally to trigger events on the container node.
CORE options
config.core.stringsmixed used to store all localization strings.
CORE functions
_get_stringUsed to get the common string in the tree.
initUsed internally.
__loadedThis event is triggered in the jstree namespace when data is first rendered in the tree.
lockUsed to lock the tree.
lockThis event is triggered in the jstree namespace when the tree is locked.
unlockUsed to unlock the tree.
unlockThis event is triggered in the jstree namespace when the tree is unlocked.
is_lockedUsed to get the locked status of the tree.
get_nodeGet a hold of the LI node (which represents the jstree node).
get_nextGet the next sibling of a node
get_prevGet the previous sibling of a node
get_parentGet the parent of a node
get_childrenGet all the children of a node
is_parentCheck if a node is a parent.
is_loadedCheck if a node is loaded.
is_loadingCheck if a node is currently loading.
is_openCheck if a node is currently open.
is_closedCheck if a node is currently closed.
is_leafCheck if a node is a leaf node (has no children).
load_nodeLoad the children of a node.
load_nodeThis event is triggered in the jstree namespace when a node is loaded (succesfully or not).
_load_nodeLoad the children of a node, but as opposed to load_node does not change any visual properties or trigger events.
open_nodeOpen a node so that its children are visible.
open_nodeThis event is triggered in the jstree namespace when a node is successfully opened (but if animation is used this event is triggered BEFORE the animation completes).
__after_openThis event is triggered in the jstree namespace when a node is successfully opened AFTER the animation completes).
close_nodeClose a node so that its children are not visible.
close_nodeThis event is triggered in the jstree namespace when a node is closed (but if animation is used this event is triggered BEFORE the animation completes).
__after_closeThis event is triggered in the jstree namespace when a node is closed AFTER the animation completes).
toggle_node
open_allOpen all nodes from a certain node down.
open_allThis event is triggered in the jstree namespace when an open_all call completes.
close_allClose all nodes from a certain node down.
close_allThis event is triggered in the jstree namespace when a close_all call completes.
clean_nodeThis function converts inserted nodes to the required by jsTree format.
correct_nodeThis function corrects the open/closed/leaf state as data changes (as the user interacts with the tree).
scroll_to_nodeThis function scrolls the container to the desired node (if needed).
get_stateThis function returns the current state of the tree (as collected from all active plugins).
set_stateThis function returns sets the state of the tree.
set_stateThis event is triggered in the jstree namespace when a set_state call completes.
refreshThis function saves the current state, reloads the complete tree and returns it to the saved state.
refreshThis event is triggered in the jstree namespace when a refresh call completes.
get_textThis function returns the title of the node.
set_textThis function sets the title of the node.
set_textThis event is triggered in the jstree namespace when a set_text call completes.
parse_jsonThis function returns a jQuery node after parsing a JSON object (a LI node for single elements or an UL node for multiple).
-

$.jstree.

Some static functions and variables, unless you know exactly what you are doing do not use these, but $().jstree instead.

+

$.jstree.

Some static functions and variables, unless you know exactly what you are doing do not use these, but $().jstree instead.

$.jstree

$.jstree

object Contains all static functions and variables used by jstree, some plugins also append variables.

+

$.jstree.VERSION

string the version of jstree

+

$.jstree.IS_IE6

boolean indicating if the client is running Internet Explorer 6

$.jstree.IS_IE7

boolean indicating if the client is running Internet Explorer 7

@@ -27,15 +29,15 @@

$.jstree.

-

$.jstree.__destruct

Destroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace

Parameters

instancemixed the instance to destroy (this argument is passed to $.jstree._reference to get the instance)

See also

$.jstree._reference

+

$.jstree.__destruct

Destroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace

Parameters

instancemixed the instance to destroy (this argument is passed to $.jstree._reference to get the instance)

See also

$.jstree._reference

-

$.jstree.__call

Call a function on the instance and return the result

Parameters

instancemixed the instance to destroy (this argument is passed to $.jstree._reference to get the instance)
operationstring the operation to execute
argsarray the arguments to pass to the function

See also

$.jstree._reference

+

$.jstree.__call

Call a function on the instance and return the result

Parameters

instancemixed the instance to destroy (this argument is passed to $.jstree._reference to get the instance)
operationstring the operation to execute
argsarray the arguments to pass to the function

See also

$.jstree._reference

$.jstree._reference

Returns an instance

Parameters

needlemixed - integer, DOM node contained inside a jstree container, ID string, jQuery object, selector

$.jstree._focused

Returns the currently focused instance (by default once an instance is created it is focused)

-

$.jstree._focus

Make an instance focused (which defocuses the previously focused instance)

Parameters

instancemixed the instance to focus (this argument is passed to $.jstree._reference to get the instance)

See also

$.jstree._reference

+

$.jstree._focus

Make an instance focused (which defocuses the previously focused instance)

Parameters

instancemixed the instance to focus (this argument is passed to $.jstree._reference to get the instance)

See also

$.jstree._reference

$.jstree.plugin

Register a plugin

Parameters

plugin_namestring the name of the new plugin (it will be used as a key in an object - make sure it is valid)
plugin_dataobject consists of 4 keys.  Default is:
{
    __construct : $.noop,   // this function will be executed when a new instance is created
@@ -54,19 +56,19 @@
 
 

$().jstree()

The actual plugin wrapper, use this to create instances or execute functions on created instances.

-

$().jstree

$.fn.jstree = function (settings)

Creates an instance using the specified objects for containers, or executes a command on an instance, specified by a container.

Parameters

settingsmixed
  • if you pass an object a new instance will be created (using $.jstree.__construct) for each of the objects in the jquery collection, if an instance already exists on the container it will be destroyed first
  • if you pass a string it will be executed using $.jstree.__call on each instance

Examples

// this creates an instance
+

$().jstree

$.fn.jstree = function (settings)

Creates an instance using the specified objects for containers, or executes a command on an instance, specified by a container.

Parameters

settingsmixed
  • if you pass an object a new instance will be created (using $.jstree.__construct) for each of the objects in the jquery collection, if an instance already exists on the container it will be destroyed first
  • if you pass a string it will be executed using $.jstree.__call on each instance

Examples

// this creates an instance
 $("#some-id").jstree({
   plugins : [ "html_data", "themes", "ui" ]
 });
 
 // this executes a function on the instance
-$("#some-id").jstree("select_node", "#the-id-to-select");

See also

$.jstree.__construct, $.jstree.__destruct, $.jstree.__call

+$("#some-id").jstree("select_node", "#the-id-to-select");

See also

$.jstree.__construct, $.jstree.__destruct, $.jstree.__call

$.jstree.

$.jstree.SCROLLBAR_WIDTH

$.jstree.SCROLLBAR_WIDTH

integer indicating the width of the client scrollbar

-

jstree

Summary
dataobject Provides storage for plugins (aside from private variables).
get_indexReturns an integer, which is the instance’s index.
get_containerReturns the jQuery extended container of the tree (the element you used when constructing the tree).
get_container_ulReturns the jQuery extended first UL node inside the container of the tree.
get_settingsReturns the settings for the tree.
__triggerUsed internally to trigger events on the container node.
CORE options
config.core.stringsmixed used to store all localization strings.
CORE functions
_get_stringUsed to get the common string in the tree.
initUsed internally.
__loadedThis event is triggered in the jstree namespace when data is first rendered in the tree.
lockUsed to lock the tree.
lockThis event is triggered in the jstree namespace when the tree is locked.
unlockUsed to unlock the tree.
unlockThis event is triggered in the jstree namespace when the tree is unlocked.
is_lockedUsed to get the locked status of the tree.
get_nodeGet a hold of the LI node (which represents the jstree node).
get_nextGet the next sibling of a node
get_prevGet the previous sibling of a node
get_parentGet the parent of a node
get_childrenGet all the children of a node
is_parentCheck if a node is a parent.
is_loadedCheck if a node is loaded.
is_loadingCheck if a node is currently loading.
is_openCheck if a node is currently open.
is_closedCheck if a node is currently closed.
is_leafCheck if a node is a leaf node (has no children).
load_nodeLoad the children of a node.
load_nodeThis event is triggered in the jstree namespace when a node is loaded (succesfully or not).
_load_nodeLoad the children of a node, but as opposed to load_node does not change any visual properties or trigger events.
open_nodeOpen a node so that its children are visible.
open_nodeThis event is triggered in the jstree namespace when a node is successfully opened (but if animation is used this event is triggered BEFORE the animation completes).
__after_openThis event is triggered in the jstree namespace when a node is successfully opened AFTER the animation completes).
close_nodeClose a node so that its children are not visible.
close_nodeThis event is triggered in the jstree namespace when a node is closed (but if animation is used this event is triggered BEFORE the animation completes).
__after_closeThis event is triggered in the jstree namespace when a node is closed AFTER the animation completes).
toggle_node
open_allOpen all nodes from a certain node down.
open_allThis event is triggered in the jstree namespace when an open_all call completes.
close_allClose all nodes from a certain node down.
close_allThis event is triggered in the jstree namespace when a close_all call completes.
clean_nodeThis function converts inserted nodes to the required by jsTree format.
correct_nodeThis function corrects the open/closed/leaf state as data changes (as the user interacts with the tree).
+

jstree

Summary
dataobject Provides storage for plugins (aside from private variables).
get_indexReturns an integer, which is the instance’s index.
get_containerReturns the jQuery extended container of the tree (the element you used when constructing the tree).
get_container_ulReturns the jQuery extended first UL node inside the container of the tree.
get_settingsReturns the settings for the tree.
__triggerUsed internally to trigger events on the container node.
CORE options
config.core.stringsmixed used to store all localization strings.
CORE functions
_get_stringUsed to get the common string in the tree.
initUsed internally.
__loadedThis event is triggered in the jstree namespace when data is first rendered in the tree.
lockUsed to lock the tree.
lockThis event is triggered in the jstree namespace when the tree is locked.
unlockUsed to unlock the tree.
unlockThis event is triggered in the jstree namespace when the tree is unlocked.
is_lockedUsed to get the locked status of the tree.
get_nodeGet a hold of the LI node (which represents the jstree node).
get_nextGet the next sibling of a node
get_prevGet the previous sibling of a node
get_parentGet the parent of a node
get_childrenGet all the children of a node
is_parentCheck if a node is a parent.
is_loadedCheck if a node is loaded.
is_loadingCheck if a node is currently loading.
is_openCheck if a node is currently open.
is_closedCheck if a node is currently closed.
is_leafCheck if a node is a leaf node (has no children).
load_nodeLoad the children of a node.
load_nodeThis event is triggered in the jstree namespace when a node is loaded (succesfully or not).
_load_nodeLoad the children of a node, but as opposed to load_node does not change any visual properties or trigger events.
open_nodeOpen a node so that its children are visible.
open_nodeThis event is triggered in the jstree namespace when a node is successfully opened (but if animation is used this event is triggered BEFORE the animation completes).
__after_openThis event is triggered in the jstree namespace when a node is successfully opened AFTER the animation completes).
close_nodeClose a node so that its children are not visible.
close_nodeThis event is triggered in the jstree namespace when a node is closed (but if animation is used this event is triggered BEFORE the animation completes).
__after_closeThis event is triggered in the jstree namespace when a node is closed AFTER the animation completes).
toggle_node
open_allOpen all nodes from a certain node down.
open_allThis event is triggered in the jstree namespace when an open_all call completes.
close_allClose all nodes from a certain node down.
close_allThis event is triggered in the jstree namespace when a close_all call completes.
clean_nodeThis function converts inserted nodes to the required by jsTree format.
correct_nodeThis function corrects the open/closed/leaf state as data changes (as the user interacts with the tree).
scroll_to_nodeThis function scrolls the container to the desired node (if needed).
get_stateThis function returns the current state of the tree (as collected from all active plugins).
set_stateThis function returns sets the state of the tree.
set_stateThis event is triggered in the jstree namespace when a set_state call completes.
refreshThis function saves the current state, reloads the complete tree and returns it to the saved state.
refreshThis event is triggered in the jstree namespace when a refresh call completes.
get_textThis function returns the title of the node.
set_textThis function sets the title of the node.
set_textThis event is triggered in the jstree namespace when a set_text call completes.
parse_jsonThis function returns a jQuery node after parsing a JSON object (a LI node for single elements or an UL node for multiple).

data

object Provides storage for plugins (aside from private variables).  Every plugin has an key in this object.

this.data.<plugin_name>;

This is useful for detecting if some plugin is included in the instance (plugins also use this for dependencies and enhancements).

@@ -97,21 +99,21 @@ "Loading ..." : "Please wait ..." } } -});

See also

_get_string

+});

See also

_get_string

CORE functions

-

_get_string

_get_string : function (s)

Used to get the common string in the tree.

If config.core.strings is set to a function, that function is called with a single parameter (the needed string), the response is returned.

If config.core.strings is set to an object, the key named as the needed string is returned.

If config.core.strings is not set, the the needed string is returned.

Parameters

needed_stringstring the needed string
+

_get_string

_get_string : function (s)

Used to get the common string in the tree.

If config.core.strings is set to a function, that function is called with a single parameter (the needed string), the response is returned.

If config.core.strings is set to an object, the key named as the needed string is returned.

If config.core.strings is not set, the the needed string is returned.

Parameters

needed_stringstring the needed string
-

init

Used internally.  This function is called once the core plugin is constructed.

Triggers

__loaded

+

init

Used internally.  This function is called once the core plugin is constructed.

Triggers

__loaded

__loaded

This event is triggered in the jstree namespace when data is first rendered in the tree.  It won’t be triggered after a refresh.  Fires only once.

Parameters

data.instthe instance

Example

$("div").bind("__loaded.jstree", function (e, data) { data.inst.do_something(); });
-

lock

Used to lock the tree.  When the tree is in a locked state, no functions can be called on the instance (except is_locked and unlock).  Additionally a jstree-locked class is applied on the container.

Triggers

lock

+

lock

Used to lock the tree.  When the tree is in a locked state, no functions can be called on the instance (except is_locked and unlock).  Additionally a jstree-locked class is applied on the container.

Triggers

lock

lock

This event is triggered in the jstree namespace when the tree is locked.

Parameters

data.instthe instance
data.argsarray the arguments passed to the function
data.pluginstring the function’s plugin (here it will be ”core” but if the function is extended it may be something else).
data.rsltnull

Example

$("div").bind("lock.jstree", function (e, data) { data.inst.do_something(); });
-

unlock

Used to unlock the tree.  Instance can be used normally again.  The jstree-locked class is removed from the container.

Triggers

unlock

+

unlock

Used to unlock the tree.  Instance can be used normally again.  The jstree-locked class is removed from the container.

Triggers

unlock

unlock

This event is triggered in the jstree namespace when the tree is unlocked.

Parameters

data.instthe instance
data.argsarray the arguments passed to the function
data.pluginstring the function’s plugin (here it will be ”core” but if the function is extended it may be something else).
data.rsltnull

Example

$("div").bind("unlock.jstree", function (e, data) { data.inst.do_something(); });
@@ -139,51 +141,51 @@

is_leaf

is_leaf : function (obj)

Check if a node is a leaf node (has no children).

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.

Returns

trueobj is a leaf node
falseobj is not a leaf node
-

load_node

Load the children of a node.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.  Use -1 to load the root nodes.
callbacka function to be executed in the tree’s scope.  Receives two arguments: obj (the same node used to call load_node), status (a boolean indicating if the node was loaded successfully.

Returns

trueobj is a valid node and will try loading it
falseobj is not a valid node

Triggers

load_node

See also

_load_node

+

load_node

Load the children of a node.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.  Use -1 to load the root nodes.
callbacka function to be executed in the tree’s scope.  Receives two arguments: obj (the same node used to call load_node), status (a boolean indicating if the node was loaded successfully.

Returns

trueobj is a valid node and will try loading it
falseobj is not a valid node

Triggers

load_node

See also

_load_node

load_node

This event is triggered in the jstree namespace when a node is loaded (succesfully or not).

Parameters

data.instthe instance
data.argsarray the arguments passed to the function
data.pluginstring the function’s plugin (here it will be ”core” but if the function is extended it may be something else).
data.rsltobject which contains two keys obj (the loaded node) and status - whether the node was loaded successfully.

Example

$("div").bind("load_node.jstree", function (e, data) { if(data.rslt.status) { data.inst.open_node(data.rslt.obj); } });
-

_load_node

_load_node : function (obj,
callback)

Load the children of a node, but as opposed to load_node does not change any visual properties or trigger events.  This function is used in load_node internally.  The idea is for data source plugins to overwrite this function.  This implementation (from the core) only uses markup found in the tree container, and does not load async.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.  Use -1 to load the root nodes.
callbacka function to be executed in the tree’s scope.  Receives one argument: status (a boolean indicating if the node was loaded successfully).
+

_load_node

_load_node : function (obj,
callback)

Load the children of a node, but as opposed to load_node does not change any visual properties or trigger events.  This function is used in load_node internally.  The idea is for data source plugins to overwrite this function.  This implementation (from the core) only uses markup found in the tree container, and does not load async.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.  Use -1 to load the root nodes.
callbacka function to be executed in the tree’s scope.  Receives one argument: status (a boolean indicating if the node was loaded successfully).
-

open_node

Open a node so that its children are visible.  If the node is not loaded try loading it first.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.
callbacka function to be executed in the tree’s scope.  Receives two arguments: obj (the node being opened) and status (a boolean indicating if the node was opened successfully).
animationthe duration in miliseconds of the slideDown animation.  If not supplied the jQuery default is used.  Please note that on IE6 a 0 is enforced here due to performance issues.

Triggers

open_node, __after_open

+

open_node

Open a node so that its children are visible.  If the node is not loaded try loading it first.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.
callbacka function to be executed in the tree’s scope.  Receives two arguments: obj (the node being opened) and status (a boolean indicating if the node was opened successfully).
animationthe duration in miliseconds of the slideDown animation.  If not supplied the jQuery default is used.  Please note that on IE6 a 0 is enforced here due to performance issues.

Triggers

open_node, __after_open

-

open_node

This event is triggered in the jstree namespace when a node is successfully opened (but if animation is used this event is triggered BEFORE the animation completes).  See __after_open.

Parameters

data.instthe instance
data.argsarray the arguments passed to the function
data.pluginstring the function’s plugin (here it will be ”core” but if the function is extended it may be something else).
data.rsltobject which contains a single key: obj (the opened node).

Example

$("div").bind("open_node.jstree", function (e, data) {
+

open_node

This event is triggered in the jstree namespace when a node is successfully opened (but if animation is used this event is triggered BEFORE the animation completes).  See __after_open.

Parameters

data.instthe instance
data.argsarray the arguments passed to the function
data.pluginstring the function’s plugin (here it will be ”core” but if the function is extended it may be something else).
data.rsltobject which contains a single key: obj (the opened node).

Example

$("div").bind("open_node.jstree", function (e, data) {
   data.rslt.obj.find('> ul > .jstree-closed').each(function () {
     data.inst.open_node(this);
   }
 });
-

__after_open

This event is triggered in the jstree namespace when a node is successfully opened AFTER the animation completes).  See open_node.

Parameters

data.instthe instance
data.rsltobject which contains a single key: obj (the opened node).

Example

$("div").bind("__after_open.jstree", function (e, data) {
+

__after_open

This event is triggered in the jstree namespace when a node is successfully opened AFTER the animation completes).  See open_node.

Parameters

data.instthe instance
data.rsltobject which contains a single key: obj (the opened node).

Example

$("div").bind("__after_open.jstree", function (e, data) {
   data.rslt.obj.find('> ul > .jstree-closed').each(function () {
     data.inst.open_node(this);
   }
 });
-

close_node

Close a node so that its children are not visible.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.
animationthe duration in miliseconds of the slideDown animation.  If not supplied the jQuery default is used.  Please note that on IE6 a 0 is enforced here due to performance issues.

Triggers

close_node, __after_close

+

close_node

Close a node so that its children are not visible.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.
animationthe duration in miliseconds of the slideDown animation.  If not supplied the jQuery default is used.  Please note that on IE6 a 0 is enforced here due to performance issues.

Triggers

close_node, __after_close

-

close_node

This event is triggered in the jstree namespace when a node is closed (but if animation is used this event is triggered BEFORE the animation completes).  See __after_close.

Parameters

data.instthe instance
data.argsarray the arguments passed to the function
data.pluginstring the function’s plugin (here it will be ”core” but if the function is extended it may be something else).
data.rsltobject which contains a single key: obj (the closed node).

Example

$("div").bind("close_node.jstree", function (e, data) {
+

close_node

This event is triggered in the jstree namespace when a node is closed (but if animation is used this event is triggered BEFORE the animation completes).  See __after_close.

Parameters

data.instthe instance
data.argsarray the arguments passed to the function
data.pluginstring the function’s plugin (here it will be ”core” but if the function is extended it may be something else).
data.rsltobject which contains a single key: obj (the closed node).

Example

$("div").bind("close_node.jstree", function (e, data) {
   data.rslt.obj.children('ul').remove();
 });
-

__after_close

This event is triggered in the jstree namespace when a node is closed AFTER the animation completes).  See close_node.

Parameters

data.instthe instance
data.rsltobject which contains a single key: obj (the opened node).

Example

$("div").bind("__after_close.jstree", function (e, data) {
+

__after_close

This event is triggered in the jstree namespace when a node is closed AFTER the animation completes).  See close_node.

Parameters

data.instthe instance
data.rsltobject which contains a single key: obj (the opened node).

Example

$("div").bind("__after_close.jstree", function (e, data) {
   data.rslt.obj.children('ul').remove();
 });

toggle_node

toggle_node : function (obj)
If a node is closedopen it, if it is open - close it.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.
-

open_all

Open all nodes from a certain node down.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.  If -1 is used or is omitted all nodes in the tree are opened.
animationthe duration of the slideDown animation when opening the nodes.  If not set 0 is enforced for performance issues.
original_objused internally to keep track of the recursion - do not set manually!

Triggers

open_all

+

open_all

Open all nodes from a certain node down.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.  If -1 is used or is omitted all nodes in the tree are opened.
animationthe duration of the slideDown animation when opening the nodes.  If not set 0 is enforced for performance issues.
original_objused internally to keep track of the recursion - do not set manually!

Triggers

open_all

open_all

This event is triggered in the jstree namespace when an open_all call completes.

Parameters

data.instthe instance
data.argsarray the arguments passed to the function
data.pluginstring the function’s plugin (here it will be ”core” but if the function is extended it may be something else).
data.rsltobject which contains a single key: obj (the node used in the call).

Example

$("div").bind("open_all.jstree", function (e, data) {
   alert('DONE');
 });
-

close_all

Close all nodes from a certain node down.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.  If -1 is used or is omitted all nodes in the tree are closed.
animationthe duration of the slideDown animation when closing the nodes.  If not set 0 is enforced for performance issues.

Triggers

close_all

+

close_all

Close all nodes from a certain node down.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.  If -1 is used or is omitted all nodes in the tree are closed.
animationthe duration of the slideDown animation when closing the nodes.  If not set 0 is enforced for performance issues.

Triggers

close_all

close_all

This event is triggered in the jstree namespace when a close_all call completes.

Parameters

data.instthe instance
data.argsarray the arguments passed to the function
data.pluginstring the function’s plugin (here it will be ”core” but if the function is extended it may be something else).
data.rsltobject which contains a single key: obj (the node used in the call).

Example

$("div").bind("close_all.jstree", function (e, data) {
   alert('DONE');
 });
-

clean_node

clean_node : function (obj)

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 load_node event).  Each plugin may override this function to include its own markup, but keep in mind to do it like that:

clean_node : function(obj) {
+

clean_node

clean_node : function (obj)

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 load_node event).  Each plugin may override this function to include its own markup, but keep in mind to do it like that:

clean_node : function(obj) {
  obj = this.__call_old();
  obj.each(function () {
    // do your stuff here
@@ -192,20 +194,72 @@
 
 

correct_node

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.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.  If -1 is used or is omitted the root nodes are processed.

Returns

jQuery collectionthe processed children of the original node.
+

scroll_to_node

scroll_to_node : function (obj)

This function scrolls the container to the desired node (if needed).

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.
+ +

get_state

get_state : function ()

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:

get_state : function () {
+  var state = this.__call_old();
+  state.your-plugin-name = <some-value-you-collect>;
+  return state;
+}

Returns

objectthe current state of the instance
+ +

set_state

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:

set_state : function (state, callback) {
+  if(this.__call_old()) {
+    if(state.your-plugin-name) {
+
+      // restore using `state.your-plugin-name`
+      // if you need some async activity so that you return to this bit of code
+      // do not delete state.your-plugin-name and return false (see core's function for example)
+
+      delete state.your-plugin-name;
+      this.set_state(state, callback);
+      return false;
+    }
+    return true;
+  }
+  return false;
+}

Parameters

stateobject the state to restore to
callbackfunction this will be executed in the instance’s scope once restoring is done

Returns

booleanthe return value is used to determine the phase of restoration

Triggers

set_state

+ +

set_state

This event is triggered in the jstree namespace when a set_state call completes.

Parameters

data.instthe instance
data.argsarray the arguments passed to the function
data.pluginstring the function’s plugin (here it will be ”core” but if the function is extended it may be something else)
+ +

refresh

This function saves the current state, reloads the complete tree and returns it to the saved state.

Triggers

refresh

+ +

refresh

This event is triggered in the jstree namespace when a refresh call completes.

Parameters

data.instthe instance
+ +

get_text

get_text : function (obj,
remove_html)

This function returns the title of the node.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.
remove_htmlboolean set to true to return plain text instead of HTML

Returns

stringthe title of the node, specified by obj
+ +

set_text

This function sets the title of the node.  This is a low-level function, you’d be better off using <rename>.

Parameters

objmixed this is used as a jquery selector - can be jQuery object, DOM node, string, etc.
valstring the new title of the node (can be HTMl too)

Returns

booleanwas the rename successfull

Triggers

set_text

+ +

set_text

This event is triggered in the jstree namespace when a set_text call completes.

Parameters

data.instthe instance
data.argsarray the arguments passed to the function
data.pluginstring the function’s plugin (here it will be ”core” but if the function is extended it may be something else)
data.rsltobject which contains a two key: obj (the node) and val (the new title).

Example

$("div").bind("set_text.jstree", function (e, data) {
+  alert("Renamed to: " + data.rslt.val);
+});
+ +

parse_json

parse_json : function (node)

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 jstree.config.core.strings if none is specified.

Parameters

nodemixed the input to parse
// can be a string
+"The title of the parsed node"
+// array of strings
+[ "Node 1", "Node 2" ]
+// an object
+{ "title" : "The title of the parsed node" }
+// you can manipulate the output
+{ "title" : "The title of the parsed node", "li_attr" : { "id" : "id_for_li" }, "a_attr" : { "href" : "http://jstree.com" } }
+// you can supply metadata, which you can later access using $(the_li_node).data()
+{ "title" : "The title of the parsed node", "data" : { <some-values-here> } }
+// you can supply children (they can be objects too)
+{ "title" : "The title of the parsed node", "children" : [ "Node 1", { "title" : "Node 2" } ] }

Returns

jQuerythe LI (or UL) node which was produced from the JSON
+
- + - -
The actual plugin wrapper, use this to create instances or execute functions on created instances.
$.jstree
object Contains all static functions and variables used by jstree, some plugins also append variables.
$.jstree.SCROLLBAR_WIDTH
integer indicating the width of the client scrollbar
_get_string : function (s)
Used to get the common string in the tree.
is_locked : function ()
Used to get the locked status of the tree.
get_node : function (obj)
Get a hold of the LI node (which represents the jstree node).
get_next : function (obj,
strict)
Get the next sibling of a node
get_prev : function (obj,
strict)
Get the previous sibling of a node
get_parent : function (obj)
Get the parent of a node
get_children : function (obj)
Get all the children of a node
is_parent : function (obj)
Check if a node is a parent.
is_loaded : function (obj)
Check if a node is loaded.
is_loading : function (obj)
Check if a node is currently loading.
is_open : function (obj)
Check if a node is currently open.
is_closed : function (obj)
Check if a node is currently closed.
is_leaf : function (obj)
Check if a node is a leaf node (has no children).
_load_node : function (obj,
callback)
Load the children of a node, but as opposed to load_node does not change any visual properties or trigger events.
Load the children of a node.
toggle_node : function (obj)
clean_node : function (obj)
This function converts inserted nodes to the required by jsTree format.
Returns an instance
Creates a new jstree instance, any arguments after the first one are merged and used to configure the tree.
Call a function on the instance and return the result
Destroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace
mixed used to store all localization strings.
This event is triggered in the jstree namespace when data is first rendered in the tree.
Used to unlock the tree.
Used to lock the tree.
Open a node so that its children are visible.
This event is triggered in the jstree namespace when a node is successfully opened AFTER the animation completes).
Close a node so that its children are not visible.
This event is triggered in the jstree namespace when a node is closed AFTER the animation completes).
Open all nodes from a certain node down.
Close all nodes from a certain node down.
+
The actual plugin wrapper, use this to create instances or execute functions on created instances.
$.jstree
object Contains all static functions and variables used by jstree, some plugins also append variables.
$.jstree.SCROLLBAR_WIDTH
integer indicating the width of the client scrollbar
_get_string : function (s)
Used to get the common string in the tree.
is_locked : function ()
Used to get the locked status of the tree.
get_node : function (obj)
Get a hold of the LI node (which represents the jstree node).
get_next : function (obj,
strict)
Get the next sibling of a node
get_prev : function (obj,
strict)
Get the previous sibling of a node
get_parent : function (obj)
Get the parent of a node
get_children : function (obj)
Get all the children of a node
is_parent : function (obj)
Check if a node is a parent.
is_loaded : function (obj)
Check if a node is loaded.
is_loading : function (obj)
Check if a node is currently loading.
is_open : function (obj)
Check if a node is currently open.
is_closed : function (obj)
Check if a node is currently closed.
is_leaf : function (obj)
Check if a node is a leaf node (has no children).
_load_node : function (obj,
callback)
Load the children of a node, but as opposed to load_node does not change any visual properties or trigger events.
Load the children of a node.
toggle_node : function (obj)
clean_node : function (obj)
This function converts inserted nodes to the required by jsTree format.
scroll_to_node : function (obj)
This function scrolls the container to the desired node (if needed).
get_state : function ()
This function returns the current state of the tree (as collected from all active plugins).
get_text : function (obj,
remove_html)
This function returns the title of the node.
parse_json : function (node)
This function returns a jQuery node after parsing a JSON object (a LI node for single elements or an UL node for multiple).
Returns an instance
Creates a new jstree instance, any arguments after the first one are merged and used to configure the tree.
Call a function on the instance and return the result
Destroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace
mixed used to store all localization strings.
This event is triggered in the jstree namespace when data is first rendered in the tree.
Used to unlock the tree.
Used to lock the tree.
Open a node so that its children are visible.
This event is triggered in the jstree namespace when a node is successfully opened AFTER the animation completes).
Close a node so that its children are not visible.
This event is triggered in the jstree namespace when a node is closed AFTER the animation completes).
Open all nodes from a certain node down.
Close all nodes from a certain node down.
This function returns sets the state of the tree.
This function saves the current state, reloads the complete tree and returns it to the saved state.
This function sets the title of the node.
diff --git a/_docs/files/jstree-themes-js.html b/_docs/files/jstree-themes-js.html index e7fdc9cb..4bc58d6e 100644 --- a/_docs/files/jstree-themes-js.html +++ b/_docs/files/jstree-themes-js.html @@ -40,10 +40,10 @@
- + - diff --git a/_docs/files/jstree-ui-js.html b/_docs/files/jstree-ui-js.html index 15101ee6..ecd4ffcc 100644 --- a/_docs/files/jstree-ui-js.html +++ b/_docs/files/jstree-ui-js.html @@ -18,10 +18,10 @@
- + - diff --git a/_docs/files/vakata-js.html b/_docs/files/vakata-js.html index 26b1fb6f..66b78b43 100644 --- a/_docs/files/vakata-js.html +++ b/_docs/files/vakata-js.html @@ -154,10 +154,10 @@
- + - diff --git a/_docs/index.html b/_docs/index.html index c4ab8dc4..7e0f3a21 100644 --- a/_docs/index.html +++ b/_docs/index.html @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/_docs/index/Classes.html b/_docs/index/Classes.html index 61e1e700..16784a9d 100644 --- a/_docs/index/Classes.html +++ b/_docs/index/Classes.html @@ -18,10 +18,10 @@
- + - diff --git a/_docs/index/Events.html b/_docs/index/Events.html index 18c6ca91..ad20c499 100644 --- a/_docs/index/Events.html +++ b/_docs/index/Events.html @@ -26,10 +26,10 @@
- + - diff --git a/_docs/index/Files.html b/_docs/index/Files.html index c2e03ee5..ffb697ff 100644 --- a/_docs/index/Files.html +++ b/_docs/index/Files.html @@ -11,7 +11,7 @@ -
File Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
H
 Helper functions
J
 jquery.js
 jstree.core.js
 jstree.themes.js
 jstree.ui.js
+
File Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
H
 Helper functions
J
 jstree.core.js
 jstree.themes.js
 jstree.ui.js
This file includes some functions that enable CSS manipulations, contextmenus, XSLT transformations and drag’n’drop.
@@ -22,10 +22,10 @@
- + - diff --git a/_docs/index/Functions.html b/_docs/index/Functions.html index ec283939..c786a72f 100644 --- a/_docs/index/Functions.html +++ b/_docs/index/Functions.html @@ -11,7 +11,7 @@ -
Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 __call, $.jstree
 __construct, $.jstree
 __destruct, $.jstree
 __trigger, jstree
 _clean, $.vakata.dnd
 _execute, $.vakata.context
 _focus, $.jstree
 _focused, $.jstree
 _get_string, jstree
 _load_node, jstree
 _parse, $.vakata.context
 _reference, $.jstree
 _scroll, $.vakata.dnd
 _show_submenu, $.vakata.context
 _trigger
A
 add_css, $.vakata.css
 add_sheet, $.vakata.css
 array_remove, $.vakata
C
 clean_node, jstree
 close_all, jstree
 close_node, jstree
 correct_node, jstree
D
 drag, $.vakata.dnd
G
 get_children, jstree
 get_container, jstree
 get_container_ul, jstree
 get_css, $.vakata.css
 get_index, jstree
 get_next, jstree
 get_node, jstree
 get_parent, jstree
 get_prev, jstree
 get_settings, jstree
H
 hide, $.vakata.context
I
 init, jstree
 is_closed, jstree
 is_leaf, jstree
 is_loaded, jstree
 is_loading, jstree
 is_locked, jstree
 is_open, jstree
 is_parent, jstree
L
 load_node, jstree
 lock, jstree
O
 open_all, jstree
 open_node, jstree
P
 plugin, $.jstree
R
 remove_css, $.vakata.css
S
 set_theme, jstree
 show, $.vakata.context
 start, $.vakata.dnd
 stop, $.vakata.dnd
T
 toggle_node, jstree
U
 unlock, jstree
V
 vakata_reverse, $()
X
 xslt, $.vakata
+
Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 __call, $.jstree
 __construct, $.jstree
 __destruct, $.jstree
 __trigger, jstree
 _clean, $.vakata.dnd
 _execute, $.vakata.context
 _focus, $.jstree
 _focused, $.jstree
 _get_string, jstree
 _load_node, jstree
 _parse, $.vakata.context
 _reference, $.jstree
 _scroll, $.vakata.dnd
 _show_submenu, $.vakata.context
 _trigger
A
 add_css, $.vakata.css
 add_sheet, $.vakata.css
 array_remove, $.vakata
C
 clean_node, jstree
 close_all, jstree
 close_node, jstree
 correct_node, jstree
D
 drag, $.vakata.dnd
G
 get_children, jstree
 get_container, jstree
 get_container_ul, jstree
 get_css, $.vakata.css
 get_index, jstree
 get_next, jstree
 get_node, jstree
 get_parent, jstree
 get_prev, jstree
 get_settings, jstree
 get_state, jstree
 get_text, jstree
H
 hide, $.vakata.context
I
 init, jstree
 is_closed, jstree
 is_leaf, jstree
 is_loaded, jstree
 is_loading, jstree
 is_locked, jstree
 is_open, jstree
 is_parent, jstree
L
 load_node, jstree
 lock, jstree
O
 open_all, jstree
 open_node, jstree
P
 parse_json, jstree
 plugin, $.jstree
R
 refresh, jstree
 remove_css, $.vakata.css
S
 scroll_to_node, jstree
 set_state, jstree
 set_text, jstree
 set_theme, jstree
 show, $.vakata.context
 start, $.vakata.dnd
 stop, $.vakata.dnd
T
 toggle_node, jstree
U
 unlock, jstree
V
 vakata_reverse, $()
X
 xslt, $.vakata
Call a function on the instance and return the result
Creates a new jstree instance, any arguments after the first one are merged and used to configure the tree.
Destroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace
Used internally to trigger events on the container node.
Used internally to cleanup after a drop, so that all variables are nulled and ready for the next drag.
Used internally to execute the action (if any) associated with an item.
Make an instance focused (which defocuses the previously focused instance)
Returns the currently focused instance (by default once an instance is created it is focused)
_get_string : function (s)
Used to get the common string in the tree.
_load_node : function (obj,
callback)
Load the children of a node, but as opposed to load_node does not change any visual properties or trigger events.
Used internally to parse a contextmenu description object to an HTML string.
Returns an instance
Used internally to scroll hovered elements.
Used internally to show a submenu
Used internally to trigger all necessary events.
Used internally to trigger all necessary events.
@@ -29,59 +29,59 @@ -
get_children : function (obj)
Get all the children of a node
Returns the jQuery extended container of the tree (the element you used when constructing the tree).
Returns the jQuery extended first UL node inside the container of the tree.
Retrieves or deletes a specific rule.
Returns an integer, which is the instance’s index.
get_next : function (obj,
strict)
Get the next sibling of a node
get_node : function (obj)
Get a hold of the LI node (which represents the jstree node).
get_parent : function (obj)
Get the parent of a node
get_prev : function (obj,
strict)
Get the previous sibling of a node
Returns the settings for the tree.
+
get_children : function (obj)
Get all the children of a node
Returns the jQuery extended container of the tree (the element you used when constructing the tree).
Returns the jQuery extended first UL node inside the container of the tree.
Retrieves or deletes a specific rule.
Returns an integer, which is the instance’s index.
get_next : function (obj,
strict)
Get the next sibling of a node
get_node : function (obj)
Get a hold of the LI node (which represents the jstree node).
get_parent : function (obj)
Get the parent of a node
get_prev : function (obj,
strict)
Get the previous sibling of a node
Returns the settings for the tree.
get_state : function ()
This function returns the current state of the tree (as collected from all active plugins).
get_text : function (obj,
remove_html)
This function returns the title of the node.
-
Used internally to hide the contextmenu after a click, or on mouseleave, etc.
+
Used internally to hide the contextmenu after a click, or on mouseleave, etc.
-
Used internally.
is_closed : function (obj)
Check if a node is currently closed.
is_leaf : function (obj)
Check if a node is a leaf node (has no children).
is_loaded : function (obj)
Check if a node is loaded.
is_loading : function (obj)
Check if a node is currently loading.
is_locked : function ()
Used to get the locked status of the tree.
is_open : function (obj)
Check if a node is currently open.
is_parent : function (obj)
Check if a node is a parent.
+
Used internally.
is_closed : function (obj)
Check if a node is currently closed.
is_leaf : function (obj)
Check if a node is a leaf node (has no children).
is_loaded : function (obj)
Check if a node is loaded.
is_loading : function (obj)
Check if a node is currently loading.
is_locked : function ()
Used to get the locked status of the tree.
is_open : function (obj)
Check if a node is currently open.
is_parent : function (obj)
Check if a node is a parent.
-
Load the children of a node.
Used to lock the tree.
+
Load the children of a node.
Used to lock the tree.
-
Open all nodes from a certain node down.
Open a node so that its children are visible.
+
Open all nodes from a certain node down.
Open a node so that its children are visible.
-
Register a plugin
+
parse_json : function (node)
This function returns a jQuery node after parsing a JSON object (a LI node for single elements or an UL node for multiple).
Register a plugin
-
Removes a rule, this functions is a shortcut to $.vakata.css.get_css with the delete flag set to true.
+
This function saves the current state, reloads the complete tree and returns it to the saved state.
Removes a rule, this functions is a shortcut to $.vakata.css.get_css with the delete flag set to true.
-
set_theme : function (theme_name,
theme_url)
Sets the tree theme.
Shows the context menu.
Use this function to start a drag (usually with the mousedown event)
Used internally to process the mouseup event (drop) after $.vakata.dnd.start is called.
+
scroll_to_node : function (obj)
This function scrolls the container to the desired node (if needed).
This function returns sets the state of the tree.
This function sets the title of the node.
set_theme : function (theme_name,
theme_url)
Sets the tree theme.
Shows the context menu.
Use this function to start a drag (usually with the mousedown event)
Used internally to process the mouseup event (drop) after $.vakata.dnd.start is called.
-
toggle_node : function (obj)
+
toggle_node : function (obj)
-
Used to unlock the tree.
+
Used to unlock the tree.
-
Makes it possible to apply the standard array reverse function to a jQuery collection.
+
Makes it possible to apply the standard array reverse function to a jQuery collection.
-
$.vakata.xslt = function (xml,
xsl,
callback)
This functions transforms a XML string using a XSL string.
+
$.vakata.xslt = function (xml,
xsl,
callback)
This functions transforms a XML string using a XSL string.
- + - diff --git a/_docs/index/General.html b/_docs/index/General.html index c31527ff..937084fc 100644 --- a/_docs/index/General.html +++ b/_docs/index/General.html @@ -11,25 +11,25 @@ -
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 $(“#id”)
 $(array), $(html)
 $(expr,context)
 $(function)
 )), $(expr,$(
 __after_close, jstree
 __after_open, jstree
 __call, $.jstree
 __construct, $.jstree
 __destruct, $.jstree
 __loaded, jstree
 __trigger, jstree
 _clean, $.vakata.dnd
 _execute, $.vakata.context
 _focus, $.jstree
 _focused, $.jstree
 _get_string, jstree
 _load_node, jstree
 _parse, $.vakata.context
 _reference, $.jstree
 _scroll, $.vakata.dnd
 _show_submenu, $.vakata.context
 _trigger
A
 add_css, $.vakata.css
 add_sheet, $.vakata.css
 array_remove, $.vakata
C
 clean_node, jstree
 close_all, jstree
 close_node, jstree
 context, $.vakata
 Context menu
 context_hide
 context_menu_item
 context_parse
 context_show
 CORE functions, jstree
 CORE options, jstree
 correct_node, jstree
 css, $.vakata
 CSS
D
 data, jstree
 defaults, $.jstree
 dnd, $.vakata
 dnd_move
 dnd_start
 dnd_stop
 dots, jstree.config.themes
 drag, $.vakata.dnd
 Drag’n’drop
G
 get_children, jstree
 get_container, jstree
 get_container_ul, jstree
 get_css, $.vakata.css
 get_index, jstree
 get_next, jstree
 get_node, jstree
 get_parent, jstree
 get_prev, jstree
 get_settings, jstree
H
 Helper functions
 helper_left, $.vakata.dnd.settings
 helper_top, $.vakata.dnd.settings
 hide, $.vakata.context
 hide_onmouseleave, $.vakata.context.settings
I
 icons
 init, jstree
 is_closed, jstree
 IS_FF2, $.jstree
 IS_IE6, $.jstree
 IS_IE7, $.jstree
 is_leaf, jstree
 is_loaded, jstree
 is_loading, jstree
 is_locked, jstree
 is_open, jstree
 is_parent, jstree
J
 jquery.js
 jstree
 jstree UI plugin
 jstree.core.js
 jstree.themes.js
 jstree.ui.js
L
 License
 load_node, jstree
 lock, jstree
O
 open_all, jstree
 open_node, jstree
P
 plugin, $.jstree
R
 remove_css, $.vakata.css
S
 scroll_proximity, $.vakata.dnd.settings
 scroll_speed, $.vakata.dnd.settings
 SCROLLBAR_WIDTH, $.jstree
 set_theme, jstree
 settings
 show, $.vakata.context
 start, $.vakata.dnd
 stop, $.vakata.dnd
 strings, jstree.config.core
T
 theme, jstree.config.themes
 THEMES functions, jstree
 THEMES options, jstree
 THEMES_DIR, $.jstree
 threshold, $.vakata.dnd.settings
 toggle_node, jstree
U
 unlock, jstree
 url, jstree.config.themes
 Usage
+
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 __after_close, jstree
 __after_open, jstree
 __call, $.jstree
 __construct, $.jstree
 __destruct, $.jstree
 __loaded, jstree
 __trigger, jstree
 _clean, $.vakata.dnd
 _execute, $.vakata.context
 _focus, $.jstree
 _focused, $.jstree
 _get_string, jstree
 _load_node, jstree
 _parse, $.vakata.context
 _reference, $.jstree
 _scroll, $.vakata.dnd
 _show_submenu, $.vakata.context
 _trigger
A
 add_css, $.vakata.css
 add_sheet, $.vakata.css
 array_remove, $.vakata
C
 clean_node, jstree
 close_all, jstree
 close_node, jstree
 context, $.vakata
 Context menu
 context_hide
 context_menu_item
 context_parse
 context_show
 CORE functions, jstree
 CORE options, jstree
 correct_node, jstree
 css, $.vakata
 CSS
D
 data, jstree
 defaults, $.jstree
 dnd, $.vakata
 dnd_move
 dnd_start
 dnd_stop
 dots, jstree.config.themes
 drag, $.vakata.dnd
 Drag’n’drop
G
 get_children, jstree
 get_container, jstree
 get_container_ul, jstree
 get_css, $.vakata.css
 get_index, jstree
 get_next, jstree
 get_node, jstree
 get_parent, jstree
 get_prev, jstree
 get_settings, jstree
 get_state, jstree
 get_text, jstree
H
 Helper functions
 helper_left, $.vakata.dnd.settings
 helper_top, $.vakata.dnd.settings
 hide, $.vakata.context
 hide_onmouseleave, $.vakata.context.settings
I
 icons
 init, jstree
 is_closed, jstree
 IS_FF2, $.jstree
 IS_IE6, $.jstree
 IS_IE7, $.jstree
 is_leaf, jstree
 is_loaded, jstree
 is_loading, jstree
 is_locked, jstree
 is_open, jstree
 is_parent, jstree
J
 jstree
 jstree UI plugin
 jstree.core.js
 jstree.themes.js
 jstree.ui.js
L
 License
 load_node, jstree
 lock, jstree
O
 open_all, jstree
 open_node, jstree
P
 parse_json, jstree
 plugin, $.jstree
R
 refresh, jstree
 remove_css, $.vakata.css
S
 scroll_proximity, $.vakata.dnd.settings
 scroll_speed, $.vakata.dnd.settings
 scroll_to_node, jstree
 SCROLLBAR_WIDTH, $.jstree
 set_state, jstree
 set_text, jstree
 set_theme, jstree
 settings
 show, $.vakata.context
 start, $.vakata.dnd
 stop, $.vakata.dnd
 strings, jstree.config.core
-
(which is just equivalent to: $(context).find(expr)
Shortcut for document ready
This event is triggered in the jstree namespace when a node is closed AFTER the animation completes).
This event is triggered in the jstree namespace when a node is successfully opened AFTER the animation completes).
Call a function on the instance and return the result
Creates a new jstree instance, any arguments after the first one are merged and used to configure the tree.
Destroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace
This event is triggered in the jstree namespace when data is first rendered in the tree.
Used internally to trigger events on the container node.
Used internally to cleanup after a drop, so that all variables are nulled and ready for the next drag.
Used internally to execute the action (if any) associated with an item.
Make an instance focused (which defocuses the previously focused instance)
Returns the currently focused instance (by default once an instance is created it is focused)
_get_string : function (s)
Used to get the common string in the tree.
_load_node : function (obj,
callback)
Load the children of a node, but as opposed to load_node does not change any visual properties or trigger events.
Used internally to parse a contextmenu description object to an HTML string.
Returns an instance
Used internally to scroll hovered elements.
Used internally to show a submenu
Used internally to trigger all necessary events.
Used internally to trigger all necessary events.
+
This event is triggered in the jstree namespace when a node is closed AFTER the animation completes).
This event is triggered in the jstree namespace when a node is successfully opened AFTER the animation completes).
Call a function on the instance and return the result
Creates a new jstree instance, any arguments after the first one are merged and used to configure the tree.
Destroys an instance, and also clears `jstree-` prefixed classes and all events in the `jstree` namespace
This event is triggered in the jstree namespace when data is first rendered in the tree.
Used internally to trigger events on the container node.
Used internally to cleanup after a drop, so that all variables are nulled and ready for the next drag.
Used internally to execute the action (if any) associated with an item.
Make an instance focused (which defocuses the previously focused instance)
Returns the currently focused instance (by default once an instance is created it is focused)
_get_string : function (s)
Used to get the common string in the tree.
_load_node : function (obj,
callback)
Load the children of a node, but as opposed to load_node does not change any visual properties or trigger events.
Used internally to parse a contextmenu description object to an HTML string.
Returns an instance
Used internally to scroll hovered elements.
Used internally to show a submenu
Used internally to trigger all necessary events.
Used internally to trigger all necessary events.
-
Adds a rule.
Adds a whole stylesheet or appends to an existing stylesheet.
$.vakata.array_remove = function(array,
from,
to)
Makes it possible to remove an item (or a group of items) form an array.
+
Adds a rule.
Adds a whole stylesheet or appends to an existing stylesheet.
$.vakata.array_remove = function(array,
from,
to)
Makes it possible to remove an item (or a group of items) form an array.
-
clean_node : function (obj)
This function converts inserted nodes to the required by jsTree format.
Close all nodes from a certain node down.
Close a node so that its children are not visible.
$.vakata.context
object holds all context menu related functions and variables.
Functions needed to show a custom context menu.
Triggered when the context menu is hidden.
object Used to construct a context menu entry, this structure will always be a part of an object.
Triggered when the context menu is parsed but not yet shown.
Triggered when the context menu is shown.
This function corrects the open/closed/leaf state as data changes (as the user interacts with the tree).
$.vakata.css
object holds all CSS related functions
Functions needed to manipulate stylesheets (add, remove, change)
+
clean_node : function (obj)
This function converts inserted nodes to the required by jsTree format.
Close all nodes from a certain node down.
Close a node so that its children are not visible.
$.vakata.context
object holds all context menu related functions and variables.
Functions needed to show a custom context menu.
Triggered when the context menu is hidden.
object Used to construct a context menu entry, this structure will always be a part of an object.
Triggered when the context menu is parsed but not yet shown.
Triggered when the context menu is shown.
This function corrects the open/closed/leaf state as data changes (as the user interacts with the tree).
$.vakata.css
object holds all CSS related functions
Functions needed to manipulate stylesheets (add, remove, change)
-
object Provides storage for plugins (aside from private variables).
object storing all the default configuration options for every plugin and the core.
$.vakata.dnd
object holds all DND related functions
Triggered multiple times while dragging.
Marks the start of the drag.
Marks the end of the drag.
boolean whether to show dots or not.
Used internally to process the mousemove event after $.vakata.dnd.start is called.
Functions needed to drag’n’drop elements
+
object Provides storage for plugins (aside from private variables).
object storing all the default configuration options for every plugin and the core.
$.vakata.dnd
object holds all DND related functions
Triggered multiple times while dragging.
Marks the start of the drag.
Marks the end of the drag.
boolean whether to show dots or not.
Used internally to process the mousemove event after $.vakata.dnd.start is called.
Functions needed to drag’n’drop elements
-
get_children : function (obj)
Get all the children of a node
Returns the jQuery extended container of the tree (the element you used when constructing the tree).
Returns the jQuery extended first UL node inside the container of the tree.
Retrieves or deletes a specific rule.
Returns an integer, which is the instance’s index.
get_next : function (obj,
strict)
Get the next sibling of a node
get_node : function (obj)
Get a hold of the LI node (which represents the jstree node).
get_parent : function (obj)
Get the parent of a node
get_prev : function (obj,
strict)
Get the previous sibling of a node
Returns the settings for the tree.
+
get_children : function (obj)
Get all the children of a node
Returns the jQuery extended container of the tree (the element you used when constructing the tree).
Returns the jQuery extended first UL node inside the container of the tree.
Retrieves or deletes a specific rule.
Returns an integer, which is the instance’s index.
get_next : function (obj,
strict)
Get the next sibling of a node
get_node : function (obj)
Get a hold of the LI node (which represents the jstree node).
get_parent : function (obj)
Get the parent of a node
get_prev : function (obj,
strict)
Get the previous sibling of a node
Returns the settings for the tree.
get_state : function ()
This function returns the current state of the tree (as collected from all active plugins).
get_text : function (obj,
remove_html)
This function returns the title of the node.
@@ -53,31 +53,23 @@ -
Register a plugin
+
parse_json : function (node)
This function returns a jQuery node after parsing a JSON object (a LI node for single elements or an UL node for multiple).
Register a plugin
-
Removes a rule, this functions is a shortcut to $.vakata.css.get_css with the delete flag set to true.
+
This function saves the current state, reloads the complete tree and returns it to the saved state.
Removes a rule, this functions is a shortcut to $.vakata.css.get_css with the delete flag set to true.
-
integer number of pixels from the edge of a scrollable parent below which the parent will start scrolling.
integer how fast (pixel count for each step) should a scrollable parent scroll when dragging near the edge.
$.jstree.SCROLLBAR_WIDTH
integer indicating the width of the client scrollbar
set_theme : function (theme_name,
theme_url)
Sets the tree theme.
object holds the global settings object for context menus.
object holds the global settings object for DND.
Shows the context menu.
Use this function to start a drag (usually with the mousedown event)
Used internally to process the mouseup event (drop) after $.vakata.dnd.start is called.
mixed used to store all localization strings.
- - - -
string the name of the theme you want to use.
$.jstree.THEMES_DIR
The location of all themes, this is used when setting a theme without supplying an URL (only by name).
integer amount of pixels required to move before the drag is started.
toggle_node : function (obj)
- - - -
Used to unlock the tree.
mixed the URL of the stylesheet of the theme you want to use.
Introduction
+
integer number of pixels from the edge of a scrollable parent below which the parent will start scrolling.
integer how fast (pixel count for each step) should a scrollable parent scroll when dragging near the edge.
scroll_to_node : function (obj)
This function scrolls the container to the desired node (if needed).
$.jstree.SCROLLBAR_WIDTH
integer indicating the width of the client scrollbar
This function returns sets the state of the tree.
This function sets the title of the node.
set_theme : function (theme_name,
theme_url)
Sets the tree theme.
object holds the global settings object for context menus.
object holds the global settings object for DND.
Shows the context menu.
Use this function to start a drag (usually with the mousedown event)
Used internally to process the mouseup event (drop) after $.vakata.dnd.start is called.
mixed used to store all localization strings.
- + - diff --git a/_docs/index/General2.html b/_docs/index/General2.html index 791c96aa..94a03b44 100644 --- a/_docs/index/General2.html +++ b/_docs/index/General2.html @@ -11,21 +11,29 @@ -
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
V
 vakata, $
 vakata_reverse, $()
 Variables
X
 xslt, $.vakata
 XSLT
+
Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
T
 theme, jstree.config.themes
 THEMES functions, jstree
 THEMES options, jstree
 THEMES_DIR, $.jstree
 threshold, $.vakata.dnd.settings
 toggle_node, jstree
U
 unlock, jstree
 url, jstree.config.themes
 Usage
V
 vakata, $
 vakata_reverse, $()
 VERSION, $.jstree
X
 xslt, $.vakata
 XSLT
-
$.vakata
object Holds all helper objects.
Makes it possible to apply the standard array reverse function to a jQuery collection.
+
string the name of the theme you want to use.
$.jstree.THEMES_DIR
The location of all themes, this is used when setting a theme without supplying an URL (only by name).
integer amount of pixels required to move before the drag is started.
toggle_node : function (obj)
-
$.vakata.xslt = function (xml,
xsl,
callback)
This functions transforms a XML string using a XSL string.
A function used to do XSLT transformations.
+
Used to unlock the tree.
mixed the URL of the stylesheet of the theme you want to use.
Introduction
+ + + +
$.vakata
object Holds all helper objects.
Makes it possible to apply the standard array reverse function to a jQuery collection.
string the version of jstree
+ + + +
$.vakata.xslt = function (xml,
xsl,
callback)
This functions transforms a XML string using a XSL string.
A function used to do XSLT transformations.
- + - diff --git a/_docs/index/Variables.html b/_docs/index/Variables.html index 48725a56..e8478d00 100644 --- a/_docs/index/Variables.html +++ b/_docs/index/Variables.html @@ -11,49 +11,45 @@ -
Variable Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 $(“#id”)
 $(array), $(html)
 $(expr,context)
 $(function)
 )), $(expr,$(
C
 context, $.vakata
 context_menu_item
 css, $.vakata
D
 data, jstree
 defaults, $.jstree
 dnd, $.vakata
 dots, jstree.config.themes
H
 helper_left, $.vakata.dnd.settings
 helper_top, $.vakata.dnd.settings
 hide_onmouseleave, $.vakata.context.settings
I
 icons
 IS_FF2, $.jstree
 IS_IE6, $.jstree
 IS_IE7, $.jstree
S
 scroll_proximity, $.vakata.dnd.settings
 scroll_speed, $.vakata.dnd.settings
 SCROLLBAR_WIDTH, $.jstree
 settings
 strings, jstree.config.core
T
 theme, jstree.config.themes
 THEMES_DIR, $.jstree
 threshold, $.vakata.dnd.settings
U
 url, jstree.config.themes
V
 vakata, $
+
Variable Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
C
 context, $.vakata
 context_menu_item
 css, $.vakata
D
 data, jstree
 defaults, $.jstree
 dnd, $.vakata
 dots, jstree.config.themes
H
 helper_left, $.vakata.dnd.settings
 helper_top, $.vakata.dnd.settings
 hide_onmouseleave, $.vakata.context.settings
I
 icons
 IS_FF2, $.jstree
 IS_IE6, $.jstree
 IS_IE7, $.jstree
S
 scroll_proximity, $.vakata.dnd.settings
 scroll_speed, $.vakata.dnd.settings
 SCROLLBAR_WIDTH, $.jstree
 settings
 strings, jstree.config.core
T
 theme, jstree.config.themes
 THEMES_DIR, $.jstree
 threshold, $.vakata.dnd.settings
U
 url, jstree.config.themes
V
 vakata, $
 VERSION, $.jstree
-
(which is just equivalent to: $(context).find(expr)
Shortcut for document ready
+
$.vakata.context
object holds all context menu related functions and variables.
object Used to construct a context menu entry, this structure will always be a part of an object.
$.vakata.css
object holds all CSS related functions
-
$.vakata.context
object holds all context menu related functions and variables.
object Used to construct a context menu entry, this structure will always be a part of an object.
$.vakata.css
object holds all CSS related functions
+
object Provides storage for plugins (aside from private variables).
object storing all the default configuration options for every plugin and the core.
$.vakata.dnd
object holds all DND related functions
boolean whether to show dots or not.
-
object Provides storage for plugins (aside from private variables).
object storing all the default configuration options for every plugin and the core.
$.vakata.dnd
object holds all DND related functions
boolean whether to show dots or not.
+
integer number of pixels left of the cursor to move the drag-helper to.
integer number of pixels below the cursor to move the drag-helper to.
integer the amount of milliseconds to wait before hiding the menu after mouseleave.
-
integer number of pixels left of the cursor to move the drag-helper to.
integer number of pixels below the cursor to move the drag-helper to.
integer the amount of milliseconds to wait before hiding the menu after mouseleave.
+
boolean whether to show icons or not.
boolean whether to show icons or not.
boolean indicating if the client is running Firefox 2
boolean indicating if the client is running Internet Explorer 6
boolean indicating if the client is running Internet Explorer 7
-
boolean whether to show icons or not.
boolean whether to show icons or not.
boolean indicating if the client is running Firefox 2
boolean indicating if the client is running Internet Explorer 6
boolean indicating if the client is running Internet Explorer 7
+
integer number of pixels from the edge of a scrollable parent below which the parent will start scrolling.
integer how fast (pixel count for each step) should a scrollable parent scroll when dragging near the edge.
$.jstree.SCROLLBAR_WIDTH
integer indicating the width of the client scrollbar
object holds the global settings object for context menus.
object holds the global settings object for DND.
mixed used to store all localization strings.
-
integer number of pixels from the edge of a scrollable parent below which the parent will start scrolling.
integer how fast (pixel count for each step) should a scrollable parent scroll when dragging near the edge.
$.jstree.SCROLLBAR_WIDTH
integer indicating the width of the client scrollbar
object holds the global settings object for context menus.
object holds the global settings object for DND.
mixed used to store all localization strings.
+
string the name of the theme you want to use.
$.jstree.THEMES_DIR
The location of all themes, this is used when setting a theme without supplying an URL (only by name).
integer amount of pixels required to move before the drag is started.
-
string the name of the theme you want to use.
$.jstree.THEMES_DIR
The location of all themes, this is used when setting a theme without supplying an URL (only by name).
integer amount of pixels required to move before the drag is started.
+
mixed the URL of the stylesheet of the theme you want to use.
-
mixed the URL of the stylesheet of the theme you want to use.
- - - -
$.vakata
object Holds all helper objects.
+
$.vakata
object Holds all helper objects.
string the version of jstree
- + - diff --git a/_docs/javascript/searchdata.js b/_docs/javascript/searchdata.js index 07c9369e..1f86a3a6 100644 --- a/_docs/javascript/searchdata.js +++ b/_docs/javascript/searchdata.js @@ -30,7 +30,7 @@ var indexSectionsWithContent = { "Z": false }, "Variables": { - "Symbols": true, + "Symbols": false, "Numbers": false, "A": false, "B": false, diff --git a/_docs/search/FilesJ.html b/_docs/search/FilesJ.html index d3b2b35c..1d14a64f 100644 --- a/_docs/search/FilesJ.html +++ b/_docs/search/FilesJ.html @@ -11,7 +11,7 @@ -
Loading...
Searching...
No Matches