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