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