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