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