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