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