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