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