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