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