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