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