Partial Fix #5654 - roojspacker - get it working as a doc tool...
[roojs1] / docs2 / symbols / Roo.bootstrap.NavGroup.json
1 {
2   "name" : "Roo.bootstrap.NavGroup",
3   "augments" : [
4     "Roo.bootstrap.Component",
5     "Roo.Component",
6     "Roo.util.Observable"
7   ],
8   "desc" : "Bootstrap NavGroup class",
9   "isSingleton" : false,
10   "isStatic" : true,
11   "isBuiltin" : false,
12   "config" : [
13     {
14       "name" : "listeners",
15       "type" : "Object",
16       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
17       "memberOf" : "Roo.util.Observable",
18       "values" : [
19       ]
20     },
21     {
22       "name" : "tooltip",
23       "type" : "string",
24       "desc" : "Text for the tooltip",
25       "memberOf" : "Roo.bootstrap.Component",
26       "values" : [
27       ]
28     },
29     {
30       "name" : "container_method",
31       "type" : "string",
32       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
33       "memberOf" : "Roo.bootstrap.Component",
34       "values" : [
35       ]
36     },
37     {
38       "name" : "visibilityEl",
39       "type" : "string|object",
40       "desc" : "What element to use for visibility (@see getVisibilityEl())",
41       "memberOf" : "Roo.bootstrap.Component",
42       "values" : [
43         "(el",
44         "parent)"
45       ]
46     },
47     {
48       "name" : "align",
49       "type" : "String",
50       "desc" : "",
51       "memberOf" : "Roo.bootstrap.NavGroup",
52       "values" : [
53         "(left",
54         "right)"
55       ]
56     },
57     {
58       "name" : "inverse",
59       "type" : "Boolean",
60       "desc" : "",
61       "memberOf" : "Roo.bootstrap.NavGroup",
62       "values" : [
63       ]
64     },
65     {
66       "name" : "navId",
67       "type" : "String",
68       "desc" : "- reference Id for navbar.",
69       "memberOf" : "Roo.bootstrap.NavGroup",
70       "values" : [
71       ]
72     },
73     {
74       "name" : "can_build_overlaid",
75       "type" : "Boolean",
76       "desc" : "True if element can be rebuild from a HTML page",
77       "memberOf" : "Roo.bootstrap.Component",
78       "values" : [
79       ]
80     },
81     {
82       "name" : "hideMode",
83       "type" : "String",
84       "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
85       "memberOf" : "Roo.Component",
86       "values" : [
87         "(display",
88         "visibility)"
89       ]
90     },
91     {
92       "name" : "style",
93       "type" : "String",
94       "desc" : "any extra css",
95       "memberOf" : "Roo.bootstrap.Component",
96       "values" : [
97       ]
98     },
99     {
100       "name" : "allowDomMove",
101       "type" : "Boolean",
102       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
103       "memberOf" : "Roo.Component",
104       "values" : [
105       ]
106     },
107     {
108       "name" : "cls",
109       "type" : "String",
110       "desc" : "css class",
111       "memberOf" : "Roo.bootstrap.Component",
112       "values" : [
113       ]
114     },
115     {
116       "name" : "xattr",
117       "type" : "Object",
118       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
119       "memberOf" : "Roo.bootstrap.Component",
120       "values" : [
121       ]
122     },
123     {
124       "name" : "actionMode",
125       "type" : "String",
126       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el'",
127       "memberOf" : "Roo.Component",
128       "values" : [
129       ]
130     },
131     {
132       "name" : "dataId",
133       "type" : "string",
134       "desc" : "cutomer id",
135       "memberOf" : "Roo.bootstrap.Component",
136       "values" : [
137       ]
138     },
139     {
140       "name" : "type",
141       "type" : "String",
142       "desc" : "default nav",
143       "memberOf" : "Roo.bootstrap.NavGroup",
144       "values" : [
145         "(nav",
146         "pills",
147         "tab)"
148       ]
149     },
150     {
151       "name" : "name",
152       "type" : "string",
153       "desc" : "Specifies name attribute",
154       "memberOf" : "Roo.bootstrap.Component",
155       "values" : [
156       ]
157     },
158     {
159       "name" : "disableClass",
160       "type" : "String",
161       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
162       "memberOf" : "Roo.Component",
163       "values" : [
164       ]
165     }
166   ],
167   "methods" : [
168     {
169       "name" : "register",
170       "desc" : "register a Navigation item",
171       "isStatic" : false,
172       "isConstructor" : false,
173       "isPrivate" : false,
174       "memberOf" : "Roo.bootstrap.NavGroup",
175       "example" : "",
176       "deprecated" : "",
177       "since" : "",
178       "see" : "",
179       "params" : [
180         {
181           "name" : "the",
182           "type" : "Roo.bootstrap.NavItem",
183           "desc" : "navitem to add",
184           "isOptional" : false
185         }
186       ],
187       "returns" : [
188       ]
189     },
190     {
191       "name" : "getActive",
192       "desc" : "gets the active Navigation item",
193       "isStatic" : false,
194       "isConstructor" : false,
195       "isPrivate" : false,
196       "memberOf" : "Roo.bootstrap.NavGroup",
197       "example" : "",
198       "deprecated" : "",
199       "since" : "",
200       "see" : "",
201       "params" : [
202       ],
203       "returns" : [
204         {
205           "name" : "",
206           "type" : "Roo.bootstrap.NavItem",
207           "desc" : "the current navitem"
208         }
209       ]
210     },
211     {
212       "name" : "addItem",
213       "desc" : "adds a Navigation item",
214       "isStatic" : false,
215       "isConstructor" : false,
216       "isPrivate" : false,
217       "memberOf" : "Roo.bootstrap.NavGroup",
218       "example" : "",
219       "deprecated" : "",
220       "since" : "",
221       "see" : "",
222       "params" : [
223         {
224           "name" : "the",
225           "type" : "Roo.bootstrap.NavItem",
226           "desc" : "navitem to add",
227           "isOptional" : false
228         }
229       ],
230       "returns" : [
231       ]
232     },
233     {
234       "name" : "register",
235       "desc" : "register a Navigation Group",
236       "isStatic" : true,
237       "isConstructor" : false,
238       "isPrivate" : false,
239       "memberOf" : "Roo.bootstrap.NavGroup",
240       "example" : "",
241       "deprecated" : "",
242       "since" : "",
243       "see" : "",
244       "params" : [
245         {
246           "name" : "the",
247           "type" : "Roo.bootstrap.NavGroup",
248           "desc" : "navgroup to add",
249           "isOptional" : false
250         }
251       ],
252       "returns" : [
253       ]
254     },
255     {
256       "name" : "get",
257       "desc" : "fetch a Navigation Group based on the navigation ID",
258       "isStatic" : true,
259       "isConstructor" : false,
260       "isPrivate" : false,
261       "memberOf" : "Roo.bootstrap.NavGroup",
262       "example" : "",
263       "deprecated" : "",
264       "since" : "",
265       "see" : "",
266       "params" : [
267         {
268           "name" : "the",
269           "type" : "string",
270           "desc" : "navgroup to add",
271           "isOptional" : false
272         }
273       ],
274       "returns" : [
275       ]
276     },
277     {
278       "name" : "setActiveItem",
279       "desc" : "sets the active Navigation item",
280       "isStatic" : false,
281       "isConstructor" : false,
282       "isPrivate" : false,
283       "memberOf" : "Roo.bootstrap.NavGroup",
284       "example" : "",
285       "deprecated" : "",
286       "since" : "",
287       "see" : "",
288       "params" : [
289         {
290           "name" : "the",
291           "type" : "Roo.bootstrap.NavItem",
292           "desc" : "new current navitem",
293           "isOptional" : false
294         }
295       ],
296       "returns" : [
297       ]
298     },
299     {
300       "name" : "clearAll",
301       "desc" : "clear all the Navigation item",
302       "isStatic" : false,
303       "isConstructor" : false,
304       "isPrivate" : false,
305       "memberOf" : "Roo.bootstrap.NavGroup",
306       "example" : "",
307       "deprecated" : "",
308       "since" : "",
309       "see" : "",
310       "params" : [
311       ],
312       "returns" : [
313       ]
314     },
315     {
316       "name" : "tooltipEl",
317       "desc" : "Fetch the element to display the tooltip on.",
318       "isStatic" : false,
319       "isConstructor" : false,
320       "isPrivate" : false,
321       "memberOf" : "Roo.bootstrap.Component",
322       "example" : "",
323       "deprecated" : "",
324       "since" : "",
325       "see" : "",
326       "params" : [
327       ],
328       "returns" : [
329         {
330           "name" : "",
331           "type" : "Roo.Element",
332           "desc" : "defaults to this.el"
333         }
334       ]
335     },
336     {
337       "name" : "hide",
338       "desc" : "Hide a component - adds 'hidden' class",
339       "isStatic" : false,
340       "isConstructor" : false,
341       "isPrivate" : false,
342       "memberOf" : "Roo.bootstrap.Component",
343       "example" : "",
344       "deprecated" : "",
345       "since" : "",
346       "see" : "",
347       "params" : [
348       ],
349       "returns" : [
350       ]
351     },
352     {
353       "name" : "show",
354       "desc" : "Show a component - removes 'hidden' class",
355       "isStatic" : false,
356       "isConstructor" : false,
357       "isPrivate" : false,
358       "memberOf" : "Roo.bootstrap.Component",
359       "example" : "",
360       "deprecated" : "",
361       "since" : "",
362       "see" : "",
363       "params" : [
364       ],
365       "returns" : [
366       ]
367     },
368     {
369       "name" : "setVisibilityEl",
370       "desc" : "Set the element that will be used to show or hide",
371       "isStatic" : false,
372       "isConstructor" : false,
373       "isPrivate" : false,
374       "memberOf" : "Roo.bootstrap.Component",
375       "example" : "",
376       "deprecated" : "",
377       "since" : "",
378       "see" : "",
379       "params" : [
380       ],
381       "returns" : [
382       ]
383     },
384     {
385       "name" : "getVisibilityEl",
386       "desc" : "Get the element that will be used to show or hide",
387       "isStatic" : false,
388       "isConstructor" : false,
389       "isPrivate" : false,
390       "memberOf" : "Roo.bootstrap.Component",
391       "example" : "",
392       "deprecated" : "",
393       "since" : "",
394       "see" : "",
395       "params" : [
396       ],
397       "returns" : [
398       ]
399     },
400     {
401       "name" : "initEvents",
402       "desc" : "Initialize Events for the element",
403       "isStatic" : false,
404       "isConstructor" : false,
405       "isPrivate" : false,
406       "memberOf" : "Roo.bootstrap.Component",
407       "example" : "",
408       "deprecated" : "",
409       "since" : "",
410       "see" : "",
411       "params" : [
412       ],
413       "returns" : [
414       ]
415     },
416     {
417       "name" : "getChildContainer",
418       "desc" : "Fetch the element to add children to",
419       "isStatic" : false,
420       "isConstructor" : false,
421       "isPrivate" : false,
422       "memberOf" : "Roo.bootstrap.Component",
423       "example" : "",
424       "deprecated" : "",
425       "since" : "",
426       "see" : "",
427       "params" : [
428       ],
429       "returns" : [
430         {
431           "name" : "",
432           "type" : "Roo.Element",
433           "desc" : "defaults to this.el"
434         }
435       ]
436     },
437     {
438       "name" : "getId",
439       "desc" : "Returns the id of this component.",
440       "isStatic" : false,
441       "isConstructor" : false,
442       "isPrivate" : false,
443       "memberOf" : "Roo.Component",
444       "example" : "",
445       "deprecated" : "",
446       "since" : "",
447       "see" : "",
448       "params" : [
449       ],
450       "returns" : [
451         {
452           "name" : "",
453           "type" : "String",
454           "desc" : ""
455         }
456       ]
457     },
458     {
459       "name" : "render",
460       "desc" : "If this is a lazy rendering component, render it to its container element.",
461       "isStatic" : false,
462       "isConstructor" : false,
463       "isPrivate" : false,
464       "memberOf" : "Roo.Component",
465       "example" : "",
466       "deprecated" : "",
467       "since" : "",
468       "see" : "",
469       "params" : [
470         {
471           "name" : "container",
472           "type" : "String/HTMLElement/Element",
473           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
474           "isOptional" : false
475         }
476       ],
477       "returns" : [
478       ]
479     },
480     {
481       "name" : "destroy",
482       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
483       "isStatic" : false,
484       "isConstructor" : false,
485       "isPrivate" : false,
486       "memberOf" : "Roo.Component",
487       "example" : "",
488       "deprecated" : "",
489       "since" : "",
490       "see" : "",
491       "params" : [
492       ],
493       "returns" : [
494       ]
495     },
496     {
497       "name" : "isVisible",
498       "desc" : "Returns true if this component is visible.",
499       "isStatic" : false,
500       "isConstructor" : false,
501       "isPrivate" : false,
502       "memberOf" : "Roo.Component",
503       "example" : "",
504       "deprecated" : "",
505       "since" : "",
506       "see" : "",
507       "params" : [
508       ],
509       "returns" : [
510       ]
511     },
512     {
513       "name" : "setDisabled",
514       "desc" : "Convenience function for setting disabled/enabled by boolean.",
515       "isStatic" : false,
516       "isConstructor" : false,
517       "isPrivate" : false,
518       "memberOf" : "Roo.Component",
519       "example" : "",
520       "deprecated" : "",
521       "since" : "",
522       "see" : "",
523       "params" : [
524         {
525           "name" : "disabled",
526           "type" : "Boolean",
527           "desc" : "",
528           "isOptional" : false
529         }
530       ],
531       "returns" : [
532       ]
533     },
534     {
535       "name" : "focus",
536       "desc" : "Try to focus this component.",
537       "isStatic" : false,
538       "isConstructor" : false,
539       "isPrivate" : false,
540       "memberOf" : "Roo.Component",
541       "example" : "",
542       "deprecated" : "",
543       "since" : "",
544       "see" : "",
545       "params" : [
546         {
547           "name" : "selectText",
548           "type" : "Boolean",
549           "desc" : "True to also select the text in this component (if applicable)",
550           "isOptional" : false
551         }
552       ],
553       "returns" : [
554         {
555           "name" : "",
556           "type" : "Roo.Component",
557           "desc" : "this"
558         }
559       ]
560     },
561     {
562       "name" : "enable",
563       "desc" : "Enable this component.",
564       "isStatic" : false,
565       "isConstructor" : false,
566       "isPrivate" : false,
567       "memberOf" : "Roo.Component",
568       "example" : "",
569       "deprecated" : "",
570       "since" : "",
571       "see" : "",
572       "params" : [
573       ],
574       "returns" : [
575         {
576           "name" : "",
577           "type" : "Roo.Component",
578           "desc" : "this"
579         }
580       ]
581     },
582     {
583       "name" : "setVisible",
584       "desc" : "Convenience function to hide or show this component by boolean.",
585       "isStatic" : false,
586       "isConstructor" : false,
587       "isPrivate" : false,
588       "memberOf" : "Roo.Component",
589       "example" : "",
590       "deprecated" : "",
591       "since" : "",
592       "see" : "",
593       "params" : [
594         {
595           "name" : "visible",
596           "type" : "Boolean",
597           "desc" : "True to show, false to hide",
598           "isOptional" : false
599         }
600       ],
601       "returns" : [
602         {
603           "name" : "",
604           "type" : "Roo.Component",
605           "desc" : "this"
606         }
607       ]
608     },
609     {
610       "name" : "disable",
611       "desc" : "Disable this component.",
612       "isStatic" : false,
613       "isConstructor" : false,
614       "isPrivate" : false,
615       "memberOf" : "Roo.Component",
616       "example" : "",
617       "deprecated" : "",
618       "since" : "",
619       "see" : "",
620       "params" : [
621       ],
622       "returns" : [
623         {
624           "name" : "",
625           "type" : "Roo.Component",
626           "desc" : "this"
627         }
628       ]
629     },
630     {
631       "name" : "getEl",
632       "desc" : "Returns the underlying {@link Roo.Element}.",
633       "isStatic" : false,
634       "isConstructor" : false,
635       "isPrivate" : false,
636       "memberOf" : "Roo.Component",
637       "example" : "",
638       "deprecated" : "",
639       "since" : "",
640       "see" : "",
641       "params" : [
642       ],
643       "returns" : [
644         {
645           "name" : "",
646           "type" : "Roo.Element",
647           "desc" : "The element"
648         }
649       ]
650     },
651     {
652       "name" : "purgeListeners",
653       "desc" : "Removes all listeners for this object",
654       "isStatic" : false,
655       "isConstructor" : false,
656       "isPrivate" : false,
657       "memberOf" : "Roo.util.Observable",
658       "example" : "",
659       "deprecated" : "",
660       "since" : "",
661       "see" : "",
662       "params" : [
663       ],
664       "returns" : [
665       ]
666     },
667     {
668       "name" : "on",
669       "desc" : "Appends an event handler to this element (shorthand for addListener)",
670       "isStatic" : false,
671       "isConstructor" : false,
672       "isPrivate" : false,
673       "memberOf" : "Roo.util.Observable",
674       "example" : "",
675       "deprecated" : "",
676       "since" : "",
677       "see" : "",
678       "params" : [
679         {
680           "name" : "eventName",
681           "type" : "String",
682           "desc" : "The type of event to listen for",
683           "isOptional" : false
684         },
685         {
686           "name" : "handler",
687           "type" : "Function",
688           "desc" : "The method the event invokes",
689           "isOptional" : false
690         },
691         {
692           "name" : "scope",
693           "type" : "Object",
694           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
695           "isOptional" : false
696         },
697         {
698           "name" : "options",
699           "type" : "Object",
700           "desc" : "(optional)",
701           "isOptional" : false
702         }
703       ],
704       "returns" : [
705       ]
706     },
707     {
708       "name" : "un",
709       "desc" : "Removes a listener (shorthand for removeListener)",
710       "isStatic" : false,
711       "isConstructor" : false,
712       "isPrivate" : false,
713       "memberOf" : "Roo.util.Observable",
714       "example" : "",
715       "deprecated" : "",
716       "since" : "",
717       "see" : "",
718       "params" : [
719         {
720           "name" : "eventName",
721           "type" : "String",
722           "desc" : "The type of event to listen for",
723           "isOptional" : false
724         },
725         {
726           "name" : "handler",
727           "type" : "Function",
728           "desc" : "The handler to remove",
729           "isOptional" : false
730         },
731         {
732           "name" : "scope",
733           "type" : "Object",
734           "desc" : "(optional) The scope (this object) for the handler",
735           "isOptional" : false
736         }
737       ],
738       "returns" : [
739       ]
740     },
741     {
742       "name" : "addEvents",
743       "desc" : "Used to define events on this Observable",
744       "isStatic" : false,
745       "isConstructor" : false,
746       "isPrivate" : false,
747       "memberOf" : "Roo.util.Observable",
748       "example" : "",
749       "deprecated" : "",
750       "since" : "",
751       "see" : "",
752       "params" : [
753         {
754           "name" : "object",
755           "type" : "Object",
756           "desc" : "The object with the events defined",
757           "isOptional" : false
758         }
759       ],
760       "returns" : [
761       ]
762     },
763     {
764       "name" : "releaseCapture",
765       "desc" : "Removes <b>all</b> added captures from the Observable.",
766       "isStatic" : true,
767       "isConstructor" : false,
768       "isPrivate" : false,
769       "memberOf" : "Roo.util.Observable",
770       "example" : "",
771       "deprecated" : "",
772       "since" : "",
773       "see" : "",
774       "params" : [
775         {
776           "name" : "o",
777           "type" : "Observable",
778           "desc" : "The Observable to release",
779           "isOptional" : false
780         }
781       ],
782       "returns" : [
783       ]
784     },
785     {
786       "name" : "removeListener",
787       "desc" : "Removes a listener",
788       "isStatic" : false,
789       "isConstructor" : false,
790       "isPrivate" : false,
791       "memberOf" : "Roo.util.Observable",
792       "example" : "",
793       "deprecated" : "",
794       "since" : "",
795       "see" : "",
796       "params" : [
797         {
798           "name" : "eventName",
799           "type" : "String",
800           "desc" : "The type of event to listen for",
801           "isOptional" : false
802         },
803         {
804           "name" : "handler",
805           "type" : "Function",
806           "desc" : "The handler to remove",
807           "isOptional" : false
808         },
809         {
810           "name" : "scope",
811           "type" : "Object",
812           "desc" : "(optional) The scope (this object) for the handler",
813           "isOptional" : false
814         }
815       ],
816       "returns" : [
817       ]
818     },
819     {
820       "name" : "fireEvent",
821       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
822       "isStatic" : false,
823       "isConstructor" : false,
824       "isPrivate" : false,
825       "memberOf" : "Roo.util.Observable",
826       "example" : "",
827       "deprecated" : "",
828       "since" : "",
829       "see" : "",
830       "params" : [
831         {
832           "name" : "eventName",
833           "type" : "String",
834           "desc" : "",
835           "isOptional" : false
836         },
837         {
838           "name" : "args",
839           "type" : "Object...",
840           "desc" : "Variable number of parameters are passed to handlers",
841           "isOptional" : false
842         }
843       ],
844       "returns" : [
845         {
846           "name" : "",
847           "type" : "Boolean",
848           "desc" : "returns false if any of the handlers return false otherwise it returns true"
849         }
850       ]
851     },
852     {
853       "name" : "hasListener",
854       "desc" : "Checks to see if this object has any listeners for a specified event",
855       "isStatic" : false,
856       "isConstructor" : false,
857       "isPrivate" : false,
858       "memberOf" : "Roo.util.Observable",
859       "example" : "",
860       "deprecated" : "",
861       "since" : "",
862       "see" : "",
863       "params" : [
864         {
865           "name" : "eventName",
866           "type" : "String",
867           "desc" : "The name of the event to check for",
868           "isOptional" : false
869         }
870       ],
871       "returns" : [
872         {
873           "name" : "",
874           "type" : "Boolean",
875           "desc" : "True if the event is being listened for, else false"
876         }
877       ]
878     },
879     {
880       "name" : "capture",
881       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
882       "isStatic" : true,
883       "isConstructor" : false,
884       "isPrivate" : false,
885       "memberOf" : "Roo.util.Observable",
886       "example" : "",
887       "deprecated" : "",
888       "since" : "",
889       "see" : "",
890       "params" : [
891         {
892           "name" : "o",
893           "type" : "Observable",
894           "desc" : "The Observable to capture",
895           "isOptional" : false
896         },
897         {
898           "name" : "fn",
899           "type" : "Function",
900           "desc" : "The function to call",
901           "isOptional" : false
902         },
903         {
904           "name" : "scope",
905           "type" : "Object",
906           "desc" : "(optional) The scope (this object) for the fn",
907           "isOptional" : false
908         }
909       ],
910       "returns" : [
911       ]
912     },
913     {
914       "name" : "addListener",
915       "desc" : "Appends an event handler to this component",
916       "isStatic" : false,
917       "isConstructor" : false,
918       "isPrivate" : false,
919       "memberOf" : "Roo.util.Observable",
920       "example" : "",
921       "deprecated" : "",
922       "since" : "",
923       "see" : "",
924       "params" : [
925         {
926           "name" : "eventName",
927           "type" : "String",
928           "desc" : "The type of event to listen for",
929           "isOptional" : false
930         },
931         {
932           "name" : "handler",
933           "type" : "Function",
934           "desc" : "The method the event invokes",
935           "isOptional" : false
936         },
937         {
938           "name" : "scope",
939           "type" : "Object",
940           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
941           "isOptional" : false
942         },
943         {
944           "name" : "options",
945           "type" : "Object",
946           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
947           "isOptional" : false
948         }
949       ],
950       "returns" : [
951       ]
952     }
953   ],
954   "events" : [
955     {
956       "name" : "changed",
957       "desc" : "Fires when the active item changes",
958       "memberOf" : "",
959       "example" : "",
960       "deprecated" : "",
961       "since" : "",
962       "see" : "",
963       "params" : [
964         {
965           "name" : "this",
966           "type" : "Roo.bootstrap.NavGroup",
967           "desc" : "",
968           "isOptional" : false
969         },
970         {
971           "name" : "selected",
972           "type" : "Roo.bootstrap.Navbar.Item",
973           "desc" : "The item selected",
974           "isOptional" : false
975         },
976         {
977           "name" : "prev",
978           "type" : "Roo.bootstrap.Navbar.Item",
979           "desc" : "The previously selected item",
980           "isOptional" : false
981         }
982       ],
983       "returns" : [
984       ]
985     },
986     {
987       "name" : "childrenrendered",
988       "desc" : "Fires when the children have been rendered..",
989       "memberOf" : "Roo.bootstrap.Component",
990       "example" : "",
991       "deprecated" : "",
992       "since" : "",
993       "see" : "",
994       "params" : [
995         {
996           "name" : "this",
997           "type" : "Roo.bootstrap.Component",
998           "desc" : "",
999           "isOptional" : false
1000         }
1001       ],
1002       "returns" : [
1003       ]
1004     },
1005     {
1006       "name" : "beforerender",
1007       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1008       "memberOf" : "Roo.Component",
1009       "example" : "",
1010       "deprecated" : "",
1011       "since" : "",
1012       "see" : "",
1013       "params" : [
1014         {
1015           "name" : "this",
1016           "type" : "Roo.Component",
1017           "desc" : "",
1018           "isOptional" : false
1019         }
1020       ],
1021       "returns" : [
1022       ]
1023     },
1024     {
1025       "name" : "disable",
1026       "desc" : "Fires after the component is disabled.",
1027       "memberOf" : "Roo.Component",
1028       "example" : "",
1029       "deprecated" : "",
1030       "since" : "",
1031       "see" : "",
1032       "params" : [
1033         {
1034           "name" : "this",
1035           "type" : "Roo.Component",
1036           "desc" : "",
1037           "isOptional" : false
1038         }
1039       ],
1040       "returns" : [
1041       ]
1042     },
1043     {
1044       "name" : "render",
1045       "desc" : "Fires after the component is rendered.",
1046       "memberOf" : "Roo.Component",
1047       "example" : "",
1048       "deprecated" : "",
1049       "since" : "",
1050       "see" : "",
1051       "params" : [
1052         {
1053           "name" : "this",
1054           "type" : "Roo.Component",
1055           "desc" : "",
1056           "isOptional" : false
1057         }
1058       ],
1059       "returns" : [
1060       ]
1061     },
1062     {
1063       "name" : "destroy",
1064       "desc" : "Fires after the component is destroyed.",
1065       "memberOf" : "Roo.Component",
1066       "example" : "",
1067       "deprecated" : "",
1068       "since" : "",
1069       "see" : "",
1070       "params" : [
1071         {
1072           "name" : "this",
1073           "type" : "Roo.Component",
1074           "desc" : "",
1075           "isOptional" : false
1076         }
1077       ],
1078       "returns" : [
1079       ]
1080     },
1081     {
1082       "name" : "hide",
1083       "desc" : "Fires after the component is hidden.",
1084       "memberOf" : "Roo.Component",
1085       "example" : "",
1086       "deprecated" : "",
1087       "since" : "",
1088       "see" : "",
1089       "params" : [
1090         {
1091           "name" : "this",
1092           "type" : "Roo.Component",
1093           "desc" : "",
1094           "isOptional" : false
1095         }
1096       ],
1097       "returns" : [
1098       ]
1099     },
1100     {
1101       "name" : "beforehide",
1102       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1103       "memberOf" : "Roo.Component",
1104       "example" : "",
1105       "deprecated" : "",
1106       "since" : "",
1107       "see" : "",
1108       "params" : [
1109         {
1110           "name" : "this",
1111           "type" : "Roo.Component",
1112           "desc" : "",
1113           "isOptional" : false
1114         }
1115       ],
1116       "returns" : [
1117       ]
1118     },
1119     {
1120       "name" : "show",
1121       "desc" : "Fires after the component is shown.",
1122       "memberOf" : "Roo.Component",
1123       "example" : "",
1124       "deprecated" : "",
1125       "since" : "",
1126       "see" : "",
1127       "params" : [
1128         {
1129           "name" : "this",
1130           "type" : "Roo.Component",
1131           "desc" : "",
1132           "isOptional" : false
1133         }
1134       ],
1135       "returns" : [
1136       ]
1137     },
1138     {
1139       "name" : "beforeshow",
1140       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1141       "memberOf" : "Roo.Component",
1142       "example" : "",
1143       "deprecated" : "",
1144       "since" : "",
1145       "see" : "",
1146       "params" : [
1147         {
1148           "name" : "this",
1149           "type" : "Roo.Component",
1150           "desc" : "",
1151           "isOptional" : false
1152         }
1153       ],
1154       "returns" : [
1155       ]
1156     },
1157     {
1158       "name" : "enable",
1159       "desc" : "Fires after the component is enabled.",
1160       "memberOf" : "Roo.Component",
1161       "example" : "",
1162       "deprecated" : "",
1163       "since" : "",
1164       "see" : "",
1165       "params" : [
1166         {
1167           "name" : "this",
1168           "type" : "Roo.Component",
1169           "desc" : "",
1170           "isOptional" : false
1171         }
1172       ],
1173       "returns" : [
1174       ]
1175     },
1176     {
1177       "name" : "beforedestroy",
1178       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1179       "memberOf" : "Roo.Component",
1180       "example" : "",
1181       "deprecated" : "",
1182       "since" : "",
1183       "see" : "",
1184       "params" : [
1185         {
1186           "name" : "this",
1187           "type" : "Roo.Component",
1188           "desc" : "",
1189           "isOptional" : false
1190         }
1191       ],
1192       "returns" : [
1193       ]
1194     }
1195   ]
1196 }