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