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