forked from dragosu/jquery-aciTree
-
Notifications
You must be signed in to change notification settings - Fork 0
/
documentation.html
1696 lines (1515 loc) · 147 KB
/
documentation.html
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
<!DOCTYPE HTML>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>aciTree v4.5.0-rc.10 - A javascript treeview control with jQuery</title>
<meta name="description" content="aciTree javascript treeview API documentation">
<style type="text/css">
html {
height: 100%;
}
html * {
margin:0;
padding:0;
}
body {
color:#036;
font-family:Verdana, Geneva, sans-serif;
font-size:14px;
max-width:900px;
height: 100%;
background-color:#eee;
margin:20px auto 20px auto;
}
a, a:visited {
color:#333;
}
a:hover {
text-decoration:none;
}
.body {
width:100%;
min-height:100%;
}
ul {
list-style:outside;
list-style-type:circle;
margin:20px 0 20px 18px;
}
li {
margin:4px 0 4px 0;
}
h1, h2, h3 {
color:#930;
margin:30px 0 20px 0;
}
h1 {
font-size:1.2em;
}
h2 {
font-size:1.1em;
}
h3 {
font-size:1em;
}
p {
margin-top:10px;
margin-bottom:10px;
}
.api-extensions label {
display:inline-block;
width:270px;
padding-right: 10px;
height:25px;
font-weight:bold;
cursor:pointer;
}
.api-events label {
display:inline-block;
width:140px;
padding-right: 10px;
height:25px;
font-weight:bold;
color:#993300;
}
.api {
padding:10px 0 10px 0;
}
.api>div {
margin:10px 0 10px 0;
opacity:0.9;
}
.api>div:hover>span:first-child {
background-color:#993300;
}
.api>div em {
color:#993300;
font-weight:bold;
}
.api div span {
display:block;
font-weight:bold;
margin:10px 0 10px 0;
}
.api div>span:first-child {
background-color:#003366;
color:#fff;
line-height:30px;
padding-left:10px;
}
.api div>span:first-child>span {
padding-left:10px;
font-style:italic;
font-size:0.9em;
color:#ccc;
}
.api div>span:first-child a {
float:right;
color:#fff;
font-weight:bold;
text-decoration:none;
padding-right:10px;
font-size:12px;
}
.api div span>span {
font-weight:normal;
display:inline;
}
.api div span.where>span {
display:block;
font-weight:bold;
}
.api div span.where {
display:block;
font-weight:normal !important;
padding-left:40px;
}
.api div>span.where {
display:block;
}
.api div ul {
list-style:none;
margin:0;
display:inline;
}
.api div ul>li {
padding-left:40px;
}
.api div ul>li:first-child {
display:inline;
padding-left:0;
}
.api div ul>li:last-child {
padding-left:0;
}
</style>
</head>
<body>
<h1>aciTree API v4.5.0-rc.10</h1>
<p>
Please note: here are listed only the public API methods, you need to
<a href="http://acoderinsights.ro/en/aciTree-tree-view-with-jQuery" target="_blank" title="aciTree home">read</a> about the available init options, the item data
object and his properties and how to listen for the aciTree events before you'll be able to use aciTree.
Try out the <a href="http://acoderinsights.ro/source/aciTree/aciTree.html" target="_blank" title="aciTree demos">demos</a> to understand how to use the API.
</p>
<div class="api">
<span class="toc"><a href="#.addCheckbox" title=".addCheckbox (item, options) ">.addCheckbox - Adds a checkbox element to the item...</a><br><a href="#.addIcon" title=".addIcon (item, options)">.addIcon - Adds/updates the ICON image for item...</a><br><a href="#.addRadio" title=".addRadio (item, options) ">.addRadio - Adds a radio-button element to the item...</a><br><a href="#.after" title=".after (item, options)">.after - Add a new item or a list of items after item...</a><br><a href="#.ajaxLoad" title=".ajaxLoad (item, options)">.ajaxLoad - Loads a node with AJAX (if not already loaded)...</a><br><a href="#.append" title=".append (item, options)">.append - Add one or more childrens to item, the new items are added at the end...</a><br><a href="#.asChild" title=".asChild (item, options) ">.asChild - Moves item so it becomes children of a parent item...</a><br><a href="#.before" title=".before (item, options)">.before - Add a new item or a list of items before item...</a><br><a href="#.blur" title=".blur (item, options) ">.blur - Remove focus from the item.
Notifies...</a><br><a href="#.branch" title=".branch (item, callback, load) ">.branch - Run a callback function for every children of item...</a><br><a href="#.check" title=".check (item, options) ">.check - Set a checkbox or radio-button in the checked state...</a><br><a href="#.checkboxes" title=".checkboxes (items, state) ">.checkboxes - Filter items and return only the items with a checkbox...</a><br><a href="#.children" title=".children (item, branch, hidden)">.children - Returns a list of childrens from item.
</a><br><a href="#.close" title=".close (item, options)">.close - Closes the item node and all his childrens (if requested)...</a><br><a href="#.closeOthers" title=".closeOthers (item, options)">.closeOthers - Closes all other nodes less the item...</a><br><a href="#.columnIndex" title=".columnIndex (props) ">.columnIndex - Returns the column index for a value of props...</a><br><a href="#.columns" title=".columns () ">.columns - Returns the column count.
</a><br><a href="#.deselect" title=".deselect (item, options) ">.deselect - Deselects the item.
Notifies with the...</a><br><a href="#.destroy" title=".destroy (options)">.destroy - Destroys the treeview control, .isLocked will return TRUE from the start until...</a><br><a href="#.disable" title=".disable (item, options)">.disable - Disable the item node.
Notifies with...</a><br><a href="#.disabled" title=".disabled (items)">.disabled - Filter items and return only the disabled items...</a><br><a href="#.edit" title=".edit (item, options) ">.edit - Enters the editable mode.
Notifies...</a><br><a href="#.edited" title=".edited () ">.edited - Returns the edited LI element.
</a><br><a href="#.enable" title=".enable (item, options)">.enable - Enable the item node.
Notifies with...</a><br><a href="#.enabled" title=".enabled (items)">.enabled - Filter items and return only the enabled items...</a><br><a href="#.endEdit" title=".endEdit (options) ">.endEdit - Exits the editable mode (optionally saving the changes)...</a><br><a href="#.filter" title=".filter (item, options) ">.filter - Search & filter the tree items starting from item...</a><br><a href="#.first" title=".first (item, hidden)">.first - Returns the first children of item.
</a><br><a href="#.focus" title=".focus (item, options) ">.focus - Set focus to item.
Notifies with the...</a><br><a href="#.focused" title=".focused () ">.focused - Returns the (virtual) focused LI element.
</a><br><a href="#.getColumn" title=".getColumn (item, index) ">.getColumn - Returns the content of the column for the item by its index...</a><br><a href="#.getIcon" title=".getIcon (item)">.getIcon - Returns the item ICON (or NULL if does not exist)...</a><br><a href="#.getId" title=".getId (item)">.getId - Returns the item ID (or NULL if does not exists)...</a><br><a href="#.getIndex" title=".getIndex (item)">.getIndex - Returns the index starting from 0 for the item (or NULL if does not exists)...</a><br><a href="#.getLabel" title=".getLabel (item)">.getLabel - Returns the text value of item (or NULL if does not exists)...</a><br><a href="#.getWidth" title=".getWidth (index) ">.getWidth - Returns the column width (in pixels).
</a><br><a href="#.hasCheckbox" title=".hasCheckbox (item) ">.hasCheckbox - Returns TRUE if the item has a checkbox.
</a><br><a href="#.hasChildren" title=".hasChildren (item, hidden)">.hasChildren - Returns TRUE if the item has childrens.
</a><br><a href="#.hasFocus" title=".hasFocus () ">.hasFocus - Returns TRUE if the treeview control has the focus.
</a><br><a href="#.hasIcon" title=".hasIcon (item)">.hasIcon - Returns TRUE if item has ICON.
</a><br><a href="#.hasNext" title=".hasNext (item, hidden)">.hasNext - Returns TRUE if there is at least a element after item (belonging to the same...</a><br><a href="#.hasParent" title=".hasParent (item)">.hasParent - Returns TRUE if item has a parent.
</a><br><a href="#.hasPrev" title=".hasPrev (item, hidden)">.hasPrev - Returns TRUE if there is at least a element before item (belonging to the same...</a><br><a href="#.hasRadio" title=".hasRadio (item) ">.hasRadio - Returns TRUE if the item has a radio.
</a><br><a href="#.hasSiblings" title=".hasSiblings (item, hidden)">.hasSiblings - Returns TRUE if item has siblings on the same level (belonging to the same...</a><br><a href="#.hidden" title=".hidden (items)">.hidden - Filter items and return only the hidden items...</a><br><a href="#.hide" title=".hide (item, options)">.hide - Hide the item node and all his childrens...</a><br><a href="#.init" title=".init (options)">.init - Init the treeview control (if not initialized already), .isLocked will return...</a><br><a href="#.inodes" title=".inodes (items, state)">.inodes - Filter items and return only the `inode` items...</a><br><a href="#.isBusy" title=".isBusy (item)">.isBusy - Returns TRUE if the item node is loading.
</a><br><a href="#.isChecked" title=".isChecked (item) ">.isChecked - Returns TRUE if the item is checked.
</a><br><a href="#.isChildren" title=".isChildren (parent, children)">.isChildren - Returns TRUE if children have parent as parent...</a><br><a href="#.isClosed" title=".isClosed (item)">.isClosed - Returns TRUE if the item node is closed.
</a><br><a href="#.isColumn" title=".isColumn (index) ">.isColumn - Returns TRUE if the column is visible.
</a><br><a href="#.isDisabled" title=".isDisabled (item)">.isDisabled - Returns TRUE if the item is disabled.
</a><br><a href="#.isDisabledPath" title=".isDisabledPath (item)">.isDisabledPath - Returns TRUE if any of the item parents are disabled...</a><br><a href="#.isEdited" title=".isEdited (item) ">.isEdited - Returns TRUE if the item is edited right now...</a><br><a href="#.isEnabled" title=".isEnabled (item)">.isEnabled - Returns TRUE if the item is enabled.
</a><br><a href="#.isEnabledPath" title=".isEnabledPath (item)">.isEnabledPath - Returns TRUE if all of the item parents are enabled...</a><br><a href="#.isFirst" title=".isFirst (item, hidden)">.isFirst - Returns TRUE if item is the first item for its parent...</a><br><a href="#.isFocused" title=".isFocused (item) ">.isFocused - Returns TRUE if the item has (virtual) focus...</a><br><a href="#.isHidden" title=".isHidden (item)">.isHidden - Returns TRUE if the item node is hidden.
</a><br><a href="#.isHiddenPath" title=".isHiddenPath (item)">.isHiddenPath - Returns TRUE if the path to item is hidden (a parent node is hidden)...</a><br><a href="#.isImmediateChildren" title=".isImmediateChildren (parent, children)">.isImmediateChildren - Returns TRUE if children have parent as direct parent...</a><br><a href="#.isInode" title=".isInode (item)">.isInode - Returns TRUE if item is a inner node (has childrens)...</a><br><a href="#.isItem" title=".isItem (item)">.isItem - Returns TRUE if item is a valid item.
</a><br><a href="#.isLast" title=".isLast (item, hidden)">.isLast - Returns TRUE if item is the last item for its parent...</a><br><a href="#.isLeaf" title=".isLeaf (item)">.isLeaf - Returns TRUE if item is a leaf node (does not have any childrens)...</a><br><a href="#.isLocked" title=".isLocked ()">.isLocked - Returns TRUE if the treeview control is in the init or destroy operation...</a><br><a href="#.isOpen" title=".isOpen (item)">.isOpen - Returns TRUE if the item node is opened.
</a><br><a href="#.isOpenPath" title=".isOpenPath (item)">.isOpenPath - Returns TRUE if the path to item is open (all the parent nodes are open)...</a><br><a href="#.isPersist" title=".isPersist () ">.isPersist - Returns TRUE if there is any saved data.
</a><br><a href="#.isSelected" title=".isSelected (item) ">.isSelected - Returns TRUE if the item is selected.
</a><br><a href="#.isTristate" title=".isTristate (item) ">.isTristate - Returns TRUE if the item is tristate.
</a><br><a href="#.isVisible" title=".isVisible (item)">.isVisible - Returns TRUE if item is visible (if all parent nodes are opened and the item...</a><br><a href="#.itemData" title=".itemData (item)">.itemData - Returns the related item (updated) properties as defined in the JSON...</a><br><a href="#.itemFrom" title=".itemFrom (element)">.itemFrom - Returns the LI that contains the element.
</a><br><a href="#.last" title=".last (item, hidden)">.last - Returns the last children of item.
</a><br><a href="#.leaves" title=".leaves (items)">.leaves - Filter items and return only the leaf items...</a><br><a href="#.level" title=".level (item)">.level - Returns the item level starting from 0 for the ones in ROOT (or -1 if does not...</a><br><a href="#.loadFrom" title=".loadFrom (item, options)">.loadFrom - Loads a node from a JavaScript variable (if not already loaded)...</a><br><a href="#.moveAfter" title=".moveAfter (item, options) ">.moveAfter - Move item after a specific item...</a><br><a href="#.moveBefore" title=".moveBefore (item, options) ">.moveBefore - Move item before a specific item...</a><br><a href="#.moveDown" title=".moveDown (item, options) ">.moveDown - Move item down with a position (inside the same parent)...</a><br><a href="#.moveFirst" title=".moveFirst (item, options) ">.moveFirst - Move item at the beginning (inside the same parent)...</a><br><a href="#.moveLast" title=".moveLast (item, options) ">.moveLast - Move item at the end (inside the same parent)...</a><br><a href="#.moveUp" title=".moveUp (item, options) ">.moveUp - Move item up with a position (inside the same parent)...</a><br><a href="#.next" title=".next (item, hidden)">.next - Returns the next element from item (belonging to the same parent)...</a><br><a href="#.nextMatch" title=".nextMatch (item, search, callback) ">.nextMatch - Search for a match starting with the item after item...</a><br><a href="#.open" title=".open (item, options)">.open - Opens the item node and all his childrens (if requested)...</a><br><a href="#.openPath" title=".openPath (item, options)">.openPath - Opens the entire path till item...</a><br><a href="#.option" title=".option (option, value)">.option - Set a option at runtime (after init).
</a><br><a href="#.options" title=".options ()">.options - Returns the init options (including any new value assigned with option)...</a><br><a href="#.parent" title=".parent (item)">.parent - Returns the parent of item.
</a><br><a href="#.path" title=".path (item, reverse)">.path - Returns a list of parent items till item (starting from ROOT)...</a><br><a href="#.pathId" title=".pathId (item, reverse) ">.pathId - Returns a list of parent IDs till item (starting from ROOT)...</a><br><a href="#.prev" title=".prev (item, hidden)">.prev - Returns the previous element from item (belonging to the same parent)...</a><br><a href="#.prevMatch" title=".prevMatch (item, search, callback) ">.prevMatch - Search for a match starting with the item before item...</a><br><a href="#.radios" title=".radios (items, state) ">.radios - Filter items and return only the items with a radio-button...</a><br><a href="#.remove" title=".remove (item, options)">.remove - Remove item (including the childrens)...</a><br><a href="#.removeCheckbox" title=".removeCheckbox (item, options) ">.removeCheckbox - Remove a checkbox element from the item...</a><br><a href="#.removeIcon" title=".removeIcon (item, options)">.removeIcon - Remove the ICON image for item...</a><br><a href="#.removeRadio" title=".removeRadio (item, options) ">.removeRadio - Remove a radio-button element from the item...</a><br><a href="#.sameParent" title=".sameParent (item1, item2)">.sameParent - Returns TRUE if item1 and item2 have the same direct parent...</a><br><a href="#.sameTopParent" title=".sameTopParent (item1, item2)">.sameTopParent - Returns TRUE if item1 and item2 have the same parent on level 0...</a><br><a href="#.search" title=".search (item, options) ">.search - Searches the elements with an ID or a custom property...</a><br><a href="#.searchId" title=".searchId (path, load, options) ">.searchId - Searches and returns the LI element with a ID...</a><br><a href="#.searchPath" title=".searchPath (path, load, options) ">.searchPath - Searches a LI element based on a list of IDs...</a><br><a href="#.select" title=".select (item, options) ">.select - Selects the item.
Notifies with the...</a><br><a href="#.selected" title=".selected () ">.selected - Returns the selected LI element(s).
</a><br><a href="#.serialize" title=".serialize (item, what, callback) ">.serialize - Returns a serialized value depending on the what option...</a><br><a href="#.setColumn" title=".setColumn (item, options) ">.setColumn - Set the item column content.
Notifies...</a><br><a href="#.setId" title=".setId (item, options)">.setId - Set the item ID.
Notifies with the...</a><br><a href="#.setIndex" title=".setIndex (item, options)">.setIndex - Set the item index.
Notifies with the...</a><br><a href="#.setInode" title=".setInode (item, options)">.setInode - Transforms item in a inner node...</a><br><a href="#.setLabel" title=".setLabel (item, options)">.setLabel - Set the item text content.
Notifies...</a><br><a href="#.setLeaf" title=".setLeaf (item, options)">.setLeaf - Transforms item in a leaf node...</a><br><a href="#.setVisible" title=".setVisible (item, options)">.setVisible - Brings item into the view...</a><br><a href="#.setWidth" title=".setWidth (index, width) ">.setWidth - Set the column width (in pixels).
</a><br><a href="#.show" title=".show (item, options)">.show - Show a hidden item.
Notifies with the...</a><br><a href="#.siblings" title=".siblings (item, hidden)">.siblings - Returns a list of item siblings (belonging to the same parent)...</a><br><a href="#.swap" title=".swap (options) ">.swap - Exchanges two items (the items can't be children and parent)...</a><br><a href="#.toggle" title=".toggle (item, options)">.toggle - Opens or closes the item node...</a><br><a href="#.toggleColumn" title=".toggleColumn (index, show) ">.toggleColumn - Show or hide a column.
</a><br><a href="#.topParent" title=".topParent (item)">.topParent - Returns the parent on the level 0 for item...</a><br><a href="#.tristate" title=".tristate (items) ">.tristate - Filter items and return only the tristate items...</a><br><a href="#.uncheck" title=".uncheck (item, options) ">.uncheck - Set a checkbox or radio-button in the unchecked state...</a><br><a href="#.unload" title=".unload (item, options)">.unload - Removes all the item childrens...</a><br><a href="#.unpersist" title=".unpersist () ">.unpersist - Removes the save data (if there is any).
</a><br><a href="#.visible" title=".visible (items, view)">.visible - Filter items and return only the visible items (the items with all parent...</a><br><a href="#.wasInit" title=".wasInit ()">.wasInit - Returns TRUE if the treeview control was initialized.
</a><br><a href="#.wasLoad" title=".wasLoad (item)">.wasLoad - Returns TRUE if item was loaded.
</a><br></span>
<a name=".addCheckbox"></a><div data-ext="checkbox extension" style="display: block;"><span>.addCheckbox (item, options) <span>checkbox extension</span><a href="#" title="Top">^</a></span> Adds a checkbox element to the <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to be changed
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
Notifies with the <em>checkboxadded</em> event if the checkbox was added, with <em>wascheckbox</em> if the item was already of the checkbox
type and with <em>addcheckboxfail</em> if the operation failed.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with
<em>beforeaddcheckbox</em>.
</div>
<a name=".addIcon"></a><div data-ext="core" style="display: block;"><span>.addIcon (item, options)<a href="#" title="Top">^</a></span> Adds/updates the <i>ICON</i> image for <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to be changed
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options),</li><li> icon: (string) CSS class name or Array(CSS class, background-position-x, background-position-y)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation
succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
The <i>options</i> object sent to <b>success</b> and <b>fail</b> functions will contain the following new properties: <br>
<b>options.oldIcon</b> - the old ICON (or NULL if had not existed).
</span>
Notifies with the <em>iconadded</em> event when adding/updating the icon, <em>wasicon</em> if the ICON was set already
and with <em>addiconfail</em> when the operation failed.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with
<em>beforeaddicon</em>.
</div>
<a name=".addRadio"></a><div data-ext="radio extension" style="display: block;"><span>.addRadio (item, options) <span>radio extension</span><a href="#" title="Top">^</a></span> Adds a radio-button element to the <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to be changed
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
Notifies with the <em>radioadded</em> event if the radio-button was added, with <em>wasradio</em> event if the item was already of the radio-button
type and with <em>addradiofail</em> if the operation failed.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with
<em>beforeaddradio</em>.
</div>
<a name=".after"></a><div data-ext="core" style="display: block;"><span>.after (item, options)<a href="#" title="Top">^</a></span> Add a new item or a list of items after <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> after which the new elements are added
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options),</li><li> itemData: <ul><li>(object) { <b>itemData</b> } or</li><li> (array) [ (object) { <b>itemData</b> }, ... ]</li></ul></li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
The <i>options</i> object sent to <b>success</b> and <b>fail</b> functions will contain the following new properties:<br>
<b>options.items</b> - a list of <i>LI</i> elements (the new added ones).<br>
<b>options.itemData</b> can be an array of objects to add many items at once. <b>.after</b> adds only one level, if you want to add childrens to the new nodes -
you can use <b>.loadFrom</b> (or they will be loaded by default when the nodes will be opened, using <b>.ajaxLoad</b>).
</span>
<b>.after</b> calls <b>options.itemHook</b> init option for each item and notifies regarding the add (after changing the DOM) with the <em>added</em> event.
Notifies with the <em>appended</em> and <em>appendfail</em> events if the operation was successful or not. The operation can be canceled by
returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with <em>beforeafter</em>.
</div>
<a name=".ajaxLoad"></a><div data-ext="core" style="display: block;"><span>.ajaxLoad (item, options)<a href="#" title="Top">^</a></span> Loads a node with AJAX (if not already loaded).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> node to be loaded (or <i>NULL</i> for ROOT)
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options),</li><li> unanimated: (boolean) if <i>TRUE</i> then no animations will be used</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
The loading with AJAX take place when the nodes are opened for the first time. <b>.ajaxLoad</b> can be called to force
loading a node. The node need to be of type <i>inode</i> and not already loaded. If the node was loaded and you want to reload it -
you'll need to call <b>.unload</b> before calling <b>.ajaxLoad</b>.
The JSON data is requested from the address configured in the init options <b>options.ajax.url</b> and adding the ID of the node to be loaded at the end.
Are added as many levels as defined in the JSON. Each item's data is stored and can be accessed with <b>.itemData</b>.
<b>Note</b>: if the operation fails then the node will be made of type <i>leaf</i> by default.
</span>
<b>.ajaxLoad</b> calls <b>.append</b> for adding the items.
Notifies with the <em>loaded</em> and <em>loadfail</em> events if the operation was successful or not and with the <em>wasloaded</em>
if the node was loaded already. The operation can be canceled by
returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with <em>beforeload</em>.<br>
See <b>.loadFrom</b> for loading from a JavaScript variable (instead of AJAX).
</div>
<a name=".append"></a><div data-ext="core" style="display: block;"><span>.append (item, options)<a href="#" title="Top">^</a></span> Add one or more childrens to <b>item</b>, the new items are added at the end.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to add the childrens to (or <i>NULL</i> for ROOT)
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options),</li><li> itemData: <ul><li>(object) { <b>itemData</b> } or</li><li> (array) [ (object) { <b>itemData</b> }, ... ]</li></ul></li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
The <i>options</i> object sent to <b>success</b> and <b>fail</b> functions will contain the following new properties:<br>
<b>options.items</b> - a list of <i>LI</i> elements (the new added ones).<br>
<b>options.itemData</b> can be an array of objects to add many items at once. <b>.append</b> adds only one level, if you want to add childrens to the new nodes -
you can use <b>.loadFrom</b> (or they will be loaded by default when the nodes will be opened, using <b>.ajaxLoad</b>).
</span>
<b>.append</b> calls <b>options.itemHook</b> init option for each item and notifies regarding the add (after the DOM is changed) with the <em>added</em> event.
Notifies with the <em>appended</em> and <em>appendfail</em> events if the operation was successful or not. The operation can be canceled by
returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with <em>beforeappend</em>.
</div>
<a name=".asChild"></a><div data-ext="utils extension" style="display: block;"><span>.asChild (item, options) <span>utils extension</span><a href="#" title="Top">^</a></span> Moves <b>item</b> so it becomes children of a parent item.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options),</li><li> parent: (jQuery object) the parent item</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
<b>asChild</b> set the item as a children only for empty parents (elements without childrens). If the parent item is of type <i>leaf</i> then <b>.setInode</b> is called.
</span>
Notifies with the <em>childset</em> and <em>childfail</em> events if the operation was successful or not. The operation can be canceled by
returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with <em>beforechild</em>.
</div>
<a name=".before"></a><div data-ext="core" style="display: block;"><span>.before (item, options)<a href="#" title="Top">^</a></span> Add a new item or a list of items before <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> before which the new elements are added
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options),</li><li> itemData: <ul><li>(object) { <b>itemData</b> } or</li><li> (array) [ (object) { <b>itemData</b> }, ... ]</li></ul></li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
The <i>options</i> object sent to <b>success</b> and <b>fail</b> functions will contain the following new properties:<br>
<b>options.items</b> - a list of <i>LI</i> elements (the new added ones).<br>
<b>options.itemData</b> can be an array of objects to add many items at once. <b>.before</b> adds only one level, if you want to add childrens to the new nodes -
you can use <b>.loadFrom</b> (or they will be loaded by default when the nodes will be opened, using <b>.ajaxLoad</b>).
</span>
<b>.before</b> calls <b>options.itemHook</b> init option for each item and notifies regarding the add (after the DOM is changed) with the <em>added</em> event.
Notifies with the <em>before</em> and <em>beforefail</em> events if the operation was successful or not. The operation can be canceled by
returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with <em>beforebefore</em>.
</div>
<a name=".blur"></a><div data-ext="selectable extension" style="display: block;"><span>.blur (item, options) <span>selectable extension</span><a href="#" title="Top">^</a></span> Remove focus from the <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to be changed
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
Notifies with the <em>blur</em> and <em>blurfail</em> events if the operation succeeded or not and with
the <em>notfocused</em> event if the item did not had focus.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with
<em>beforeblur</em>.
</div>
<a name=".branch"></a><div data-ext="utils extension" style="display: block;"><span>.branch (item, callback, load) <span>utils extension</span><a href="#" title="Top">^</a></span> Run a callback function for every children of <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the parent <i>LI</i> (or <i>NULL</i> for ROOT)
<span>callback<span> function (item)</span></span>
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
</span>
<span>load<span> (boolean) if <i>TRUE</i> then all - not yet loaded - nodes will be loaded and the
<i>callback</i> will be run for their childrens too</span></span>
Inside the callback function you can access the aciTree API with <b>this</b> keyword.
</span>
<b>.branch</b> calls <b>.ajaxLoad</b> when it needs to load a node.
</div>
<a name=".check"></a><div data-ext2="radio extension" data-ext1="checkbox extension" data-ext="checkbox/radio extension" style="display: block;"><span>.check (item, options) <span>checkbox/radio extension</span><a href="#" title="Top">^</a></span> Set a checkbox or radio-button in the checked state.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
Notifies with the <em>checked</em> and <em>checkfail</em> events if the operation succeeded or not and with the
<em>waschecked</em> event if the item was already checked. The operation can be canceled by
returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with <em>beforecheck</em>.
</div>
<a name=".checkboxes"></a><div data-ext="checkbox extension" style="display: block;"><span>.checkboxes (items, state) <span>checkbox extension</span><a href="#" title="Top">^</a></span> Filter <b>items</b> and return only the items with a checkbox.
<span class="where">
where:
<span>items<span> jQuery object</span></span> a list of <i>LI</i> elements
<span>state<span> (boolean)</span></span> if set, returns only the elements in the checked/unchecked state (TRUE/FALSE)
</span>
</div>
<a name=".children"></a><div data-ext="core" style="display: block;"><span>.children (item, branch, hidden)<a href="#" title="Top">^</a></span> Returns a list of childrens from <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the parent <i>LI</i> (or <i>NULL</i> for ROOT)
<span>branch<span> (boolean)</span></span> if <i>TRUE</i> then all <b>item</b> childrens are returned (not only
the direct ones)
<span>hidden<span> (boolean)</span></span> if <i>TRUE</i> then the hidden elements will be considered too
</span>
</div>
<a name=".close"></a><div data-ext="core" style="display: block;"><span>.close (item, options)<a href="#" title="Top">^</a></span> Closes the <b>item</b> node and all his childrens (if requested).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to be closed
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options),</li><li> collapse: (boolean) if <i>TRUE</i> then all childrens will be closed too,</li><li> unanimated: (boolean) if <i>TRUE</i> then no animations will be used</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
If the initialization option <b>options.empty</b> is <b>TRUE</b> then all childrens are removed (<b>.unload</b> will be called).
Notifies with the <em>closed</em> and <em>closefail</em> events if the operation was successful or not and with <em>wasclosed</em> if was closed already.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with <em>beforeclose</em>.
</div>
<a name=".closeOthers"></a><div data-ext="core" style="display: block;"><span>.closeOthers (item, options)<a href="#" title="Top">^</a></span> Closes all other nodes less the <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to remain open
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options),</li><li> unanimated: (boolean) if <i>TRUE</i> then no animations will be used</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
<b>.closeOthers</b> calls <b>.close</b> to close all needed nodes.
</div>
<a name=".columnIndex"></a><div data-ext="column extension" style="display: block;"><span>.columnIndex (props) <span>column extension</span><a href="#" title="Top">^</a></span> Returns the column index for a value of <b>props</b>.
<span class="where">
where:
<span>props<span> (string)</span></span> the <i>props</i> value used in <i>options.columnData</i>
</span>
</div>
<a name=".columns"></a><div data-ext="column extension" style="display: block;"><span>.columns () <span>column extension</span></span> Returns the column count.
</div>
<a name=".deselect"></a><div data-ext="selectable extension" style="display: block;"><span>.deselect (item, options) <span>selectable extension</span><a href="#" title="Top">^</a></span> Deselects the <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to be deselected
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
Notifies with the <em>deselected</em> and <em>deselectfail</em> events if the operation succeeded or not and with
the <em>notselected</em> event if the item was not selected.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with
<em>beforedeselect</em>.
</div>
<a name=".destroy"></a><div data-ext="core" style="display: block;"><span>.destroy (options)<a href="#" title="Top">^</a></span> Destroys the treeview control, <b>.isLocked</b> will return <i>TRUE</i> from the start until the end of the operation.
<span class="where">
where:
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
<b>.destroy</b> calls <b>.unload</b> for ROOT and notifies with the <em>notinit</em> event if the treeview control was not initialized yet.
Notifies with the <em>destroyed</em> and <em>destroyfail</em> events if the operation was successful or not.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with <em>beforedestroy</em>.
</div>
<a name=".disable"></a><div data-ext="core" style="display: block;"><span>.disable (item, options)<a href="#" title="Top">^</a></span> Disable the <b>item</b> node.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to be disabled
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
Notifies with the <em>disabled</em> and <em>disablefail</em> events if the operation was successful or not and with <em>wasdisabled</em> if the node
was already disabled.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with
<em>beforedisable</em>.
</div>
<a name=".disabled"></a><div data-ext="core" style="display: block;"><span>.disabled (items)<a href="#" title="Top">^</a></span> Filter <b>items</b> and return only the disabled items.
<span class="where">
where:
<span>items<span> jQuery object</span></span> a list of <i>LI</i> elements
</span>
</div>
<a name=".edit"></a><div data-ext="editable extension" style="display: block;"><span>.edit (item, options) <span>editable extension</span><a href="#" title="Top">^</a></span> Enters the editable mode.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to be edited
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
Notifies with the <em>edit</em> when it enters the edit mode, with <em>wasedit</em> if was in the edit mode already and
with <em>editfail</em> if the operation failed.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with <em>beforeedit</em>.
</div>
<a name=".edited"></a><div data-ext="editable extension" style="display: block;"><span>.edited () <span>editable extension</span></span> Returns the edited <i>LI</i> element.
</div>
<a name=".enable"></a><div data-ext="core" style="display: block;"><span>.enable (item, options)<a href="#" title="Top">^</a></span> Enable the <b>item</b> node.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to be enabled
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
Notifies with the <em>enabled</em> and <em>enablefail</em> events if the operation was successful or not and with <em>wasenabled</em> if the node
was already enabled.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with
<em>beforeenable</em>.
</div>
<a name=".enabled"></a><div data-ext="core" style="display: block;"><span>.enabled (items)<a href="#" title="Top">^</a></span> Filter <b>items</b> and return only the enabled items.
<span class="where">
where:
<span>items<span> jQuery object</span></span> a list of <i>LI</i> elements
</span>
</div>
<a name=".endEdit"></a><div data-ext="editable extension" style="display: block;"><span>.endEdit (options) <span>editable extension</span><a href="#" title="Top">^</a></span> Exits the editable mode (optionally saving the changes).
<span class="where">
where:
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options),</li><li> save: (boolean) if <i>FALSE</i> then any changes made will not be saved</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
<b>.endEdit</b> calls <b>.setLabel</b> to save the changes.
Notifies with the <em>edited</em> when changes are saved, <em>endedit</em> when it exits from the edit mode without saving the changes
and with <em>endeditfail</em> if the operation failed.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with <em>beforeendedit</em>.
</div>
<a name=".filter"></a><div data-ext="utils extension" style="display: block;"><span>.filter (item, options) <span>utils extension</span><a href="#" title="Top">^</a></span> Search & filter the tree items starting from <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the parent <i>LI</i> to start from (NULL to start from ROOT)
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options),</li><li> search: (string) the searched value</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation
succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
The <i>options</i> object sent to <b>success</b> and <b>fail</b> functions will contain the following new properties: <br>
<b>options.first</b> - the first found item (if any).
<b>Note</b>: the returned first found item it's not in the tree branch order, use <b>.prevMatch</b> and/or <b>.nextMatch</b>
to search and get items in branch order.
</span>
<b>.filter</b> calls <b>options.filterHook</b> init option for each item and
notifies with the <em>filtered</em> and <em>filterfail</em> events if the operation was successful or not.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with
<em>beforefilter</em>.
</div>
<a name=".first"></a><div data-ext="core" style="display: block;"><span>.first (item, hidden)<a href="#" title="Top">^</a></span> Returns the first children of <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the parent <i>LI</i> (or <i>NULL</i> for ROOT)
<span>hidden<span> (boolean)</span></span> if <i>TRUE</i> then the hidden elements will be considered too
</span>
</div>
<a name=".focus"></a><div data-ext="selectable extension" style="display: block;"><span>.focus (item, options) <span>selectable extension</span><a href="#" title="Top">^</a></span> Set focus to <b>item</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to be focused
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
The <i>options</i> object sent to <b>success</b> and <b>fail</b> functions will contain the following new properties: <br>
<b>options.oldFocused</b> - the previous item with focus.
</span>
Notifies with the <em>focus</em> and <em>focusfail</em> events if the operation succeeded or not and with the
<em>wasfocused</em> if the item already had focus.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with
<em>beforefocus</em>.
</div>
<a name=".focused"></a><div data-ext="selectable extension" style="display: block;"><span>.focused () <span>selectable extension</span></span> Returns the (virtual) focused <i>LI</i> element.
</div>
<a name=".getColumn"></a><div data-ext="column extension" style="display: block;"><span>.getColumn (item, index) <span>column extension</span><a href="#" title="Top">^</a></span> Returns the content of the column for the <b>item</b> by its <b>index</b>.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
<span>index<span> (numeric)</span></span> the column index (0 based)
</span>
</div>
<a name=".getIcon"></a><div data-ext="core" style="display: block;"><span>.getIcon (item)<a href="#" title="Top">^</a></span> Returns the <b>item</b> ICON (or NULL if does not exist).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
Can return a string or array (depending on the init value).
</div>
<a name=".getId"></a><div data-ext="core" style="display: block;"><span>.getId (item)<a href="#" title="Top">^</a></span> Returns the <b>item</b> ID (or NULL if does not exists).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".getIndex"></a><div data-ext="core" style="display: block;"><span>.getIndex (item)<a href="#" title="Top">^</a></span> Returns the index starting from 0 for the <b>item</b> (or NULL if does not exists).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".getLabel"></a><div data-ext="core" style="display: block;"><span>.getLabel (item)<a href="#" title="Top">^</a></span> Returns the text value of <b>item</b> (or NULL if does not exists).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".getWidth"></a><div data-ext="column extension" style="display: block;"><span>.getWidth (index) <span>column extension</span><a href="#" title="Top">^</a></span> Returns the column width (in pixels).
<span class="where">
where:
<span>index<span> (numeric)</span></span> the column index (0 based)
</span>
</div>
<a name=".hasCheckbox"></a><div data-ext="checkbox extension" style="display: block;"><span>.hasCheckbox (item) <span>checkbox extension</span><a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> has a checkbox.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".hasChildren"></a><div data-ext="core" style="display: block;"><span>.hasChildren (item, hidden)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> has childrens.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> (or <i>NULL</i> for ROOT)
<span>hidden<span> (boolean)</span></span> if <i>TRUE</i> then the hidden elements will be considered too
</span>
</div>
<a name=".hasFocus"></a><div data-ext="selectable extension" style="display: block;"><span>.hasFocus () <span>selectable extension</span></span> Returns <i>TRUE</i> if the treeview control has the focus.
</div>
<a name=".hasIcon"></a><div data-ext="core" style="display: block;"><span>.hasIcon (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if <b>item</b> has ICON.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".hasNext"></a><div data-ext="core" style="display: block;"><span>.hasNext (item, hidden)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if there is at least a element after <b>item</b> (belonging to the same parent).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
<span>hidden<span> (boolean)</span></span> if <i>TRUE</i> then the hidden elements will be considered too
</span>
</div>
<a name=".hasParent"></a><div data-ext="core" style="display: block;"><span>.hasParent (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if <b>item</b> has a parent.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".hasPrev"></a><div data-ext="core" style="display: block;"><span>.hasPrev (item, hidden)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if there is at least a element before <b>item</b> (belonging to the same parent).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
<span>hidden<span> (boolean)</span></span> if <i>TRUE</i> then the hidden elements will be considered too
</span>
</div>
<a name=".hasRadio"></a><div data-ext="radio extension" style="display: block;"><span>.hasRadio (item) <span>radio extension</span><a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> has a radio.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".hasSiblings"></a><div data-ext="core" style="display: block;"><span>.hasSiblings (item, hidden)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if <b>item</b> has siblings on the same level (belonging to the same parent).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
<span>hidden<span> (boolean)</span></span> if <i>TRUE</i> then the hidden elements will be considered too
</span>
</div>
<a name=".hidden"></a><div data-ext="core" style="display: block;"><span>.hidden (items)<a href="#" title="Top">^</a></span> Filter <b>items</b> and return only the hidden items.
<span class="where">
where:
<span>items<span> jQuery object</span></span> a list of <i>LI</i> elements
</span>
</div>
<a name=".hide"></a><div data-ext="core" style="display: block;"><span>.hide (item, options)<a href="#" title="Top">^</a></span> Hide the <b>item</b> node and all his childrens.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> to be hidden
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
Notifies with the <em>hidden</em> and <em>hidefail</em> events if the operation was successful or not and with <em>washidden</em> if the node
was already hidden.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with
<em>beforehide</em>.
</div>
<a name=".init"></a><div data-ext="core" style="display: block;"><span>.init (options)<a href="#" title="Top">^</a></span> Init the treeview control (if not initialized already), <b>.isLocked</b> will return <i>TRUE</i> from the start until the end of the operation.
<span class="where">
where:
<span>options<span> <ul><li>object {</li><li> success: function (item, options),</li><li> fail: function (item, options)</li><li> }</li></ul></span></span> the callback function <b>success</b> is called if the operation succeeded and <b>fail</b> if failed, you can access the aciTree API with <b>this</b> keyword.
<span class="where">where:
<span>item<span> the <i>LI</i></span></span>
<span>options<span> the initial <i>options</i> parameter</span></span>
</span>
</span>
<b>.init</b> calls <b>.loadFrom</b> or <b>.ajaxLoad</b> depending on the init options and notifies with the <em>wasinit</em> event
if was initialized already.
Notifies with the <em>init</em> and <em>initfail</em> events if the operation was successful or not.
The operation can be canceled by returning <b>FALSE</b> from the event handler when <b>eventName</b> is equal with <em>beforeinit</em>.
</div>
<a name=".inodes"></a><div data-ext="core" style="display: block;"><span>.inodes (items, state)<a href="#" title="Top">^</a></span> Filter <b>items</b> and return only the `inode` items.
<span class="where">
where:
<span>items<span> jQuery object</span></span> a list of <i>LI</i> elements
<span>state<span> (boolean)</span></span> if set, returns only the nodes in the open/closed state (TRUE/FALSE)
</span>
</div>
<a name=".isBusy"></a><div data-ext="core" style="display: block;"><span>.isBusy (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> node is loading.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i> (or <i>NULL</i> for ROOT)
</span>
</div>
<a name=".isChecked"></a><div data-ext2="radio extension" data-ext1="checkbox extension" data-ext="checkbox/radio extension" style="display: block;"><span>.isChecked (item) <span>checkbox/radio extension</span><a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> is checked.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isChildren"></a><div data-ext="core" style="display: block;"><span>.isChildren (parent, children)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if <b>children</b> have <b>parent</b> as parent.
<span class="where">
where:
<span>parent<span> jQuery object</span></span> the parent <i>LI</i>
<span>children<span> jQuery object</span></span> the children <i>LI</i>
</span>
</div>
<a name=".isClosed"></a><div data-ext="core" style="display: block;"><span>.isClosed (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> node is closed.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isColumn"></a><div data-ext="column extension" style="display: block;"><span>.isColumn (index) <span>column extension</span><a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the column is visible.
<span class="where">
where:
<span>index<span> (numeric)</span></span> the column index (0 based)
</span>
</div>
<a name=".isDisabled"></a><div data-ext="core" style="display: block;"><span>.isDisabled (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> is disabled.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isDisabledPath"></a><div data-ext="core" style="display: block;"><span>.isDisabledPath (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if any of the <b>item</b> parents are disabled.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isEdited"></a><div data-ext="editable extension" style="display: block;"><span>.isEdited (item) <span>editable extension</span><a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> is edited right now.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isEnabled"></a><div data-ext="core" style="display: block;"><span>.isEnabled (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> is enabled.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isEnabledPath"></a><div data-ext="core" style="display: block;"><span>.isEnabledPath (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if all of the <b>item</b> parents are enabled.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isFirst"></a><div data-ext="core" style="display: block;"><span>.isFirst (item, hidden)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if <b>item</b> is the first item for its parent.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
<span>hidden<span> (boolean)</span></span> if <i>TRUE</i> then the hidden elements will be considered too
</span>
</div>
<a name=".isFocused"></a><div data-ext="selectable extension" style="display: block;"><span>.isFocused (item) <span>selectable extension</span><a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> has (virtual) focus.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isHidden"></a><div data-ext="core" style="display: block;"><span>.isHidden (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> node is hidden.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isHiddenPath"></a><div data-ext="core" style="display: block;"><span>.isHiddenPath (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the path to <b>item</b> is hidden (a parent node is hidden).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isImmediateChildren"></a><div data-ext="core" style="display: block;"><span>.isImmediateChildren (parent, children)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if <b>children</b> have <b>parent</b> as direct parent.
<span class="where">
where:
<span>parent<span> jQuery object</span></span> the parent <i>LI</i>
<span>children<span> jQuery object</span></span> the children <i>LI</i>
</span>
</div>
<a name=".isInode"></a><div data-ext="core" style="display: block;"><span>.isInode (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if <b>item</b> is a inner node (has childrens).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isItem"></a><div data-ext="core" style="display: block;"><span>.isItem (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if <b>item</b> is a valid item.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isLast"></a><div data-ext="core" style="display: block;"><span>.isLast (item, hidden)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if <b>item</b> is the last item for its parent.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
<span>hidden<span> (boolean)</span></span> if <i>TRUE</i> then the hidden elements will be considered too
</span>
</div>
<a name=".isLeaf"></a><div data-ext="core" style="display: block;"><span>.isLeaf (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if <b>item</b> is a leaf node (does not have any childrens).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isLocked"></a><div data-ext="core" style="display: block;"><span>.isLocked ()</span> Returns <i>TRUE</i> if the treeview control is in the <b>init</b> or <b>destroy</b> operation.
</div>
<a name=".isOpen"></a><div data-ext="core" style="display: block;"><span>.isOpen (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> node is opened.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isOpenPath"></a><div data-ext="core" style="display: block;"><span>.isOpenPath (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the path to <b>item</b> is open (all the parent nodes are open).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isPersist"></a><div data-ext="persist extension" style="display: block;"><span>.isPersist () <span>persist extension</span></span> Returns <i>TRUE</i> if there is any saved data.
</div>
<a name=".isSelected"></a><div data-ext="selectable extension" style="display: block;"><span>.isSelected (item) <span>selectable extension</span><a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> is selected.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isTristate"></a><div data-ext="checkbox extension" style="display: block;"><span>.isTristate (item) <span>checkbox extension</span><a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if the <b>item</b> is tristate.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".isVisible"></a><div data-ext="core" style="display: block;"><span>.isVisible (item)<a href="#" title="Top">^</a></span> Returns <i>TRUE</i> if <b>item</b> is visible (if all parent nodes are opened and the item it's in the visible area).
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
</div>
<a name=".itemData"></a><div data-ext="core" style="display: block;"><span>.itemData (item)<a href="#" title="Top">^</a></span> Returns the related <i>item</i> (updated) properties as defined in the JSON.
<span class="where">
where:
<span>item<span> jQuery object</span></span> the <i>LI</i>
</span>
Note that not all node properties are updated in real time after you use the API and the <i>branch</i> property does not contain the
children. If you want to read the updated properties - including the children list - you can use the <b>.serialize</b> method.
</div>
<a name=".itemFrom"></a><div data-ext="core" style="display: block;"><span>.itemFrom (element)<a href="#" title="Top">^</a></span> Returns the <i>LI</i> that contains the <b>element</b>.
<span class="where">
where:
<span>element<span> jQuery object</span></span> a children element for <i>LI</i>
</span>
</div>
<a name=".last"></a><div data-ext="core" style="display: block;"><span>.last (item, hidden)<a href="#" title="Top">^</a></span> Returns the last children of <b>item</b>.