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