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