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