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