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