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