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