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