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