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