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