Fix #6893 - fix roo docs
[roojs1] / docs / symbols / Roo.bootstrap.Modal.json
1 {
2   "name" : "Roo.bootstrap.Modal",
3   "augments" : [
4     "Roo.bootstrap.Component",
5     "Roo.Component",
6     "Roo.util.Observable"
7   ],
8   "desc" : "Bootstrap Modal class",
9   "isSingleton" : false,
10   "isStatic" : false,
11   "isBuiltin" : false,
12   "memberOf" : "Modal",
13   "example" : "",
14   "deprecated" : "",
15   "since" : "",
16   "see" : "",
17   "params" : [
18     {
19       "name" : "config",
20       "type" : "Object",
21       "desc" : "The config object",
22       "isOptional" : false
23     }
24   ],
25   "returns" : [],
26   "config" : [
27     {
28       "name" : "editableTitle",
29       "type" : "Boolean",
30       "desc" : "can the title be edited",
31       "memberOf" : "Roo.bootstrap.Modal",
32       "optvals" : []
33     },
34     {
35       "name" : "listeners",
36       "type" : "Object",
37       "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>",
38       "memberOf" : "Roo.util.Observable",
39       "optvals" : []
40     },
41     {
42       "name" : "bodyOverflow",
43       "type" : "Boolean",
44       "desc" : "should the body element have overflow auto added default false",
45       "memberOf" : "Roo.bootstrap.Modal",
46       "optvals" : []
47     },
48     {
49       "name" : "max_width",
50       "type" : "Number",
51       "desc" : "set the max width of modal",
52       "memberOf" : "Roo.bootstrap.Modal",
53       "optvals" : []
54     },
55     {
56       "name" : "tooltip",
57       "type" : "string",
58       "desc" : "Text for the tooltip",
59       "memberOf" : "Roo.bootstrap.Component",
60       "optvals" : []
61     },
62     {
63       "name" : "container_method",
64       "type" : "string",
65       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
66       "memberOf" : "Roo.bootstrap.Component",
67       "optvals" : []
68     },
69     {
70       "name" : "visibilityEl",
71       "type" : "string|object",
72       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
73       "memberOf" : "Roo.bootstrap.Component",
74       "optvals" : [
75         "el",
76         "parent"
77       ]
78     },
79     {
80       "name" : "buttons",
81       "type" : "Array",
82       "desc" : "Array of buttons or standard button set..",
83       "memberOf" : "Roo.bootstrap.Modal",
84       "optvals" : []
85     },
86     {
87       "name" : "can_build_overlaid",
88       "type" : "Boolean",
89       "desc" : "True if element can be rebuild from a HTML page",
90       "memberOf" : "Roo.bootstrap.Component",
91       "optvals" : []
92     },
93     {
94       "name" : "hideMode",
95       "type" : "String",
96       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
97       "memberOf" : "Roo.Component",
98       "optvals" : [
99         "display",
100         "visibility"
101       ]
102     },
103     {
104       "name" : "title",
105       "type" : "String",
106       "desc" : "Title of dialog",
107       "memberOf" : "Roo.bootstrap.Modal",
108       "optvals" : []
109     },
110     {
111       "name" : "style",
112       "type" : "String",
113       "desc" : "any extra css",
114       "memberOf" : "Roo.bootstrap.Component",
115       "optvals" : []
116     },
117     {
118       "name" : "allowDomMove",
119       "type" : "Boolean",
120       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
121       "memberOf" : "Roo.Component",
122       "optvals" : []
123     },
124     {
125       "name" : "tmpl",
126       "type" : "Roo.Template",
127       "desc" : "- a template with variables. to use it, add a handler in show:method  adn",
128       "memberOf" : "Roo.bootstrap.Modal",
129       "optvals" : []
130     },
131     {
132       "name" : "html",
133       "type" : "String",
134       "desc" : "- the body of the dialog (for simple ones) - you can also use template..",
135       "memberOf" : "Roo.bootstrap.Modal",
136       "optvals" : []
137     },
138     {
139       "name" : "buttonPosition",
140       "type" : "String",
141       "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the left",
142       "memberOf" : "Roo.bootstrap.Modal",
143       "optvals" : [
144         "left",
145         "right",
146         "center"
147       ]
148     },
149     {
150       "name" : "cls",
151       "type" : "String",
152       "desc" : "css class",
153       "memberOf" : "Roo.bootstrap.Component",
154       "optvals" : []
155     },
156     {
157       "name" : "fitwindow",
158       "type" : "Boolean",
159       "desc" : "default false",
160       "memberOf" : "Roo.bootstrap.Modal",
161       "optvals" : []
162     },
163     {
164       "name" : "xattr",
165       "type" : "Object",
166       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
167       "memberOf" : "Roo.bootstrap.Component",
168       "optvals" : []
169     },
170     {
171       "name" : "actionMode",
172       "type" : "String",
173       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
174       "memberOf" : "Roo.Component",
175       "optvals" : []
176     },
177     {
178       "name" : "specificTitle",
179       "type" : "Boolean",
180       "desc" : "default false",
181       "memberOf" : "Roo.bootstrap.Modal",
182       "optvals" : []
183     },
184     {
185       "name" : "width",
186       "type" : "Number",
187       "desc" : "fixed width - usefull for chrome extension only really.",
188       "memberOf" : "Roo.bootstrap.Modal",
189       "optvals" : []
190     },
191     {
192       "name" : "dataId",
193       "type" : "string",
194       "desc" : "cutomer id",
195       "memberOf" : "Roo.bootstrap.Component",
196       "optvals" : []
197     },
198     {
199       "name" : "allow_close",
200       "type" : "Boolean",
201       "desc" : "default true",
202       "memberOf" : "Roo.bootstrap.Modal",
203       "optvals" : []
204     },
205     {
206       "name" : "height",
207       "type" : "Number",
208       "desc" : "fixed height - usefull for chrome extension only really.",
209       "memberOf" : "Roo.bootstrap.Modal",
210       "optvals" : []
211     },
212     {
213       "name" : "size",
214       "type" : "String",
215       "desc" : "l) default empty",
216       "memberOf" : "Roo.bootstrap.Modal",
217       "optvals" : [
218         "sm",
219         "lg",
220         "xl"
221       ]
222     },
223     {
224       "name" : "name",
225       "type" : "string",
226       "desc" : "Specifies name attribute",
227       "memberOf" : "Roo.bootstrap.Component",
228       "optvals" : []
229     },
230     {
231       "name" : "disableClass",
232       "type" : "String",
233       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
234       "memberOf" : "Roo.Component",
235       "optvals" : []
236     },
237     {
238       "name" : "animate",
239       "type" : "Boolean",
240       "desc" : "default true",
241       "memberOf" : "Roo.bootstrap.Modal",
242       "optvals" : []
243     }
244   ],
245   "methods" : [
246     {
247       "name" : "applyBody",
248       "desc" : "Set the body of the Dialog using the template",
249       "isStatic" : false,
250       "isConstructor" : false,
251       "isPrivate" : false,
252       "memberOf" : "Roo.bootstrap.Modal",
253       "example" : "",
254       "deprecated" : "",
255       "since" : "",
256       "see" : "",
257       "params" : [
258         {
259           "name" : "data",
260           "type" : "Obj",
261           "desc" : "- apply this data to the template and replace the body contents.",
262           "isOptional" : false
263         }
264       ],
265       "returns" : []
266     },
267     {
268       "name" : "setTitle",
269       "desc" : "Set the title of the Dialog",
270       "isStatic" : false,
271       "isConstructor" : false,
272       "isPrivate" : false,
273       "memberOf" : "Roo.bootstrap.Modal",
274       "example" : "",
275       "deprecated" : "",
276       "since" : "",
277       "see" : "",
278       "params" : [
279         {
280           "name" : "str",
281           "type" : "String",
282           "desc" : "new Title",
283           "isOptional" : false
284         }
285       ],
286       "returns" : []
287     },
288     {
289       "name" : "setBody",
290       "desc" : "Set the body of the Dialog",
291       "isStatic" : false,
292       "isConstructor" : false,
293       "isPrivate" : false,
294       "memberOf" : "Roo.bootstrap.Modal",
295       "example" : "",
296       "deprecated" : "",
297       "since" : "",
298       "see" : "",
299       "params" : [
300         {
301           "name" : "str",
302           "type" : "String",
303           "desc" : "new Title",
304           "isOptional" : false
305         }
306       ],
307       "returns" : []
308     },
309     {
310       "name" : "tooltipEl",
311       "desc" : "Fetch the element to display the tooltip on.",
312       "isStatic" : false,
313       "isConstructor" : false,
314       "isPrivate" : false,
315       "memberOf" : "Roo.bootstrap.Component",
316       "example" : "",
317       "deprecated" : "",
318       "since" : "",
319       "see" : "",
320       "params" : [],
321       "returns" : [
322         {
323           "name" : "",
324           "type" : "Roo.Element",
325           "desc" : "defaults to this.el"
326         }
327       ]
328     },
329     {
330       "name" : "hide",
331       "desc" : "Hide a component - adds 'hidden' class",
332       "isStatic" : false,
333       "isConstructor" : false,
334       "isPrivate" : false,
335       "memberOf" : "Roo.bootstrap.Component",
336       "example" : "",
337       "deprecated" : "",
338       "since" : "",
339       "see" : "",
340       "params" : [],
341       "returns" : []
342     },
343     {
344       "name" : "show",
345       "desc" : "Show a component - removes 'hidden' class",
346       "isStatic" : false,
347       "isConstructor" : false,
348       "isPrivate" : false,
349       "memberOf" : "Roo.bootstrap.Component",
350       "example" : "",
351       "deprecated" : "",
352       "since" : "",
353       "see" : "",
354       "params" : [],
355       "returns" : []
356     },
357     {
358       "name" : "setVisibilityEl",
359       "desc" : "Set the element that will be used to show or hide",
360       "isStatic" : false,
361       "isConstructor" : false,
362       "isPrivate" : false,
363       "memberOf" : "Roo.bootstrap.Component",
364       "example" : "",
365       "deprecated" : "",
366       "since" : "",
367       "see" : "",
368       "params" : [],
369       "returns" : []
370     },
371     {
372       "name" : "getVisibilityEl",
373       "desc" : "Get the element that will be used to show or hide",
374       "isStatic" : false,
375       "isConstructor" : false,
376       "isPrivate" : false,
377       "memberOf" : "Roo.bootstrap.Component",
378       "example" : "",
379       "deprecated" : "",
380       "since" : "",
381       "see" : "",
382       "params" : [],
383       "returns" : []
384     },
385     {
386       "name" : "initEvents",
387       "desc" : "Initialize Events for the element",
388       "isStatic" : false,
389       "isConstructor" : false,
390       "isPrivate" : false,
391       "memberOf" : "Roo.bootstrap.Component",
392       "example" : "",
393       "deprecated" : "",
394       "since" : "",
395       "see" : "",
396       "params" : [],
397       "returns" : []
398     },
399     {
400       "name" : "getChildContainer",
401       "desc" : "Fetch the element to add children to",
402       "isStatic" : false,
403       "isConstructor" : false,
404       "isPrivate" : false,
405       "memberOf" : "Roo.bootstrap.Component",
406       "example" : "",
407       "deprecated" : "",
408       "since" : "",
409       "see" : "",
410       "params" : [],
411       "returns" : [
412         {
413           "name" : "",
414           "type" : "Roo.Element",
415           "desc" : "defaults to this.el"
416         }
417       ]
418     },
419     {
420       "name" : "getId",
421       "desc" : "Returns the id of this component.",
422       "isStatic" : false,
423       "isConstructor" : false,
424       "isPrivate" : false,
425       "memberOf" : "Roo.Component",
426       "example" : "",
427       "deprecated" : "",
428       "since" : "",
429       "see" : "",
430       "params" : [],
431       "returns" : [
432         {
433           "name" : "",
434           "type" : "String",
435           "desc" : ""
436         }
437       ]
438     },
439     {
440       "name" : "render",
441       "desc" : "If this is a lazy rendering component, render it to its container element.",
442       "isStatic" : false,
443       "isConstructor" : false,
444       "isPrivate" : false,
445       "memberOf" : "Roo.Component",
446       "example" : "",
447       "deprecated" : "",
448       "since" : "",
449       "see" : "",
450       "params" : [
451         {
452           "name" : "container",
453           "type" : "String/HTMLElement/Element",
454           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
455           "isOptional" : false
456         }
457       ],
458       "returns" : []
459     },
460     {
461       "name" : "destroy",
462       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
463       "isStatic" : false,
464       "isConstructor" : false,
465       "isPrivate" : false,
466       "memberOf" : "Roo.Component",
467       "example" : "",
468       "deprecated" : "",
469       "since" : "",
470       "see" : "",
471       "params" : [],
472       "returns" : []
473     },
474     {
475       "name" : "isVisible",
476       "desc" : "Returns true if this component is visible.",
477       "isStatic" : false,
478       "isConstructor" : false,
479       "isPrivate" : false,
480       "memberOf" : "Roo.Component",
481       "example" : "",
482       "deprecated" : "",
483       "since" : "",
484       "see" : "",
485       "params" : [],
486       "returns" : []
487     },
488     {
489       "name" : "setDisabled",
490       "desc" : "Convenience function for setting disabled/enabled by boolean.",
491       "isStatic" : false,
492       "isConstructor" : false,
493       "isPrivate" : false,
494       "memberOf" : "Roo.Component",
495       "example" : "",
496       "deprecated" : "",
497       "since" : "",
498       "see" : "",
499       "params" : [
500         {
501           "name" : "disabled",
502           "type" : "Boolean",
503           "desc" : "",
504           "isOptional" : false
505         }
506       ],
507       "returns" : []
508     },
509     {
510       "name" : "focus",
511       "desc" : "Try to focus this component.",
512       "isStatic" : false,
513       "isConstructor" : false,
514       "isPrivate" : false,
515       "memberOf" : "Roo.Component",
516       "example" : "",
517       "deprecated" : "",
518       "since" : "",
519       "see" : "",
520       "params" : [
521         {
522           "name" : "selectText",
523           "type" : "Boolean",
524           "desc" : "True to also select the text in this component (if applicable)",
525           "isOptional" : false
526         }
527       ],
528       "returns" : [
529         {
530           "name" : "",
531           "type" : "Roo.Component",
532           "desc" : "this"
533         }
534       ]
535     },
536     {
537       "name" : "enable",
538       "desc" : "Enable this component.",
539       "isStatic" : false,
540       "isConstructor" : false,
541       "isPrivate" : false,
542       "memberOf" : "Roo.Component",
543       "example" : "",
544       "deprecated" : "",
545       "since" : "",
546       "see" : "",
547       "params" : [],
548       "returns" : [
549         {
550           "name" : "",
551           "type" : "Roo.Component",
552           "desc" : "this"
553         }
554       ]
555     },
556     {
557       "name" : "setVisible",
558       "desc" : "Convenience function to hide or show this component by boolean.",
559       "isStatic" : false,
560       "isConstructor" : false,
561       "isPrivate" : false,
562       "memberOf" : "Roo.Component",
563       "example" : "",
564       "deprecated" : "",
565       "since" : "",
566       "see" : "",
567       "params" : [
568         {
569           "name" : "visible",
570           "type" : "Boolean",
571           "desc" : "True to show, false to hide",
572           "isOptional" : false
573         }
574       ],
575       "returns" : [
576         {
577           "name" : "",
578           "type" : "Roo.Component",
579           "desc" : "this"
580         }
581       ]
582     },
583     {
584       "name" : "disable",
585       "desc" : "Disable this component.",
586       "isStatic" : false,
587       "isConstructor" : false,
588       "isPrivate" : false,
589       "memberOf" : "Roo.Component",
590       "example" : "",
591       "deprecated" : "",
592       "since" : "",
593       "see" : "",
594       "params" : [],
595       "returns" : [
596         {
597           "name" : "",
598           "type" : "Roo.Component",
599           "desc" : "this"
600         }
601       ]
602     },
603     {
604       "name" : "getEl",
605       "desc" : "Returns the underlying {@link Roo.Element}.",
606       "isStatic" : false,
607       "isConstructor" : false,
608       "isPrivate" : false,
609       "memberOf" : "Roo.Component",
610       "example" : "",
611       "deprecated" : "",
612       "since" : "",
613       "see" : "",
614       "params" : [],
615       "returns" : [
616         {
617           "name" : "",
618           "type" : "Roo.Element",
619           "desc" : "The element"
620         }
621       ]
622     },
623     {
624       "name" : "purgeListeners",
625       "desc" : "Removes all listeners for this object",
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       "returns" : []
636     },
637     {
638       "name" : "on",
639       "desc" : "Appends an event handler to this element (shorthand for addListener)",
640       "isStatic" : false,
641       "isConstructor" : false,
642       "isPrivate" : false,
643       "memberOf" : "Roo.util.Observable",
644       "example" : "",
645       "deprecated" : "",
646       "since" : "",
647       "see" : "",
648       "params" : [
649         {
650           "name" : "eventName",
651           "type" : "String",
652           "desc" : "The type of event to listen for",
653           "isOptional" : false
654         },
655         {
656           "name" : "handler",
657           "type" : "Function",
658           "desc" : "The method the event invokes",
659           "isOptional" : false
660         },
661         {
662           "name" : "scope",
663           "type" : "Object",
664           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
665           "isOptional" : false
666         },
667         {
668           "name" : "options",
669           "type" : "Object",
670           "desc" : "(optional)",
671           "isOptional" : false
672         }
673       ],
674       "returns" : []
675     },
676     {
677       "name" : "un",
678       "desc" : "Removes a listener (shorthand for removeListener)",
679       "isStatic" : false,
680       "isConstructor" : false,
681       "isPrivate" : false,
682       "memberOf" : "Roo.util.Observable",
683       "example" : "",
684       "deprecated" : "",
685       "since" : "",
686       "see" : "",
687       "params" : [
688         {
689           "name" : "eventName",
690           "type" : "String",
691           "desc" : "The type of event to listen for",
692           "isOptional" : false
693         },
694         {
695           "name" : "handler",
696           "type" : "Function",
697           "desc" : "The handler to remove",
698           "isOptional" : false
699         },
700         {
701           "name" : "scope",
702           "type" : "Object",
703           "desc" : "(optional) The scope (this object) for the handler",
704           "isOptional" : false
705         }
706       ],
707       "returns" : []
708     },
709     {
710       "name" : "addEvents",
711       "desc" : "Used to define events on this Observable",
712       "isStatic" : false,
713       "isConstructor" : false,
714       "isPrivate" : false,
715       "memberOf" : "Roo.util.Observable",
716       "example" : "",
717       "deprecated" : "",
718       "since" : "",
719       "see" : "",
720       "params" : [
721         {
722           "name" : "object",
723           "type" : "Object",
724           "desc" : "The object with the events defined",
725           "isOptional" : false
726         }
727       ],
728       "returns" : []
729     },
730     {
731       "name" : "releaseCapture",
732       "desc" : "Removes <b>all</b> added captures from the Observable.",
733       "isStatic" : true,
734       "isConstructor" : false,
735       "isPrivate" : false,
736       "memberOf" : "Roo.util.Observable",
737       "example" : "",
738       "deprecated" : "",
739       "since" : "",
740       "see" : "",
741       "params" : [
742         {
743           "name" : "o",
744           "type" : "Observable",
745           "desc" : "The Observable to release",
746           "isOptional" : false
747         }
748       ],
749       "returns" : []
750     },
751     {
752       "name" : "removeListener",
753       "desc" : "Removes a listener",
754       "isStatic" : false,
755       "isConstructor" : false,
756       "isPrivate" : false,
757       "memberOf" : "Roo.util.Observable",
758       "example" : "",
759       "deprecated" : "",
760       "since" : "",
761       "see" : "",
762       "params" : [
763         {
764           "name" : "eventName",
765           "type" : "String",
766           "desc" : "The type of event to listen for",
767           "isOptional" : false
768         },
769         {
770           "name" : "handler",
771           "type" : "Function",
772           "desc" : "The handler to remove",
773           "isOptional" : false
774         },
775         {
776           "name" : "scope",
777           "type" : "Object",
778           "desc" : "(optional) The scope (this object) for the handler",
779           "isOptional" : false
780         }
781       ],
782       "returns" : []
783     },
784     {
785       "name" : "fireEvent",
786       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
787       "isStatic" : false,
788       "isConstructor" : false,
789       "isPrivate" : false,
790       "memberOf" : "Roo.util.Observable",
791       "example" : "",
792       "deprecated" : "",
793       "since" : "",
794       "see" : "",
795       "params" : [
796         {
797           "name" : "eventName",
798           "type" : "String",
799           "desc" : "",
800           "isOptional" : false
801         },
802         {
803           "name" : "args",
804           "type" : "Object...",
805           "desc" : "Variable number of parameters are passed to handlers",
806           "isOptional" : false
807         }
808       ],
809       "returns" : [
810         {
811           "name" : "",
812           "type" : "Boolean",
813           "desc" : "returns false if any of the handlers return false otherwise it returns true"
814         }
815       ]
816     },
817     {
818       "name" : "hasListener",
819       "desc" : "Checks to see if this object has any listeners for a specified event",
820       "isStatic" : false,
821       "isConstructor" : false,
822       "isPrivate" : false,
823       "memberOf" : "Roo.util.Observable",
824       "example" : "",
825       "deprecated" : "",
826       "since" : "",
827       "see" : "",
828       "params" : [
829         {
830           "name" : "eventName",
831           "type" : "String",
832           "desc" : "The name of the event to check for",
833           "isOptional" : false
834         }
835       ],
836       "returns" : [
837         {
838           "name" : "",
839           "type" : "Boolean",
840           "desc" : "True if the event is being listened for, else false"
841         }
842       ]
843     },
844     {
845       "name" : "capture",
846       "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.",
847       "isStatic" : true,
848       "isConstructor" : false,
849       "isPrivate" : false,
850       "memberOf" : "Roo.util.Observable",
851       "example" : "",
852       "deprecated" : "",
853       "since" : "",
854       "see" : "",
855       "params" : [
856         {
857           "name" : "o",
858           "type" : "Observable",
859           "desc" : "The Observable to capture",
860           "isOptional" : false
861         },
862         {
863           "name" : "fn",
864           "type" : "Function",
865           "desc" : "The function to call",
866           "isOptional" : false
867         },
868         {
869           "name" : "scope",
870           "type" : "Object",
871           "desc" : "(optional) The scope (this object) for the fn",
872           "isOptional" : false
873         }
874       ],
875       "returns" : []
876     },
877     {
878       "name" : "addListener",
879       "desc" : "Appends an event handler to this component",
880       "isStatic" : false,
881       "isConstructor" : false,
882       "isPrivate" : false,
883       "memberOf" : "Roo.util.Observable",
884       "example" : "",
885       "deprecated" : "",
886       "since" : "",
887       "see" : "",
888       "params" : [
889         {
890           "name" : "eventName",
891           "type" : "String",
892           "desc" : "The type of event to listen for",
893           "isOptional" : false
894         },
895         {
896           "name" : "handler",
897           "type" : "Function",
898           "desc" : "The method the event invokes",
899           "isOptional" : false
900         },
901         {
902           "name" : "scope",
903           "type" : "Object",
904           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
905           "isOptional" : false
906         },
907         {
908           "name" : "options",
909           "type" : "Object",
910           "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>",
911           "isOptional" : false
912         }
913       ],
914       "returns" : []
915     }
916   ],
917   "events" : [
918     {
919       "name" : "titlechanged",
920       "desc" : "Fire when the editable title has been changed",
921       "memberOf" : "Roo.bootstrap.Modal",
922       "example" : "",
923       "deprecated" : "",
924       "since" : "",
925       "see" : "",
926       "params" : [
927         {
928           "name" : "this",
929           "type" : "Roo.bootstrap.Modal",
930           "desc" : "",
931           "isOptional" : false
932         },
933         {
934           "name" : "value",
935           "type" : "Roo.EventObject",
936           "desc" : "",
937           "isOptional" : false
938         }
939       ],
940       "returns" : []
941     },
942     {
943       "name" : "btnclick",
944       "desc" : "The raw btnclick event for the button",
945       "memberOf" : "Roo.bootstrap.Modal",
946       "example" : "",
947       "deprecated" : "",
948       "since" : "",
949       "see" : "",
950       "params" : [
951         {
952           "name" : "e",
953           "type" : "Roo.EventObject",
954           "desc" : "",
955           "isOptional" : false
956         }
957       ],
958       "returns" : []
959     },
960     {
961       "name" : "resize",
962       "desc" : "Fire when dialog resize",
963       "memberOf" : "Roo.bootstrap.Modal",
964       "example" : "",
965       "deprecated" : "",
966       "since" : "",
967       "see" : "",
968       "params" : [
969         {
970           "name" : "this",
971           "type" : "Roo.bootstrap.Modal",
972           "desc" : "",
973           "isOptional" : false
974         },
975         {
976           "name" : "e",
977           "type" : "Roo.EventObject",
978           "desc" : "",
979           "isOptional" : false
980         }
981       ],
982       "returns" : []
983     },
984     {
985       "name" : "childrenrendered",
986       "desc" : "Fires when the children have been rendered..",
987       "memberOf" : "Roo.bootstrap.Component",
988       "example" : "",
989       "deprecated" : "",
990       "since" : "",
991       "see" : "",
992       "params" : [
993         {
994           "name" : "this",
995           "type" : "Roo.bootstrap.Component",
996           "desc" : "",
997           "isOptional" : false
998         }
999       ],
1000       "returns" : []
1001     },
1002     {
1003       "name" : "beforerender",
1004       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1005       "memberOf" : "Roo.Component",
1006       "example" : "",
1007       "deprecated" : "",
1008       "since" : "",
1009       "see" : "",
1010       "params" : [
1011         {
1012           "name" : "this",
1013           "type" : "Roo.Component",
1014           "desc" : "",
1015           "isOptional" : false
1016         }
1017       ],
1018       "returns" : []
1019     },
1020     {
1021       "name" : "disable",
1022       "desc" : "Fires after the component is disabled.",
1023       "memberOf" : "Roo.Component",
1024       "example" : "",
1025       "deprecated" : "",
1026       "since" : "",
1027       "see" : "",
1028       "params" : [
1029         {
1030           "name" : "this",
1031           "type" : "Roo.Component",
1032           "desc" : "",
1033           "isOptional" : false
1034         }
1035       ],
1036       "returns" : []
1037     },
1038     {
1039       "name" : "render",
1040       "desc" : "Fires after the component is rendered.",
1041       "memberOf" : "Roo.Component",
1042       "example" : "",
1043       "deprecated" : "",
1044       "since" : "",
1045       "see" : "",
1046       "params" : [
1047         {
1048           "name" : "this",
1049           "type" : "Roo.Component",
1050           "desc" : "",
1051           "isOptional" : false
1052         }
1053       ],
1054       "returns" : []
1055     },
1056     {
1057       "name" : "destroy",
1058       "desc" : "Fires after the component is destroyed.",
1059       "memberOf" : "Roo.Component",
1060       "example" : "",
1061       "deprecated" : "",
1062       "since" : "",
1063       "see" : "",
1064       "params" : [
1065         {
1066           "name" : "this",
1067           "type" : "Roo.Component",
1068           "desc" : "",
1069           "isOptional" : false
1070         }
1071       ],
1072       "returns" : []
1073     },
1074     {
1075       "name" : "hide",
1076       "desc" : "Fires after the component is hidden.",
1077       "memberOf" : "Roo.Component",
1078       "example" : "",
1079       "deprecated" : "",
1080       "since" : "",
1081       "see" : "",
1082       "params" : [
1083         {
1084           "name" : "this",
1085           "type" : "Roo.Component",
1086           "desc" : "",
1087           "isOptional" : false
1088         }
1089       ],
1090       "returns" : []
1091     },
1092     {
1093       "name" : "beforehide",
1094       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1095       "memberOf" : "Roo.Component",
1096       "example" : "",
1097       "deprecated" : "",
1098       "since" : "",
1099       "see" : "",
1100       "params" : [
1101         {
1102           "name" : "this",
1103           "type" : "Roo.Component",
1104           "desc" : "",
1105           "isOptional" : false
1106         }
1107       ],
1108       "returns" : []
1109     },
1110     {
1111       "name" : "show",
1112       "desc" : "Fires after the component is shown.",
1113       "memberOf" : "Roo.Component",
1114       "example" : "",
1115       "deprecated" : "",
1116       "since" : "",
1117       "see" : "",
1118       "params" : [
1119         {
1120           "name" : "this",
1121           "type" : "Roo.Component",
1122           "desc" : "",
1123           "isOptional" : false
1124         }
1125       ],
1126       "returns" : []
1127     },
1128     {
1129       "name" : "beforeshow",
1130       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1131       "memberOf" : "Roo.Component",
1132       "example" : "",
1133       "deprecated" : "",
1134       "since" : "",
1135       "see" : "",
1136       "params" : [
1137         {
1138           "name" : "this",
1139           "type" : "Roo.Component",
1140           "desc" : "",
1141           "isOptional" : false
1142         }
1143       ],
1144       "returns" : []
1145     },
1146     {
1147       "name" : "enable",
1148       "desc" : "Fires after the component is enabled.",
1149       "memberOf" : "Roo.Component",
1150       "example" : "",
1151       "deprecated" : "",
1152       "since" : "",
1153       "see" : "",
1154       "params" : [
1155         {
1156           "name" : "this",
1157           "type" : "Roo.Component",
1158           "desc" : "",
1159           "isOptional" : false
1160         }
1161       ],
1162       "returns" : []
1163     },
1164     {
1165       "name" : "beforedestroy",
1166       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1167       "memberOf" : "Roo.Component",
1168       "example" : "",
1169       "deprecated" : "",
1170       "since" : "",
1171       "see" : "",
1172       "params" : [
1173         {
1174           "name" : "this",
1175           "type" : "Roo.Component",
1176           "desc" : "",
1177           "isOptional" : false
1178         }
1179       ],
1180       "returns" : []
1181     }
1182   ]
1183 }