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