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