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