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