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