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