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