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