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