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