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