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