sync
[roojs1] / docs / symbols / Roo.ContentPanel.json
1 {
2   "name" : "Roo.ContentPanel",
3   "augments" : [
4     "Roo.util.Observable"
5   ],
6   "desc" : "A basic ContentPanel element.",
7   "isSingleton" : false,
8   "isStatic" : false,
9   "isBuiltin" : false,
10   "memberOf" : "ContentPanel",
11   "example" : "",
12   "deprecated" : "",
13   "since" : "",
14   "see" : "",
15   "params" : [
16     {
17       "name" : "el",
18       "type" : "String/HTMLElement/Roo.Element",
19       "desc" : "The container element for this panel",
20       "isOptional" : false
21     },
22     {
23       "name" : "config",
24       "type" : "String/Object",
25       "desc" : "A string to set only the title or a config object",
26       "isOptional" : false
27     },
28     {
29       "name" : "content",
30       "type" : "String",
31       "desc" : "(optional) Set the HTML content for this panel",
32       "isOptional" : false
33     },
34     {
35       "name" : "region",
36       "type" : "String",
37       "desc" : "(optional) Used by xtype constructors to add to regions. (values center,east,west,south,north)",
38       "isOptional" : false
39     }
40   ],
41   "returns" : [],
42   "throws" : "",
43   "requires" : "",
44   "config" : [
45     {
46       "name" : "loadOnce",
47       "type" : "Boolean",
48       "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
49       "memberOf" : ""
50     },
51     {
52       "name" : "listeners",
53       "type" : "Object",
54       "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>",
55       "memberOf" : "Roo.util.Observable"
56     },
57     {
58       "name" : "autoScroll",
59       "type" : "Boolean",
60       "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
61       "memberOf" : ""
62     },
63     {
64       "name" : "fitToFrame",
65       "type" : "Boolean",
66       "desc" : "True for this panel to adjust its size to fit when the region resizes  (defaults to false)",
67       "memberOf" : ""
68     },
69     {
70       "name" : "background",
71       "type" : "Boolean",
72       "desc" : "True if the panel should not be activated when it is added (defaults to false)",
73       "memberOf" : ""
74     },
75     {
76       "name" : "toolbar",
77       "type" : "Roo.Toolbar",
78       "desc" : "A toolbar for this panel",
79       "memberOf" : ""
80     },
81     {
82       "name" : "region",
83       "type" : "String",
84       "desc" : "[required]   (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
85       "memberOf" : ""
86     },
87     {
88       "name" : "content",
89       "type" : "String",
90       "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
91       "memberOf" : ""
92     },
93     {
94       "name" : "menu",
95       "type" : "Roo.menu.Menu",
96       "desc" : "popup menu",
97       "memberOf" : ""
98     },
99     {
100       "name" : "title",
101       "type" : "String",
102       "desc" : "The title for this panel",
103       "memberOf" : ""
104     },
105     {
106       "name" : "style",
107       "type" : "String",
108       "desc" : "Extra style to add to the content panel",
109       "memberOf" : ""
110     },
111     {
112       "name" : "autoCreate",
113       "type" : "Boolean|Object",
114       "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
115       "memberOf" : ""
116     },
117     {
118       "name" : "fitContainer",
119       "type" : "Boolean",
120       "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container  (defaults to false)",
121       "memberOf" : ""
122     },
123     {
124       "name" : "closable",
125       "type" : "Boolean",
126       "desc" : "True if the panel can be closed/removed",
127       "memberOf" : ""
128     },
129     {
130       "name" : "params",
131       "type" : "String|Object",
132       "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
133       "memberOf" : ""
134     },
135     {
136       "name" : "adjustments",
137       "type" : "Array",
138       "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
139       "memberOf" : ""
140     },
141     {
142       "name" : "url",
143       "type" : "String",
144       "desc" : "Calls {@link #setUrl} with this value",
145       "memberOf" : ""
146     },
147     {
148       "name" : "resizeEl",
149       "type" : "String|HTMLElement|Element",
150       "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
151       "memberOf" : ""
152     }
153   ],
154   "methods" : [
155     {
156       "name" : "load",
157       "type" : "function",
158       "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
159       "sig" : "(url, params, callback, discardUrl)",
160       "static" : false,
161       "memberOf" : "",
162       "isStatic" : false,
163       "isConstructor" : false,
164       "isPrivate" : false,
165       "example" : "",
166       "deprecated" : "",
167       "since" : "",
168       "see" : "",
169       "exceptions" : "",
170       "requires" : "",
171       "params" : [
172         {
173           "name" : "url",
174           "type" : "Object/String/Function",
175           "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n    url: \"your-url.php\",\n    params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n    callback: yourFunction,\n    scope: yourObject, //(optional scope)\n    discardUrl: false,\n    nocache: false,\n    text: \"Loading...\",\n    timeout: 30,\n    scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
176           "isOptional" : false
177         },
178         {
179           "name" : "params",
180           "type" : "String/Object",
181           "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&amp;param2=2\" or an object {param1: 1, param2: 2}",
182           "isOptional" : false
183         },
184         {
185           "name" : "callback",
186           "type" : "Function",
187           "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
188           "isOptional" : false
189         },
190         {
191           "name" : "discardUrl",
192           "type" : "Boolean",
193           "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
194           "isOptional" : false
195         }
196       ],
197       "returns" : [
198         {
199           "name" : "",
200           "type" : "Roo.ContentPanel",
201           "desc" : "this"
202         }
203       ]
204     },
205     {
206       "name" : "getUpdateManager",
207       "type" : "function",
208       "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
209       "sig" : "()\n{\n\n}",
210       "static" : false,
211       "memberOf" : "",
212       "isStatic" : false,
213       "isConstructor" : false,
214       "isPrivate" : false,
215       "example" : "",
216       "deprecated" : "",
217       "since" : "",
218       "see" : "",
219       "exceptions" : "",
220       "requires" : "",
221       "params" : [],
222       "returns" : [
223         {
224           "name" : "",
225           "type" : "Roo.UpdateManager",
226           "desc" : "The UpdateManager"
227         }
228       ]
229     },
230     {
231       "name" : "isClosable",
232       "type" : "function",
233       "desc" : "Returns true is this panel was configured to be closable",
234       "sig" : "()\n{\n\n}",
235       "static" : false,
236       "memberOf" : "",
237       "isStatic" : false,
238       "isConstructor" : false,
239       "isPrivate" : false,
240       "example" : "",
241       "deprecated" : "",
242       "since" : "",
243       "see" : "",
244       "exceptions" : "",
245       "requires" : "",
246       "params" : [],
247       "returns" : [
248         {
249           "name" : "",
250           "type" : "Boolean",
251           "desc" : ""
252         }
253       ]
254     },
255     {
256       "name" : "destroy",
257       "type" : "function",
258       "desc" : "Destroys this panel",
259       "sig" : "()\n{\n\n}",
260       "static" : false,
261       "memberOf" : "",
262       "isStatic" : false,
263       "isConstructor" : false,
264       "isPrivate" : false,
265       "example" : "",
266       "deprecated" : "",
267       "since" : "",
268       "see" : "",
269       "exceptions" : "",
270       "requires" : "",
271       "params" : [],
272       "returns" : []
273     },
274     {
275       "name" : "getEl",
276       "type" : "function",
277       "desc" : "Returns this panel's element - used by regiosn to add.",
278       "sig" : "()\n{\n\n}",
279       "static" : false,
280       "memberOf" : "",
281       "isStatic" : false,
282       "isConstructor" : false,
283       "isPrivate" : false,
284       "example" : "",
285       "deprecated" : "",
286       "since" : "",
287       "see" : "",
288       "exceptions" : "",
289       "requires" : "",
290       "params" : [],
291       "returns" : [
292         {
293           "name" : "",
294           "type" : "Roo.Element",
295           "desc" : ""
296         }
297       ]
298     },
299     {
300       "name" : "setContent",
301       "type" : "function",
302       "desc" : "Updates this panel's element",
303       "sig" : "(content, loadScripts)",
304       "static" : false,
305       "memberOf" : "",
306       "isStatic" : false,
307       "isConstructor" : false,
308       "isPrivate" : false,
309       "example" : "",
310       "deprecated" : "",
311       "since" : "",
312       "see" : "",
313       "exceptions" : "",
314       "requires" : "",
315       "params" : [
316         {
317           "name" : "content",
318           "type" : "String",
319           "desc" : "The new content",
320           "isOptional" : false
321         },
322         {
323           "name" : "loadScripts",
324           "type" : "Boolean",
325           "desc" : "(optional) true to look for and process scripts",
326           "isOptional" : false
327         }
328       ],
329       "returns" : []
330     },
331     {
332       "name" : "getId",
333       "type" : "function",
334       "desc" : "Returns this panel's id",
335       "sig" : "()\n{\n\n}",
336       "static" : false,
337       "memberOf" : "",
338       "isStatic" : false,
339       "isConstructor" : false,
340       "isPrivate" : false,
341       "example" : "",
342       "deprecated" : "",
343       "since" : "",
344       "see" : "",
345       "exceptions" : "",
346       "requires" : "",
347       "params" : [],
348       "returns" : [
349         {
350           "name" : "",
351           "type" : "String",
352           "desc" : ""
353         }
354       ]
355     },
356     {
357       "name" : "addxtype",
358       "type" : "function",
359       "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n       xtype : 'Form',\n       items: [ .... ]\n   }\n);\n\n</code></pre>",
360       "sig" : "(cfg)",
361       "static" : false,
362       "memberOf" : "",
363       "isStatic" : false,
364       "isConstructor" : false,
365       "isPrivate" : false,
366       "example" : "",
367       "deprecated" : "",
368       "since" : "",
369       "see" : "",
370       "exceptions" : "",
371       "requires" : "",
372       "params" : [
373         {
374           "name" : "cfg",
375           "type" : "Object",
376           "desc" : "Xtype definition of item to add.",
377           "isOptional" : false
378         }
379       ],
380       "returns" : []
381     },
382     {
383       "name" : "refresh",
384       "type" : "function",
385       "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n  Will fail silently if the {@link #setUrl} method has not been called.\n  This does not activate the panel, just updates its content.",
386       "sig" : "()\n{\n\n}",
387       "static" : false,
388       "memberOf" : "",
389       "isStatic" : false,
390       "isConstructor" : false,
391       "isPrivate" : false,
392       "example" : "",
393       "deprecated" : "",
394       "since" : "",
395       "see" : "",
396       "exceptions" : "",
397       "requires" : "",
398       "params" : [],
399       "returns" : []
400     },
401     {
402       "name" : "getTitle",
403       "type" : "function",
404       "desc" : "Returns this panel's title",
405       "sig" : "()\n{\n\n}",
406       "static" : false,
407       "memberOf" : "",
408       "isStatic" : false,
409       "isConstructor" : false,
410       "isPrivate" : false,
411       "example" : "",
412       "deprecated" : "",
413       "since" : "",
414       "see" : "",
415       "exceptions" : "",
416       "requires" : "",
417       "params" : [],
418       "returns" : [
419         {
420           "name" : "",
421           "type" : "String",
422           "desc" : ""
423         }
424       ]
425     },
426     {
427       "name" : "setTitle",
428       "type" : "function",
429       "desc" : "Set this panel's title",
430       "sig" : "(title)",
431       "static" : false,
432       "memberOf" : "",
433       "isStatic" : false,
434       "isConstructor" : false,
435       "isPrivate" : false,
436       "example" : "",
437       "deprecated" : "",
438       "since" : "",
439       "see" : "",
440       "exceptions" : "",
441       "requires" : "",
442       "params" : [
443         {
444           "name" : "title",
445           "type" : "String",
446           "desc" : "",
447           "isOptional" : false
448         }
449       ],
450       "returns" : []
451     },
452     {
453       "name" : "getToolbar",
454       "type" : "function",
455       "desc" : "Returns the toolbar for this Panel if one was configured.",
456       "sig" : "()\n{\n\n}",
457       "static" : false,
458       "memberOf" : "",
459       "isStatic" : false,
460       "isConstructor" : false,
461       "isPrivate" : false,
462       "example" : "",
463       "deprecated" : "",
464       "since" : "",
465       "see" : "",
466       "exceptions" : "",
467       "requires" : "",
468       "params" : [],
469       "returns" : [
470         {
471           "name" : "",
472           "type" : "Roo.Toolbar",
473           "desc" : ""
474         }
475       ]
476     },
477     {
478       "name" : "setUrl",
479       "type" : "function",
480       "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
481       "sig" : "(url, params, loadOnce)",
482       "static" : false,
483       "memberOf" : "",
484       "isStatic" : false,
485       "isConstructor" : false,
486       "isPrivate" : false,
487       "example" : "",
488       "deprecated" : "",
489       "since" : "",
490       "see" : "",
491       "exceptions" : "",
492       "requires" : "",
493       "params" : [
494         {
495           "name" : "url",
496           "type" : "String/Function",
497           "desc" : "The URL to load the content from or a function to call to get the URL",
498           "isOptional" : false
499         },
500         {
501           "name" : "params",
502           "type" : "String/Object",
503           "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
504           "isOptional" : false
505         },
506         {
507           "name" : "loadOnce",
508           "type" : "Boolean",
509           "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
510           "isOptional" : false
511         }
512       ],
513       "returns" : [
514         {
515           "name" : "",
516           "type" : "Roo.UpdateManager",
517           "desc" : "The UpdateManager"
518         }
519       ]
520     },
521     {
522       "name" : "purgeListeners",
523       "type" : "function",
524       "desc" : "Removes all listeners for this object",
525       "sig" : "()\n{\n\n}",
526       "static" : false,
527       "memberOf" : "Roo.util.Observable",
528       "isStatic" : false,
529       "isConstructor" : false,
530       "isPrivate" : false,
531       "example" : "",
532       "deprecated" : "",
533       "since" : "",
534       "see" : "",
535       "exceptions" : "",
536       "requires" : "",
537       "params" : [],
538       "returns" : []
539     },
540     {
541       "name" : "on",
542       "type" : "function",
543       "desc" : "Appends an event handler to this element (shorthand for addListener)",
544       "sig" : "(eventName, handler, scope, options)",
545       "static" : false,
546       "memberOf" : "Roo.util.Observable",
547       "isStatic" : false,
548       "isConstructor" : false,
549       "isPrivate" : false,
550       "example" : "",
551       "deprecated" : "",
552       "since" : "",
553       "see" : "",
554       "exceptions" : "",
555       "requires" : "",
556       "params" : [
557         {
558           "name" : "eventName",
559           "type" : "String",
560           "desc" : "The type of event to listen for",
561           "isOptional" : false
562         },
563         {
564           "name" : "handler",
565           "type" : "Function",
566           "desc" : "The method the event invokes",
567           "isOptional" : false
568         },
569         {
570           "name" : "scope",
571           "type" : "Object",
572           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
573           "isOptional" : false
574         },
575         {
576           "name" : "options",
577           "type" : "Object",
578           "desc" : "(optional)",
579           "isOptional" : false
580         }
581       ],
582       "returns" : []
583     },
584     {
585       "name" : "un",
586       "type" : "function",
587       "desc" : "Removes a listener (shorthand for removeListener)",
588       "sig" : "(eventName, handler, scope)",
589       "static" : false,
590       "memberOf" : "Roo.util.Observable",
591       "isStatic" : false,
592       "isConstructor" : false,
593       "isPrivate" : false,
594       "example" : "",
595       "deprecated" : "",
596       "since" : "",
597       "see" : "",
598       "exceptions" : "",
599       "requires" : "",
600       "params" : [
601         {
602           "name" : "eventName",
603           "type" : "String",
604           "desc" : "The type of event to listen for",
605           "isOptional" : false
606         },
607         {
608           "name" : "handler",
609           "type" : "Function",
610           "desc" : "The handler to remove",
611           "isOptional" : false
612         },
613         {
614           "name" : "scope",
615           "type" : "Object",
616           "desc" : "(optional) The scope (this object) for the handler",
617           "isOptional" : false
618         }
619       ],
620       "returns" : []
621     },
622     {
623       "name" : "addEvents",
624       "type" : "function",
625       "desc" : "Used to define events on this Observable",
626       "sig" : "(object)",
627       "static" : false,
628       "memberOf" : "Roo.util.Observable",
629       "isStatic" : false,
630       "isConstructor" : false,
631       "isPrivate" : false,
632       "example" : "",
633       "deprecated" : "",
634       "since" : "",
635       "see" : "",
636       "exceptions" : "",
637       "requires" : "",
638       "params" : [
639         {
640           "name" : "object",
641           "type" : "Object",
642           "desc" : "The object with the events defined",
643           "isOptional" : false
644         }
645       ],
646       "returns" : []
647     },
648     {
649       "name" : "releaseCapture",
650       "type" : "function",
651       "desc" : "Removes <b>all</b> added captures from the Observable.",
652       "sig" : "(o)",
653       "static" : true,
654       "memberOf" : "Roo.util.Observable",
655       "isStatic" : true,
656       "isConstructor" : false,
657       "isPrivate" : false,
658       "example" : "",
659       "deprecated" : "",
660       "since" : "",
661       "see" : "",
662       "exceptions" : "",
663       "requires" : "",
664       "params" : [
665         {
666           "name" : "o",
667           "type" : "Observable",
668           "desc" : "The Observable to release",
669           "isOptional" : false
670         }
671       ],
672       "returns" : []
673     },
674     {
675       "name" : "removeListener",
676       "type" : "function",
677       "desc" : "Removes a listener",
678       "sig" : "(eventName, handler, scope)",
679       "static" : false,
680       "memberOf" : "Roo.util.Observable",
681       "isStatic" : false,
682       "isConstructor" : false,
683       "isPrivate" : false,
684       "example" : "",
685       "deprecated" : "",
686       "since" : "",
687       "see" : "",
688       "exceptions" : "",
689       "requires" : "",
690       "params" : [
691         {
692           "name" : "eventName",
693           "type" : "String",
694           "desc" : "The type of event to listen for",
695           "isOptional" : false
696         },
697         {
698           "name" : "handler",
699           "type" : "Function",
700           "desc" : "The handler to remove",
701           "isOptional" : false
702         },
703         {
704           "name" : "scope",
705           "type" : "Object",
706           "desc" : "(optional) The scope (this object) for the handler",
707           "isOptional" : false
708         }
709       ],
710       "returns" : []
711     },
712     {
713       "name" : "fireEvent",
714       "type" : "function",
715       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
716       "sig" : "(eventName, args)",
717       "static" : false,
718       "memberOf" : "Roo.util.Observable",
719       "isStatic" : false,
720       "isConstructor" : false,
721       "isPrivate" : false,
722       "example" : "",
723       "deprecated" : "",
724       "since" : "",
725       "see" : "",
726       "exceptions" : "",
727       "requires" : "",
728       "params" : [
729         {
730           "name" : "eventName",
731           "type" : "String",
732           "desc" : "",
733           "isOptional" : false
734         },
735         {
736           "name" : "args",
737           "type" : "Object...",
738           "desc" : "Variable number of parameters are passed to handlers",
739           "isOptional" : false
740         }
741       ],
742       "returns" : [
743         {
744           "name" : "",
745           "type" : "Boolean",
746           "desc" : "returns false if any of the handlers return false otherwise it returns true"
747         }
748       ]
749     },
750     {
751       "name" : "hasListener",
752       "type" : "function",
753       "desc" : "Checks to see if this object has any listeners for a specified event",
754       "sig" : "(eventName)",
755       "static" : false,
756       "memberOf" : "Roo.util.Observable",
757       "isStatic" : false,
758       "isConstructor" : false,
759       "isPrivate" : false,
760       "example" : "",
761       "deprecated" : "",
762       "since" : "",
763       "see" : "",
764       "exceptions" : "",
765       "requires" : "",
766       "params" : [
767         {
768           "name" : "eventName",
769           "type" : "String",
770           "desc" : "The name of the event to check for",
771           "isOptional" : false
772         }
773       ],
774       "returns" : [
775         {
776           "name" : "",
777           "type" : "Boolean",
778           "desc" : "True if the event is being listened for, else false"
779         }
780       ]
781     },
782     {
783       "name" : "capture",
784       "type" : "function",
785       "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.",
786       "sig" : "(o, fn, scope)",
787       "static" : true,
788       "memberOf" : "Roo.util.Observable",
789       "isStatic" : true,
790       "isConstructor" : false,
791       "isPrivate" : false,
792       "example" : "",
793       "deprecated" : "",
794       "since" : "",
795       "see" : "",
796       "exceptions" : "",
797       "requires" : "",
798       "params" : [
799         {
800           "name" : "o",
801           "type" : "Observable",
802           "desc" : "The Observable to capture",
803           "isOptional" : false
804         },
805         {
806           "name" : "fn",
807           "type" : "Function",
808           "desc" : "The function to call",
809           "isOptional" : false
810         },
811         {
812           "name" : "scope",
813           "type" : "Object",
814           "desc" : "(optional) The scope (this object) for the fn",
815           "isOptional" : false
816         }
817       ],
818       "returns" : []
819     },
820     {
821       "name" : "addListener",
822       "type" : "function",
823       "desc" : "Appends an event handler to this component",
824       "sig" : "(eventName, handler, scope, options)",
825       "static" : false,
826       "memberOf" : "Roo.util.Observable",
827       "isStatic" : false,
828       "isConstructor" : false,
829       "isPrivate" : false,
830       "example" : "",
831       "deprecated" : "",
832       "since" : "",
833       "see" : "",
834       "exceptions" : "",
835       "requires" : "",
836       "params" : [
837         {
838           "name" : "eventName",
839           "type" : "String",
840           "desc" : "The type of event to listen for",
841           "isOptional" : false
842         },
843         {
844           "name" : "handler",
845           "type" : "Function",
846           "desc" : "The method the event invokes",
847           "isOptional" : false
848         },
849         {
850           "name" : "scope",
851           "type" : "Object",
852           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
853           "isOptional" : false
854         },
855         {
856           "name" : "options",
857           "type" : "Object",
858           "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>",
859           "isOptional" : false
860         }
861       ],
862       "returns" : []
863     }
864   ],
865   "events" : [
866     {
867       "name" : "deactivate",
868       "type" : "function",
869       "desc" : "Fires when this panel is activated.",
870       "sig" : "function (_self)\n{\n\n}",
871       "memberOf" : "",
872       "example" : "",
873       "deprecated" : "",
874       "since" : "",
875       "see" : "",
876       "params" : [
877         {
878           "name" : "this",
879           "type" : "Roo.ContentPanel",
880           "desc" : "",
881           "isOptional" : false
882         }
883       ],
884       "returns" : []
885     },
886     {
887       "name" : "resize",
888       "type" : "function",
889       "desc" : "Fires when this panel is resized if fitToFrame is true.",
890       "sig" : "function (_self, width, height)\n{\n\n}",
891       "memberOf" : "",
892       "example" : "",
893       "deprecated" : "",
894       "since" : "",
895       "see" : "",
896       "params" : [
897         {
898           "name" : "this",
899           "type" : "Roo.ContentPanel",
900           "desc" : "",
901           "isOptional" : false
902         },
903         {
904           "name" : "width",
905           "type" : "Number",
906           "desc" : "The width after any component adjustments",
907           "isOptional" : false
908         },
909         {
910           "name" : "height",
911           "type" : "Number",
912           "desc" : "The height after any component adjustments",
913           "isOptional" : false
914         }
915       ],
916       "returns" : []
917     },
918     {
919       "name" : "render",
920       "type" : "function",
921       "desc" : "Fires when this tab is created",
922       "sig" : "function (_self)\n{\n\n}",
923       "memberOf" : "",
924       "example" : "",
925       "deprecated" : "",
926       "since" : "",
927       "see" : "",
928       "params" : [
929         {
930           "name" : "this",
931           "type" : "Roo.ContentPanel",
932           "desc" : "",
933           "isOptional" : false
934         }
935       ],
936       "returns" : []
937     },
938     {
939       "name" : "activate",
940       "type" : "function",
941       "desc" : "Fires when this panel is activated.",
942       "sig" : "function (_self)\n{\n\n}",
943       "memberOf" : "",
944       "example" : "",
945       "deprecated" : "",
946       "since" : "",
947       "see" : "",
948       "params" : [
949         {
950           "name" : "this",
951           "type" : "Roo.ContentPanel",
952           "desc" : "",
953           "isOptional" : false
954         }
955       ],
956       "returns" : []
957     }
958   ]
959 }