Skip to content
Snippets Groups Projects
jquery.fancytree-all.js 286 KiB
Newer Older
  • Learn to ignore specific revisions
  • Laura Cappelli's avatar
    Laura Cappelli committed
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
    /*!
     * jquery.fancytree.js
     * Tree view control with support for lazy loading and much more.
     * https://github.com/mar10/fancytree/
     *
     * Copyright (c) 2008-2017, Martin Wendt (http://wwWendt.de)
     * Released under the MIT license
     * https://github.com/mar10/fancytree/wiki/LicenseInfo
     *
     * @version 2.23.0
     * @date 2017-05-27T20:09:38Z
     */
    
    /** Core Fancytree module.
     */
    
    
    // Start of local namespace
    ;(function($, window, document, undefined) {
    "use strict";
    
    // prevent duplicate loading
    if ( $.ui && $.ui.fancytree ) {
    	$.ui.fancytree.warn("Fancytree: ignored duplicate include");
    	return;
    }
    
    
    /* *****************************************************************************
     * Private functions and variables
     */
    
    var i, attr,
    	FT = null, // initialized below
    	TEST_IMG = new RegExp(/\.|\//),  // strings are considered image urls if they contain '.' or '/'
    	REX_HTML = /[&<>"'\/]/g,
    	REX_TOOLTIP = /[<>"'\/]/g,
    	RECURSIVE_REQUEST_ERROR = "$recursive_request",
    	ENTITY_MAP = {"&": "&amp;", "<": "&lt;", ">": "&gt;", "\"": "&quot;", "'": "&#39;", "/": "&#x2F;"},
    	IGNORE_KEYCODES = { 16: true, 17: true, 18: true },
    	SPECIAL_KEYCODES = {
    		8: "backspace", 9: "tab", 10: "return", 13: "return",
    		// 16: null, 17: null, 18: null, // ignore shift, ctrl, alt
    		19: "pause", 20: "capslock", 27: "esc", 32: "space", 33: "pageup",
    		34: "pagedown", 35: "end", 36: "home", 37: "left", 38: "up",
    		39: "right", 40: "down", 45: "insert", 46: "del", 59: ";", 61: "=",
    		96: "0", 97: "1", 98: "2", 99: "3", 100: "4", 101: "5", 102: "6",
    		103: "7", 104: "8", 105: "9", 106: "*", 107: "+", 109: "-", 110: ".",
    		111: "/", 112: "f1", 113: "f2", 114: "f3", 115: "f4", 116: "f5",
    		117: "f6", 118: "f7", 119: "f8", 120: "f9", 121: "f10", 122: "f11",
    		123: "f12", 144: "numlock", 145: "scroll", 173: "-", 186: ";", 187: "=",
    		188: ",", 189: "-", 190: ".", 191: "/", 192: "`", 219: "[", 220: "\\",
    		221: "]", 222: "'"},
    	MOUSE_BUTTONS = { 0: "", 1: "left", 2: "middle", 3: "right" },
    	// Boolean attributes that can be set with equivalent class names in the LI tags
    	// Note: v2.23: checkbox and hideCheckbox are *not* in this list
    	CLASS_ATTRS = "active expanded focus folder lazy radiogroup selected unselectable unselectableIgnore".split(" "),
    	CLASS_ATTR_MAP = {},
    	// Top-level Fancytree node attributes, that can be set by dict
    	NODE_ATTRS = "checkbox expanded extraClasses folder icon key lazy radiogroup refKey selected statusNodeType title tooltip unselectable unselectableIgnore unselectableStatus".split(" "),
    	NODE_ATTR_MAP = {},
    	// Mapping of lowercase -> real name (because HTML5 data-... attribute only supports lowercase)
    	NODE_ATTR_LOWERCASE_MAP = {},
    	// Attribute names that should NOT be added to node.data
    	NONE_NODE_DATA_MAP = {"active": true, "children": true, "data": true, "focus": true};
    
    for(i=0; i<CLASS_ATTRS.length; i++){ CLASS_ATTR_MAP[CLASS_ATTRS[i]] = true; }
    for(i=0; i<NODE_ATTRS.length; i++) {
    	attr = NODE_ATTRS[i];
    	NODE_ATTR_MAP[attr] = true;
    	if( attr !== attr.toLowerCase() ) {
    		NODE_ATTR_LOWERCASE_MAP[attr.toLowerCase()] = attr;
    	}
    }
    
    
    function _assert(cond, msg){
    	// TODO: see qunit.js extractStacktrace()
    	if(!cond){
    		msg = msg ? ": " + msg : "";
    		// consoleApply("assert", [!!cond, msg]);
    		$.error("Fancytree assertion failed" + msg);
    	}
    }
    
    _assert($.ui, "Fancytree requires jQuery UI (http://jqueryui.com)");
    
    function consoleApply(method, args){
    	var i, s,
    		fn = window.console ? window.console[method] : null;
    
    	if(fn){
    		try{
    			fn.apply(window.console, args);
    		} catch(e) {
    			// IE 8?
    			s = "";
    			for( i=0; i<args.length; i++ ) {
    				s += args[i];
    			}
    			fn(s);
    		}
    	}
    }
    
    /*Return true if x is a FancytreeNode.*/
    function _isNode(x){
    	return !!(x.tree && x.statusNodeType !== undefined);
    }
    
    /** Return true if dotted version string is equal or higher than requested version.
     *
     * See http://jsfiddle.net/mar10/FjSAN/
     */
    function isVersionAtLeast(dottedVersion, major, minor, patch){
    	var i, v, t,
    		verParts = $.map($.trim(dottedVersion).split("."), function(e){ return parseInt(e, 10); }),
    		testParts = $.map(Array.prototype.slice.call(arguments, 1), function(e){ return parseInt(e, 10); });
    
    	for( i = 0; i < testParts.length; i++ ){
    		v = verParts[i] || 0;
    		t = testParts[i] || 0;
    		if( v !== t ){
    			return ( v > t );
    		}
    	}
    	return true;
    }
    
    /** Return a wrapper that calls sub.methodName() and exposes
     *  this             : tree
     *  this._local      : tree.ext.EXTNAME
     *  this._super      : base.methodName.call()
     *  this._superApply : base.methodName.apply()
     */
    function _makeVirtualFunction(methodName, tree, base, extension, extName){
    	// $.ui.fancytree.debug("_makeVirtualFunction", methodName, tree, base, extension, extName);
    	// if(rexTestSuper && !rexTestSuper.test(func)){
    	//     // extension.methodName() doesn't call _super(), so no wrapper required
    	//     return func;
    	// }
    	// Use an immediate function as closure
    	var proxy = (function(){
    		var prevFunc = tree[methodName],      // org. tree method or prev. proxy
    			baseFunc = extension[methodName], //
    			_local = tree.ext[extName],
    			_super = function(){
    				return prevFunc.apply(tree, arguments);
    			},
    			_superApply = function(args){
    				return prevFunc.apply(tree, args);
    			};
    
    		// Return the wrapper function
    		return function(){
    			var prevLocal = tree._local,
    				prevSuper = tree._super,
    				prevSuperApply = tree._superApply;
    
    			try{
    				tree._local = _local;
    				tree._super = _super;
    				tree._superApply = _superApply;
    				return  baseFunc.apply(tree, arguments);
    			}finally{
    				tree._local = prevLocal;
    				tree._super = prevSuper;
    				tree._superApply = prevSuperApply;
    			}
    		};
    	})(); // end of Immediate Function
    	return proxy;
    }
    
    /**
     * Subclass `base` by creating proxy functions
     */
    function _subclassObject(tree, base, extension, extName){
    	// $.ui.fancytree.debug("_subclassObject", tree, base, extension, extName);
    	for(var attrName in extension){
    		if(typeof extension[attrName] === "function"){
    			if(typeof tree[attrName] === "function"){
    				// override existing method
    				tree[attrName] = _makeVirtualFunction(attrName, tree, base, extension, extName);
    			}else if(attrName.charAt(0) === "_"){
    				// Create private methods in tree.ext.EXTENSION namespace
    				tree.ext[extName][attrName] = _makeVirtualFunction(attrName, tree, base, extension, extName);
    			}else{
    				$.error("Could not override tree." + attrName + ". Use prefix '_' to create tree." + extName + "._" + attrName);
    			}
    		}else{
    			// Create member variables in tree.ext.EXTENSION namespace
    			if(attrName !== "options"){
    				tree.ext[extName][attrName] = extension[attrName];
    			}
    		}
    	}
    }
    
    
    function _getResolvedPromise(context, argArray){
    	if(context === undefined){
    		return $.Deferred(function(){this.resolve();}).promise();
    	}else{
    		return $.Deferred(function(){this.resolveWith(context, argArray);}).promise();
    	}
    }
    
    
    function _getRejectedPromise(context, argArray){
    	if(context === undefined){
    		return $.Deferred(function(){this.reject();}).promise();
    	}else{
    		return $.Deferred(function(){this.rejectWith(context, argArray);}).promise();
    	}
    }
    
    
    function _makeResolveFunc(deferred, context){
    	return function(){
    		deferred.resolveWith(context);
    	};
    }
    
    
    function _getElementDataAsDict($el){
    	// Evaluate 'data-NAME' attributes with special treatment for 'data-json'.
    	var d = $.extend({}, $el.data()),
    		json = d.json;
    
    	delete d.fancytree; // added to container by widget factory (old jQuery UI)
    	delete d.uiFancytree; // added to container by widget factory
    
    	if( json ) {
    		delete d.json;
    		// <li data-json='...'> is already returned as object (http://api.jquery.com/data/#data-html5)
    		d = $.extend(d, json);
    	}
    	return d;
    }
    
    
    function _escapeHtml(s){
    	return ("" + s).replace(REX_HTML, function(s) {
    		return ENTITY_MAP[s];
    	});
    }
    
    
    function _escapeTooltip(s){
    	return ("" + s).replace(REX_TOOLTIP, function(s) {
    		return ENTITY_MAP[s];
    	});
    }
    
    
    // TODO: use currying
    function _makeNodeTitleMatcher(s){
    	s = s.toLowerCase();
    	return function(node){
    		return node.title.toLowerCase().indexOf(s) >= 0;
    	};
    }
    
    
    function _makeNodeTitleStartMatcher(s){
    	var reMatch = new RegExp("^" + s, "i");
    	return function(node){
    		return reMatch.test(node.title);
    	};
    }
    
    
    /* *****************************************************************************
     * FancytreeNode
     */
    
    
    /**
     * Creates a new FancytreeNode
     *
     * @class FancytreeNode
     * @classdesc A FancytreeNode represents the hierarchical data model and operations.
     *
     * @param {FancytreeNode} parent
     * @param {NodeData} obj
     *
     * @property {Fancytree} tree The tree instance
     * @property {FancytreeNode} parent The parent node
     * @property {string} key Node id (must be unique inside the tree)
     * @property {string} title Display name (may contain HTML)
     * @property {object} data Contains all extra data that was passed on node creation
     * @property {FancytreeNode[] | null | undefined} children Array of child nodes.<br>
     *     For lazy nodes, null or undefined means 'not yet loaded'. Use an empty array
     *     to define a node that has no children.
     * @property {boolean} expanded Use isExpanded(), setExpanded() to access this property.
     * @property {string} extraClasses Additional CSS classes, added to the node's `&lt;span>`.<br>
     *     Note: use `node.add/remove/toggleClass()` to modify.
     * @property {boolean} folder Folder nodes have different default icons and click behavior.<br>
     *     Note: Also non-folders may have children.
     * @property {string} statusNodeType null for standard nodes. Otherwise type of special system node: 'error', 'loading', 'nodata', or 'paging'.
     * @property {boolean} lazy True if this node is loaded on demand, i.e. on first expansion.
     * @property {boolean} selected Use isSelected(), setSelected() to access this property.
     * @property {string} tooltip Alternative description used as hover popup
     */
    function FancytreeNode(parent, obj){
    	var i, l, name, cl;
    
    	this.parent = parent;
    	this.tree = parent.tree;
    	this.ul = null;
    	this.li = null;  // <li id='key' ftnode=this> tag
    	this.statusNodeType = null; // if this is a temp. node to display the status of its parent
    	this._isLoading = false;    // if this node itself is loading
    	this._error = null;         // {message: '...'} if a load error occurred
    	this.data = {};
    
    	// TODO: merge this code with node.toDict()
    	// copy attributes from obj object
    	for(i=0, l=NODE_ATTRS.length; i<l; i++){
    		name = NODE_ATTRS[i];
    		this[name] = obj[name];
    	}
    	// unselectableIgnore and unselectableStatus imply unselectable
    	if( this.unselectableIgnore != null || this.unselectableStatus != null ) {
    		this.unselectable = true;
    	}
    	if( obj.hideCheckbox ) {
    		$.error("'hideCheckbox' node option was removed in v2.23.0: use 'checkbox: false'");
    	}
    	// node.data += obj.data
    	if(obj.data){
    		$.extend(this.data, obj.data);
    	}
    	// copy all other attributes to this.data.NAME
    	for(name in obj){
    		if(!NODE_ATTR_MAP[name] && !$.isFunction(obj[name]) && !NONE_NODE_DATA_MAP[name]){
    			// node.data.NAME = obj.NAME
    			this.data[name] = obj[name];
    		}
    	}
    
    	// Fix missing key
    	if( this.key == null ){ // test for null OR undefined
    		if( this.tree.options.defaultKey ) {
    			this.key = this.tree.options.defaultKey(this);
    			_assert(this.key, "defaultKey() must return a unique key");
    		} else {
    			this.key = "_" + (FT._nextNodeKey++);
    		}
    	} else {
    		this.key = "" + this.key; // Convert to string (#217)
    	}
    
    	// Fix tree.activeNode
    	// TODO: not elegant: we use obj.active as marker to set tree.activeNode
    	// when loading from a dictionary.
    	if(obj.active){
    		_assert(this.tree.activeNode === null, "only one active node allowed");
    		this.tree.activeNode = this;
    	}
    	if( obj.selected ){ // #186
    		this.tree.lastSelectedNode = this;
    	}
    	// TODO: handle obj.focus = true
    
    	// Create child nodes
    	cl = obj.children;
    	if( cl ){
    		if( cl.length ){
    			this._setChildren(cl);
    		} else {
    			// if an empty array was passed for a lazy node, keep it, in order to mark it 'loaded'
    			this.children = this.lazy ? [] : null;
    		}
    	} else {
    		this.children = null;
    	}
    	// Add to key/ref map (except for root node)
    //	if( parent ) {
    	this.tree._callHook("treeRegisterNode", this.tree, true, this);
    //	}
    }
    
    
    FancytreeNode.prototype = /** @lends FancytreeNode# */{
    	/* Return the direct child FancytreeNode with a given key, index. */
    	_findDirectChild: function(ptr){
    		var i, l,
    			cl = this.children;
    
    		if(cl){
    			if(typeof ptr === "string"){
    				for(i=0, l=cl.length; i<l; i++){
    					if(cl[i].key === ptr){
    						return cl[i];
    					}
    				}
    			}else if(typeof ptr === "number"){
    				return this.children[ptr];
    			}else if(ptr.parent === this){
    				return ptr;
    			}
    		}
    		return null;
    	},
    	// TODO: activate()
    	// TODO: activateSilently()
    	/* Internal helper called in recursive addChildren sequence.*/
    	_setChildren: function(children){
    		_assert(children && (!this.children || this.children.length === 0), "only init supported");
    		this.children = [];
    		for(var i=0, l=children.length; i<l; i++){
    			this.children.push(new FancytreeNode(this, children[i]));
    		}
    	},
    	/**
    	 * Append (or insert) a list of child nodes.
    	 *
    	 * @param {NodeData[]} children array of child node definitions (also single child accepted)
    	 * @param {FancytreeNode | string | Integer} [insertBefore] child node (or key or index of such).
    	 *     If omitted, the new children are appended.
    	 * @returns {FancytreeNode} first child added
    	 *
    	 * @see FancytreeNode#applyPatch
    	 */
    	addChildren: function(children, insertBefore){
    		var i, l, pos,
    			origFirstChild = this.getFirstChild(),
    			origLastChild = this.getLastChild(),
    			firstNode = null,
    			nodeList = [];
    
    		if($.isPlainObject(children) ){
    			children = [children];
    		}
    		if(!this.children){
    			this.children = [];
    		}
    		for(i=0, l=children.length; i<l; i++){
    			nodeList.push(new FancytreeNode(this, children[i]));
    		}
    		firstNode = nodeList[0];
    		if(insertBefore == null){
    			this.children = this.children.concat(nodeList);
    		}else{
    			insertBefore = this._findDirectChild(insertBefore);
    			pos = $.inArray(insertBefore, this.children);
    			_assert(pos >= 0, "insertBefore must be an existing child");
    			// insert nodeList after children[pos]
    			this.children.splice.apply(this.children, [pos, 0].concat(nodeList));
    		}
    		if ( origFirstChild && !insertBefore ) {
    			// #708: Fast path -- don't render every child of root, just the new ones!
    			// #723, #729: but only if it's appended to an existing child list
    			for(i=0, l=nodeList.length; i<l; i++) {
    				nodeList[i].render();   // New nodes were never rendered before
    			}
    			// Adjust classes where status may have changed
    			// Has a first child
    			if (origFirstChild !== this.getFirstChild()) {
    				// Different first child -- recompute classes
    				origFirstChild.renderStatus();
    			}
    			if (origLastChild !== this.getLastChild()) {
    				// Different last child -- recompute classes
    				origLastChild.renderStatus();
    			}
    		} else if( !this.parent || this.parent.ul || this.tr ){
    			// render if the parent was rendered (or this is a root node)
    			this.render();
    		}
    		if( this.tree.options.selectMode === 3 ){
    			this.fixSelection3FromEndNodes();
    		}
    		this.triggerModifyChild("add", nodeList.length === 1 ? nodeList[0] : null);
    		return firstNode;
    	},
    	/**
    	 * Add class to node's span tag and to .extraClasses.
    	 *
    	 * @param {string} className class name
    	 *
    	 * @since 2.17
    	 */
    	addClass: function(className){
    		return this.toggleClass(className, true);
    	},
    	/**
    	 * Append or prepend a node, or append a child node.
    	 *
    	 * This a convenience function that calls addChildren()
    	 *
    	 * @param {NodeData} node node definition
    	 * @param {string} [mode=child] 'before', 'after', 'firstChild', or 'child' ('over' is a synonym for 'child')
    	 * @returns {FancytreeNode} new node
    	 */
    	addNode: function(node, mode){
    		if(mode === undefined || mode === "over"){
    			mode = "child";
    		}
    		switch(mode){
    		case "after":
    			return this.getParent().addChildren(node, this.getNextSibling());
    		case "before":
    			return this.getParent().addChildren(node, this);
    		case "firstChild":
    			// Insert before the first child if any
    			var insertBefore = (this.children ? this.children[0] : null);
    			return this.addChildren(node, insertBefore);
    		case "child":
    		case "over":
    			return this.addChildren(node);
    		}
    		_assert(false, "Invalid mode: " + mode);
    	},
    	/**Add child status nodes that indicate 'More...', etc.
    	 *
    	 * This also maintains the node's `partload` property.
    	 * @param {boolean|object} node optional node definition. Pass `false` to remove all paging nodes.
    	 * @param {string} [mode='child'] 'child'|firstChild'
    	 * @since 2.15
    	 */
    	addPagingNode: function(node, mode){
    		var i, n;
    
    		mode = mode || "child";
    		if( node === false ) {
    			for(i=this.children.length-1; i >= 0; i--) {
    				n = this.children[i];
    				if( n.statusNodeType === "paging" ) {
    					this.removeChild(n);
    				}
    			}
    			this.partload = false;
    			return;
    		}
    		node = $.extend({
    			title: this.tree.options.strings.moreData,
    			statusNodeType: "paging",
    			icon: false
    		}, node);
    		this.partload = true;
    		return this.addNode(node, mode);
    	},
    	/**
    	 * Append new node after this.
    	 *
    	 * This a convenience function that calls addNode(node, 'after')
    	 *
    	 * @param {NodeData} node node definition
    	 * @returns {FancytreeNode} new node
    	 */
    	appendSibling: function(node){
    		return this.addNode(node, "after");
    	},
    	/**
    	 * Modify existing child nodes.
    	 *
    	 * @param {NodePatch} patch
    	 * @returns {$.Promise}
    	 * @see FancytreeNode#addChildren
    	 */
    	applyPatch: function(patch) {
    		// patch [key, null] means 'remove'
    		if(patch === null){
    			this.remove();
    			return _getResolvedPromise(this);
    		}
    		// TODO: make sure that root node is not collapsed or modified
    		// copy (most) attributes to node.ATTR or node.data.ATTR
    		var name, promise, v,
    			IGNORE_MAP = { children: true, expanded: true, parent: true }; // TODO: should be global
    
    		for(name in patch){
    			v = patch[name];
    			if( !IGNORE_MAP[name] && !$.isFunction(v)){
    				if(NODE_ATTR_MAP[name]){
    					this[name] = v;
    				}else{
    					this.data[name] = v;
    				}
    			}
    		}
    		// Remove and/or create children
    		if(patch.hasOwnProperty("children")){
    			this.removeChildren();
    			if(patch.children){ // only if not null and not empty list
    				// TODO: addChildren instead?
    				this._setChildren(patch.children);
    			}
    			// TODO: how can we APPEND or INSERT child nodes?
    		}
    		if(this.isVisible()){
    			this.renderTitle();
    			this.renderStatus();
    		}
    		// Expand collapse (final step, since this may be async)
    		if(patch.hasOwnProperty("expanded")){
    			promise = this.setExpanded(patch.expanded);
    		}else{
    			promise = _getResolvedPromise(this);
    		}
    		return promise;
    	},
    	/** Collapse all sibling nodes.
    	 * @returns {$.Promise}
    	 */
    	collapseSiblings: function() {
    		return this.tree._callHook("nodeCollapseSiblings", this);
    	},
    	/** Copy this node as sibling or child of `node`.
    	 *
    	 * @param {FancytreeNode} node source node
    	 * @param {string} [mode=child] 'before' | 'after' | 'child'
    	 * @param {Function} [map] callback function(NodeData) that could modify the new node
    	 * @returns {FancytreeNode} new
    	 */
    	copyTo: function(node, mode, map) {
    		return node.addNode(this.toDict(true, map), mode);
    	},
    	/** Count direct and indirect children.
    	 *
    	 * @param {boolean} [deep=true] pass 'false' to only count direct children
    	 * @returns {int} number of child nodes
    	 */
    	countChildren: function(deep) {
    		var cl = this.children, i, l, n;
    		if( !cl ){
    			return 0;
    		}
    		n = cl.length;
    		if(deep !== false){
    			for(i=0, l=n; i<l; i++){
    				n += cl[i].countChildren();
    			}
    		}
    		return n;
    	},
    	// TODO: deactivate()
    	/** Write to browser console if debugLevel >= 2 (prepending node info)
    	 *
    	 * @param {*} msg string or object or array of such
    	 */
    	debug: function(msg){
    		if( this.tree.options.debugLevel >= 2 ) {
    			Array.prototype.unshift.call(arguments, this.toString());
    			consoleApply("log", arguments);
    		}
    	},
    	/** Deprecated.
    	 * @deprecated since 2014-02-16. Use resetLazy() instead.
    	 */
    	discard: function(){
    		this.warn("FancytreeNode.discard() is deprecated since 2014-02-16. Use .resetLazy() instead.");
    		return this.resetLazy();
    	},
    	/** Remove DOM elements for all descendents. May be called on .collapse event
    	 * to keep the DOM small.
    	 * @param {boolean} [includeSelf=false]
    	 */
    	discardMarkup: function(includeSelf){
    		var fn = includeSelf ? "nodeRemoveMarkup" : "nodeRemoveChildMarkup";
    		this.tree._callHook(fn, this);
    	},
    	/**Find all nodes that match condition (excluding self).
    	 *
    	 * @param {string | function(node)} match title string to search for, or a
    	 *     callback function that returns `true` if a node is matched.
    	 * @returns {FancytreeNode[]} array of nodes (may be empty)
    	 */
    	findAll: function(match) {
    		match = $.isFunction(match) ? match : _makeNodeTitleMatcher(match);
    		var res = [];
    		this.visit(function(n){
    			if(match(n)){
    				res.push(n);
    			}
    		});
    		return res;
    	},
    	/**Find first node that matches condition (excluding self).
    	 *
    	 * @param {string | function(node)} match title string to search for, or a
    	 *     callback function that returns `true` if a node is matched.
    	 * @returns {FancytreeNode} matching node or null
    	 * @see FancytreeNode#findAll
    	 */
    	findFirst: function(match) {
    		match = $.isFunction(match) ? match : _makeNodeTitleMatcher(match);
    		var res = null;
    		this.visit(function(n){
    			if(match(n)){
    				res = n;
    				return false;
    			}
    		});
    		return res;
    	},
    	/* Apply selection state (internal use only) */
    	_changeSelectStatusAttrs: function(state) {
    		var changed = false,
    			opts = this.tree.options,
    			unselectable = FT.evalOption("unselectable", this, this, opts, false),
    			unselectableStatus = FT.evalOption("unselectableStatus", this, this, opts, undefined);
    
    		if( unselectable && unselectableStatus != null ) {
    			state = unselectableStatus;
    		}
    		switch(state){
    		case false:
    			changed = ( this.selected || this.partsel );
    			this.selected = false;
    			this.partsel = false;
    			break;
    		case true:
    			changed = ( !this.selected || !this.partsel );
    			this.selected = true;
    			this.partsel = true;
    			break;
    		case undefined:
    			changed = ( this.selected || !this.partsel );
    			this.selected = false;
    			this.partsel = true;
    			break;
    		default:
    			_assert(false, "invalid state: " + state);
    		}
    		// this.debug("fixSelection3AfterLoad() _changeSelectStatusAttrs()", state, changed);
    		if( changed ){
    			this.renderStatus();
    		}
    		return changed;
    	},
    	/**
    	 * Fix selection status, after this node was (de)selected in multi-hier mode.
    	 * This includes (de)selecting all children.
    	 */
    	fixSelection3AfterClick: function(callOpts) {
    		var flag = this.isSelected();
    
    //		this.debug("fixSelection3AfterClick()");
    
    		this.visit(function(node){
    			node._changeSelectStatusAttrs(flag);
    		});
    		this.fixSelection3FromEndNodes(callOpts);
    	},
    	/**
    	 * Fix selection status for multi-hier mode.
    	 * Only end-nodes are considered to update the descendants branch and parents.
    	 * Should be called after this node has loaded new children or after
    	 * children have been modified using the API.
    	 */
    	fixSelection3FromEndNodes: function(callOpts) {
    		var opts = this.tree.options;
    
    //		this.debug("fixSelection3FromEndNodes()");
    		_assert(opts.selectMode === 3, "expected selectMode 3");
    
    		// Visit all end nodes and adjust their parent's `selected` and `partsel`
    		// attributes. Return selection state true, false, or undefined.
    		function _walk(node){
    			var i, l, child, s, state, allSelected, someSelected, unselIgnore, unselState,
    				children = node.children;
    
    			if( children && children.length ){
    				// check all children recursively
    				allSelected = true;
    				someSelected = false;
    
    				for( i=0, l=children.length; i<l; i++ ){
    					child = children[i];
    					// the selection state of a node is not relevant; we need the end-nodes
    					s = _walk(child);
    					// if( !child.unselectableIgnore ) {
    					unselIgnore = FT.evalOption("unselectableIgnore", child, child, opts, false);
    					if( !unselIgnore ) {
    						if( s !== false ) {
    							someSelected = true;
    						}
    						if( s !== true ) {
    							allSelected = false;
    						}
    					}
    				}
    				state = allSelected ? true : (someSelected ? undefined : false);
    			}else{
    				// This is an end-node: simply report the status
    				unselState = FT.evalOption("unselectableStatus", node, node, opts, undefined);
    				state = ( unselState == null ) ? !!node.selected : !!unselState;
    			}
    			node._changeSelectStatusAttrs(state);
    			return state;
    		}
    		_walk(this);
    
    		// Update parent's state
    		this.visitParents(function(node){
    			var i, l, child, state, unselIgnore, unselState,
    				children = node.children,
    				allSelected = true,
    				someSelected = false;
    
    			for( i=0, l=children.length; i<l; i++ ){
    				child = children[i];
    				unselIgnore = FT.evalOption("unselectableIgnore", child, child, opts, false);
    				if( !unselIgnore ) {
    					unselState = FT.evalOption("unselectableStatus", child,  child, opts, undefined);
    					state = ( unselState == null ) ? !!child.selected : !!unselState;
    					// When fixing the parents, we trust the sibling status (i.e.
    					// we don't recurse)
    					if( state || child.partsel ) {
    						someSelected = true;
    					}
    					if( !state ) {
    						allSelected = false;
    					}
    				}
    			}
    			state = allSelected ? true : (someSelected ? undefined : false);
    			node._changeSelectStatusAttrs(state);
    		});
    	},
    	// TODO: focus()
    	/**
    	 * Update node data. If dict contains 'children', then also replace
    	 * the hole sub tree.
    	 * @param {NodeData} dict
    	 *
    	 * @see FancytreeNode#addChildren
    	 * @see FancytreeNode#applyPatch
    	 */
    	fromDict: function(dict) {
    		// copy all other attributes to this.data.xxx
    		for(var name in dict){
    			if(NODE_ATTR_MAP[name]){
    				// node.NAME = dict.NAME
    				this[name] = dict[name];
    			}else if(name === "data"){
    				// node.data += dict.data
    				$.extend(this.data, dict.data);
    			}else if(!$.isFunction(dict[name]) && !NONE_NODE_DATA_MAP[name]){
    				// node.data.NAME = dict.NAME
    				this.data[name] = dict[name];
    			}
    		}
    		if(dict.children){
    			// recursively set children and render
    			this.removeChildren();
    			this.addChildren(dict.children);
    		}
    		this.renderTitle();
    /*
    		var children = dict.children;
    		if(children === undefined){
    			this.data = $.extend(this.data, dict);
    			this.render();
    			return;
    		}
    		dict = $.extend({}, dict);
    		dict.children = undefined;
    		this.data = $.extend(this.data, dict);
    		this.removeChildren();
    		this.addChild(children);
    */
    	},
    	/** Return the list of child nodes (undefined for unexpanded lazy nodes).
    	 * @returns {FancytreeNode[] | undefined}
    	 */
    	getChildren: function() {
    		if(this.hasChildren() === undefined){ // TODO: only required for lazy nodes?
    			return undefined; // Lazy node: unloaded, currently loading, or load error
    		}
    		return this.children;
    	},
    	/** Return the first child node or null.
    	 * @returns {FancytreeNode | null}
    	 */
    	getFirstChild: function() {
    		return this.children ? this.children[0] : null;
    	},
    	/** Return the 0-based child index.
    	 * @returns {int}
    	 */
    	getIndex: function() {
    //		return this.parent.children.indexOf(this);
    		return $.inArray(this, this.parent.children); // indexOf doesn't work in IE7
    	},
    	/** Return the hierarchical child index (1-based, e.g. '3.2.4').
    	 * @param {string} [separator="."]
    	 * @param {int} [digits=1]
    	 * @returns {string}
    	 */
    	getIndexHier: function(separator, digits) {
    		separator = separator || ".";
    		var s,
    			res = [];
    		$.each(this.getParentList(false, true), function(i, o){
    			s = "" + (o.getIndex() + 1);
    			if( digits ){
    				// prepend leading zeroes
    				s = ("0000000" + s).substr(-digits);
    			}
    			res.push(s);
    		});
    		return res.join(separator);
    	},
    	/** Return the parent keys separated by options.keyPathSeparator, e.g. "id_1/id_17/id_32".
    	 * @param {boolean} [excludeSelf=false]
    	 * @returns {string}
    	 */
    	getKeyPath: function(excludeSelf) {
    		var path = [],
    			sep = this.tree.options.keyPathSeparator;
    		this.visitParents(function(n){
    			if(n.parent){
    				path.unshift(n.key);
    			}
    		}, !excludeSelf);
    		return sep + path.join(sep);
    	},
    	/** Return the last child of this node or null.
    	 * @returns {FancytreeNode | null}
    	 */
    	getLastChild: function() {
    		return this.children ? this.children[this.children.length - 1] : null;
    	},
    	/** Return node depth. 0: System root node, 1: visible top-level node, 2: first sub-level, ... .
    	 * @returns {int}
    	 */
    	getLevel: function() {
    		var level = 0,
    			dtn = this.parent;
    		while( dtn ) {
    			level++;
    			dtn = dtn.parent;
    		}
    		return level;
    	},
    	/** Return the successor node (under the same parent) or null.
    	 * @returns {FancytreeNode | null}
    	 */
    	getNextSibling: function() {
    		// TODO: use indexOf, if available: (not in IE6)
    		if( this.parent ){
    			var i, l,
    				ac = this.parent.children;
    
    			for(i=0, l=ac.length-1; i<l; i++){ // up to length-2, so next(last) = null
    				if( ac[i] === this ){
    					return ac[i+1];
    				}
    			}
    		}
    		return null;
    	},
    	/** Return the parent node (null for the system root node).
    	 * @returns {FancytreeNode | null}
    	 */
    	getParent: function() {
    		// TODO: return null for top-level nodes?
    		return this.parent;
    	},
    	/** Return an array of all parent nodes (top-down).
    	 * @param {boolean} [includeRoot=false] Include the invisible system root node.
    	 * @param {boolean} [includeSelf=false] Include the node itself.
    	 * @returns {FancytreeNode[]}
    	 */
    	getParentList: function(includeRoot, includeSelf) {
    		var l = [],
    			dtn = includeSelf ? this : this.parent;
    		while( dtn ) {
    			if( includeRoot || dtn.parent ){
    				l.unshift(dtn);
    			}
    			dtn = dtn.parent;
    		}
    		return l;
    	},
    	/** Return the predecessor node (under the same parent) or null.
    	 * @returns {FancytreeNode | null}
    	 */
    	getPrevSibling: function() {
    		if( this.parent ){
    			var i, l,
    				ac = this.parent.children;
    
    			for(i=1, l=ac.length; i<l; i++){ // start with 1, so prev(first) = null
    				if( ac[i] === this ){
    					return ac[i-1];
    				}
    			}
    		}
    		return null;
    	},
    	/**
    	 * Return an array of selected descendant nodes.
    	 * @param {boolean} [stopOnParents=false] only return the topmost selected
    	 *     node (useful with selectMode 3)