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