658d7d87486f0cbbed537af9e3dbc6e5e5e448db
[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" : "Roo.bootstrap.Popover"
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" : "Roo.bootstrap.Popover"
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" : "Roo.bootstrap.Popover"
146     },
147     {
148       "name" : "trigger",
149       "type" : "String",
150       "desc" : "click || hover (or false to trigger manually)",
151       "memberOf" : "Roo.bootstrap.Popover"
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" : "Roo.bootstrap.Popover"
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" : "Roo.bootstrap.Popover"
188     },
189     {
190       "name" : "html",
191       "type" : "String",
192       "desc" : "contents of the popover   (or false to use children..)",
193       "memberOf" : "Roo.bootstrap.Popover"
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" : "setTitle",
261       "type" : "function",
262       "desc" : "",
263       "sig" : "(the)",
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         {
277           "name" : "the",
278           "type" : "string",
279           "desc" : "title",
280           "isOptional" : false
281         }
282       ],
283       "returns" : []
284     },
285     {
286       "name" : "updatePosition",
287       "type" : "function",
288       "desc" : "fire this manually after loading a grid in the table for example",
289       "sig" : "((left|right|top|bottom), try)",
290       "static" : false,
291       "memberOf" : "",
292       "isStatic" : false,
293       "isConstructor" : false,
294       "isPrivate" : false,
295       "example" : "",
296       "deprecated" : "",
297       "since" : "",
298       "see" : "",
299       "exceptions" : "",
300       "requires" : "",
301       "params" : [
302         {
303           "name" : "(left|right|top|bottom)",
304           "type" : "string",
305           "desc" : "where to try and put it (use false to use the last one)",
306           "isOptional" : false
307         },
308         {
309           "name" : "try",
310           "type" : "Boolean",
311           "desc" : "and move it if we cant get right position.",
312           "isOptional" : false
313         }
314       ],
315       "returns" : []
316     },
317     {
318       "name" : "show",
319       "type" : "function",
320       "desc" : "Show the popover",
321       "sig" : "(-, (left|right|top|bottom))",
322       "static" : false,
323       "memberOf" : "",
324       "isStatic" : false,
325       "isConstructor" : false,
326       "isPrivate" : false,
327       "example" : "",
328       "deprecated" : "",
329       "since" : "",
330       "see" : "",
331       "exceptions" : "",
332       "requires" : "",
333       "params" : [
334         {
335           "name" : "-",
336           "type" : "Roo.Element|string|Boolean",
337           "desc" : "element to align and point to. (set align to [ pos, offset ])",
338           "isOptional" : false
339         },
340         {
341           "name" : "(left|right|top|bottom)",
342           "type" : "string",
343           "desc" : "position",
344           "isOptional" : false
345         }
346       ],
347       "returns" : []
348     },
349     {
350       "name" : "tooltipEl",
351       "type" : "function",
352       "desc" : "Fetch the element to display the tooltip on.",
353       "sig" : "()\n{\n\n}",
354       "static" : false,
355       "memberOf" : "Roo.bootstrap.Component",
356       "isStatic" : false,
357       "isConstructor" : false,
358       "isPrivate" : false,
359       "example" : "",
360       "deprecated" : "",
361       "since" : "",
362       "see" : "",
363       "exceptions" : "",
364       "requires" : "",
365       "params" : [],
366       "returns" : [
367         {
368           "name" : "",
369           "type" : "Roo.Element",
370           "desc" : "defaults to this.el"
371         }
372       ]
373     },
374     {
375       "name" : "hide",
376       "type" : "function",
377       "desc" : "Hide a component - adds 'hidden' class",
378       "sig" : "()\n{\n\n}",
379       "static" : false,
380       "memberOf" : "Roo.bootstrap.Component",
381       "isStatic" : false,
382       "isConstructor" : false,
383       "isPrivate" : false,
384       "example" : "",
385       "deprecated" : "",
386       "since" : "",
387       "see" : "",
388       "exceptions" : "",
389       "requires" : "",
390       "params" : [],
391       "returns" : []
392     },
393     {
394       "name" : "setVisibilityEl",
395       "type" : "function",
396       "desc" : "Set the element that will be used to show or hide",
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" : "getVisibilityEl",
414       "type" : "function",
415       "desc" : "Get 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" : "initEvents",
433       "type" : "function",
434       "desc" : "Initialize Events for the element",
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" : "getChildContainer",
452       "type" : "function",
453       "desc" : "Fetch the element to add children to",
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           "name" : "",
470           "type" : "Roo.Element",
471           "desc" : "defaults to this.el"
472         }
473       ]
474     },
475     {
476       "name" : "getId",
477       "type" : "function",
478       "desc" : "Returns the id of this component.",
479       "sig" : "()\n{\n\n}",
480       "static" : false,
481       "memberOf" : "Roo.Component",
482       "isStatic" : false,
483       "isConstructor" : false,
484       "isPrivate" : false,
485       "example" : "",
486       "deprecated" : "",
487       "since" : "",
488       "see" : "",
489       "exceptions" : "",
490       "requires" : "",
491       "params" : [],
492       "returns" : [
493         {
494           "name" : "",
495           "type" : "String",
496           "desc" : ""
497         }
498       ]
499     },
500     {
501       "name" : "render",
502       "type" : "function",
503       "desc" : "If this is a lazy rendering component, render it to its container element.",
504       "sig" : "(container)",
505       "static" : false,
506       "memberOf" : "Roo.Component",
507       "isStatic" : false,
508       "isConstructor" : false,
509       "isPrivate" : false,
510       "example" : "",
511       "deprecated" : "",
512       "since" : "",
513       "see" : "",
514       "exceptions" : "",
515       "requires" : "",
516       "params" : [
517         {
518           "name" : "container",
519           "type" : "String/HTMLElement/Element",
520           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
521           "isOptional" : false
522         }
523       ],
524       "returns" : []
525     },
526     {
527       "name" : "destroy",
528       "type" : "function",
529       "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}.",
530       "sig" : "()\n{\n\n}",
531       "static" : false,
532       "memberOf" : "Roo.Component",
533       "isStatic" : false,
534       "isConstructor" : false,
535       "isPrivate" : false,
536       "example" : "",
537       "deprecated" : "",
538       "since" : "",
539       "see" : "",
540       "exceptions" : "",
541       "requires" : "",
542       "params" : [],
543       "returns" : []
544     },
545     {
546       "name" : "isVisible",
547       "type" : "function",
548       "desc" : "Returns true if this component is visible.",
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" : "setDisabled",
566       "type" : "function",
567       "desc" : "Convenience function for setting disabled/enabled by boolean.",
568       "sig" : "(disabled)",
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         {
582           "name" : "disabled",
583           "type" : "Boolean",
584           "desc" : "",
585           "isOptional" : false
586         }
587       ],
588       "returns" : []
589     },
590     {
591       "name" : "focus",
592       "type" : "function",
593       "desc" : "Try to focus this component.",
594       "sig" : "(selectText)",
595       "static" : false,
596       "memberOf" : "Roo.Component",
597       "isStatic" : false,
598       "isConstructor" : false,
599       "isPrivate" : false,
600       "example" : "",
601       "deprecated" : "",
602       "since" : "",
603       "see" : "",
604       "exceptions" : "",
605       "requires" : "",
606       "params" : [
607         {
608           "name" : "selectText",
609           "type" : "Boolean",
610           "desc" : "True to also select the text in this component (if applicable)",
611           "isOptional" : false
612         }
613       ],
614       "returns" : [
615         {
616           "name" : "",
617           "type" : "Roo.Component",
618           "desc" : "this"
619         }
620       ]
621     },
622     {
623       "name" : "enable",
624       "type" : "function",
625       "desc" : "Enable this component.",
626       "sig" : "()\n{\n\n}",
627       "static" : false,
628       "memberOf" : "Roo.Component",
629       "isStatic" : false,
630       "isConstructor" : false,
631       "isPrivate" : false,
632       "example" : "",
633       "deprecated" : "",
634       "since" : "",
635       "see" : "",
636       "exceptions" : "",
637       "requires" : "",
638       "params" : [],
639       "returns" : [
640         {
641           "name" : "",
642           "type" : "Roo.Component",
643           "desc" : "this"
644         }
645       ]
646     },
647     {
648       "name" : "setVisible",
649       "type" : "function",
650       "desc" : "Convenience function to hide or show this component by boolean.",
651       "sig" : "(visible)",
652       "static" : false,
653       "memberOf" : "Roo.Component",
654       "isStatic" : false,
655       "isConstructor" : false,
656       "isPrivate" : false,
657       "example" : "",
658       "deprecated" : "",
659       "since" : "",
660       "see" : "",
661       "exceptions" : "",
662       "requires" : "",
663       "params" : [
664         {
665           "name" : "visible",
666           "type" : "Boolean",
667           "desc" : "True to show, false to hide",
668           "isOptional" : false
669         }
670       ],
671       "returns" : [
672         {
673           "name" : "",
674           "type" : "Roo.Component",
675           "desc" : "this"
676         }
677       ]
678     },
679     {
680       "name" : "disable",
681       "type" : "function",
682       "desc" : "Disable this component.",
683       "sig" : "()\n{\n\n}",
684       "static" : false,
685       "memberOf" : "Roo.Component",
686       "isStatic" : false,
687       "isConstructor" : false,
688       "isPrivate" : false,
689       "example" : "",
690       "deprecated" : "",
691       "since" : "",
692       "see" : "",
693       "exceptions" : "",
694       "requires" : "",
695       "params" : [],
696       "returns" : [
697         {
698           "name" : "",
699           "type" : "Roo.Component",
700           "desc" : "this"
701         }
702       ]
703     },
704     {
705       "name" : "getEl",
706       "type" : "function",
707       "desc" : "Returns the underlying {@link Roo.Element}.",
708       "sig" : "()\n{\n\n}",
709       "static" : false,
710       "memberOf" : "Roo.Component",
711       "isStatic" : false,
712       "isConstructor" : false,
713       "isPrivate" : false,
714       "example" : "",
715       "deprecated" : "",
716       "since" : "",
717       "see" : "",
718       "exceptions" : "",
719       "requires" : "",
720       "params" : [],
721       "returns" : [
722         {
723           "name" : "",
724           "type" : "Roo.Element",
725           "desc" : "The element"
726         }
727       ]
728     },
729     {
730       "name" : "purgeListeners",
731       "type" : "function",
732       "desc" : "Removes all listeners for this object",
733       "sig" : "()\n{\n\n}",
734       "static" : false,
735       "memberOf" : "Roo.util.Observable",
736       "isStatic" : false,
737       "isConstructor" : false,
738       "isPrivate" : false,
739       "example" : "",
740       "deprecated" : "",
741       "since" : "",
742       "see" : "",
743       "exceptions" : "",
744       "requires" : "",
745       "params" : [],
746       "returns" : []
747     },
748     {
749       "name" : "on",
750       "type" : "function",
751       "desc" : "Appends an event handler to this element (shorthand for addListener)",
752       "sig" : "(eventName, handler, scope, options)",
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         {
766           "name" : "eventName",
767           "type" : "String",
768           "desc" : "The type of event to listen for",
769           "isOptional" : false
770         },
771         {
772           "name" : "handler",
773           "type" : "Function",
774           "desc" : "The method the event invokes",
775           "isOptional" : false
776         },
777         {
778           "name" : "scope",
779           "type" : "Object",
780           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
781           "isOptional" : false
782         },
783         {
784           "name" : "options",
785           "type" : "Object",
786           "desc" : "(optional)",
787           "isOptional" : false
788         }
789       ],
790       "returns" : []
791     },
792     {
793       "name" : "un",
794       "type" : "function",
795       "desc" : "Removes a listener (shorthand for removeListener)",
796       "sig" : "(eventName, handler, scope)",
797       "static" : false,
798       "memberOf" : "Roo.util.Observable",
799       "isStatic" : false,
800       "isConstructor" : false,
801       "isPrivate" : false,
802       "example" : "",
803       "deprecated" : "",
804       "since" : "",
805       "see" : "",
806       "exceptions" : "",
807       "requires" : "",
808       "params" : [
809         {
810           "name" : "eventName",
811           "type" : "String",
812           "desc" : "The type of event to listen for",
813           "isOptional" : false
814         },
815         {
816           "name" : "handler",
817           "type" : "Function",
818           "desc" : "The handler to remove",
819           "isOptional" : false
820         },
821         {
822           "name" : "scope",
823           "type" : "Object",
824           "desc" : "(optional) The scope (this object) for the handler",
825           "isOptional" : false
826         }
827       ],
828       "returns" : []
829     },
830     {
831       "name" : "addEvents",
832       "type" : "function",
833       "desc" : "Used to define events on this Observable",
834       "sig" : "(object)",
835       "static" : false,
836       "memberOf" : "Roo.util.Observable",
837       "isStatic" : false,
838       "isConstructor" : false,
839       "isPrivate" : false,
840       "example" : "",
841       "deprecated" : "",
842       "since" : "",
843       "see" : "",
844       "exceptions" : "",
845       "requires" : "",
846       "params" : [
847         {
848           "name" : "object",
849           "type" : "Object",
850           "desc" : "The object with the events defined",
851           "isOptional" : false
852         }
853       ],
854       "returns" : []
855     },
856     {
857       "name" : "releaseCapture",
858       "type" : "function",
859       "desc" : "Removes <b>all</b> added captures from the Observable.",
860       "sig" : "(o)",
861       "static" : true,
862       "memberOf" : "Roo.util.Observable",
863       "isStatic" : true,
864       "isConstructor" : false,
865       "isPrivate" : false,
866       "example" : "",
867       "deprecated" : "",
868       "since" : "",
869       "see" : "",
870       "exceptions" : "",
871       "requires" : "",
872       "params" : [
873         {
874           "name" : "o",
875           "type" : "Observable",
876           "desc" : "The Observable to release",
877           "isOptional" : false
878         }
879       ],
880       "returns" : []
881     },
882     {
883       "name" : "removeListener",
884       "type" : "function",
885       "desc" : "Removes a listener",
886       "sig" : "(eventName, handler, scope)",
887       "static" : false,
888       "memberOf" : "Roo.util.Observable",
889       "isStatic" : false,
890       "isConstructor" : false,
891       "isPrivate" : false,
892       "example" : "",
893       "deprecated" : "",
894       "since" : "",
895       "see" : "",
896       "exceptions" : "",
897       "requires" : "",
898       "params" : [
899         {
900           "name" : "eventName",
901           "type" : "String",
902           "desc" : "The type of event to listen for",
903           "isOptional" : false
904         },
905         {
906           "name" : "handler",
907           "type" : "Function",
908           "desc" : "The handler to remove",
909           "isOptional" : false
910         },
911         {
912           "name" : "scope",
913           "type" : "Object",
914           "desc" : "(optional) The scope (this object) for the handler",
915           "isOptional" : false
916         }
917       ],
918       "returns" : []
919     },
920     {
921       "name" : "fireEvent",
922       "type" : "function",
923       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
924       "sig" : "(eventName, args)",
925       "static" : false,
926       "memberOf" : "Roo.util.Observable",
927       "isStatic" : false,
928       "isConstructor" : false,
929       "isPrivate" : false,
930       "example" : "",
931       "deprecated" : "",
932       "since" : "",
933       "see" : "",
934       "exceptions" : "",
935       "requires" : "",
936       "params" : [
937         {
938           "name" : "eventName",
939           "type" : "String",
940           "desc" : "",
941           "isOptional" : false
942         },
943         {
944           "name" : "args",
945           "type" : "Object...",
946           "desc" : "Variable number of parameters are passed to handlers",
947           "isOptional" : false
948         }
949       ],
950       "returns" : [
951         {
952           "name" : "",
953           "type" : "Boolean",
954           "desc" : "returns false if any of the handlers return false otherwise it returns true"
955         }
956       ]
957     },
958     {
959       "name" : "hasListener",
960       "type" : "function",
961       "desc" : "Checks to see if this object has any listeners for a specified event",
962       "sig" : "(eventName)",
963       "static" : false,
964       "memberOf" : "Roo.util.Observable",
965       "isStatic" : false,
966       "isConstructor" : false,
967       "isPrivate" : false,
968       "example" : "",
969       "deprecated" : "",
970       "since" : "",
971       "see" : "",
972       "exceptions" : "",
973       "requires" : "",
974       "params" : [
975         {
976           "name" : "eventName",
977           "type" : "String",
978           "desc" : "The name of the event to check for",
979           "isOptional" : false
980         }
981       ],
982       "returns" : [
983         {
984           "name" : "",
985           "type" : "Boolean",
986           "desc" : "True if the event is being listened for, else false"
987         }
988       ]
989     },
990     {
991       "name" : "capture",
992       "type" : "function",
993       "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.",
994       "sig" : "(o, fn, scope)",
995       "static" : true,
996       "memberOf" : "Roo.util.Observable",
997       "isStatic" : true,
998       "isConstructor" : false,
999       "isPrivate" : false,
1000       "example" : "",
1001       "deprecated" : "",
1002       "since" : "",
1003       "see" : "",
1004       "exceptions" : "",
1005       "requires" : "",
1006       "params" : [
1007         {
1008           "name" : "o",
1009           "type" : "Observable",
1010           "desc" : "The Observable to capture",
1011           "isOptional" : false
1012         },
1013         {
1014           "name" : "fn",
1015           "type" : "Function",
1016           "desc" : "The function to call",
1017           "isOptional" : false
1018         },
1019         {
1020           "name" : "scope",
1021           "type" : "Object",
1022           "desc" : "(optional) The scope (this object) for the fn",
1023           "isOptional" : false
1024         }
1025       ],
1026       "returns" : []
1027     },
1028     {
1029       "name" : "addListener",
1030       "type" : "function",
1031       "desc" : "Appends an event handler to this component",
1032       "sig" : "(eventName, handler, scope, options)",
1033       "static" : false,
1034       "memberOf" : "Roo.util.Observable",
1035       "isStatic" : false,
1036       "isConstructor" : false,
1037       "isPrivate" : false,
1038       "example" : "",
1039       "deprecated" : "",
1040       "since" : "",
1041       "see" : "",
1042       "exceptions" : "",
1043       "requires" : "",
1044       "params" : [
1045         {
1046           "name" : "eventName",
1047           "type" : "String",
1048           "desc" : "The type of event to listen for",
1049           "isOptional" : false
1050         },
1051         {
1052           "name" : "handler",
1053           "type" : "Function",
1054           "desc" : "The method the event invokes",
1055           "isOptional" : false
1056         },
1057         {
1058           "name" : "scope",
1059           "type" : "Object",
1060           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1061           "isOptional" : false
1062         },
1063         {
1064           "name" : "options",
1065           "type" : "Object",
1066           "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>",
1067           "isOptional" : false
1068         }
1069       ],
1070       "returns" : []
1071     }
1072   ],
1073   "events" : [
1074     {
1075       "name" : "hide",
1076       "type" : "function",
1077       "desc" : "After the popover hide",
1078       "sig" : "function (_self)\n{\n\n}",
1079       "memberOf" : "",
1080       "example" : "",
1081       "deprecated" : "",
1082       "since" : "",
1083       "see" : "",
1084       "params" : [
1085         {
1086           "name" : "this",
1087           "type" : "Roo.bootstrap.Popover",
1088           "desc" : "",
1089           "isOptional" : false
1090         }
1091       ],
1092       "returns" : []
1093     },
1094     {
1095       "name" : "show",
1096       "type" : "function",
1097       "desc" : "After the popover show",
1098       "sig" : "function (_self)\n{\n\n}",
1099       "memberOf" : "",
1100       "example" : "",
1101       "deprecated" : "",
1102       "since" : "",
1103       "see" : "",
1104       "params" : [
1105         {
1106           "name" : "this",
1107           "type" : "Roo.bootstrap.Popover",
1108           "desc" : "",
1109           "isOptional" : false
1110         }
1111       ],
1112       "returns" : []
1113     },
1114     {
1115       "name" : "childrenrendered",
1116       "type" : "function",
1117       "desc" : "Fires when the children have been rendered..",
1118       "sig" : "function (_self)\n{\n\n}",
1119       "memberOf" : "Roo.bootstrap.Component",
1120       "example" : "",
1121       "deprecated" : "",
1122       "since" : "",
1123       "see" : "",
1124       "params" : [
1125         {
1126           "name" : "this",
1127           "type" : "Roo.bootstrap.Component",
1128           "desc" : "",
1129           "isOptional" : false
1130         }
1131       ],
1132       "returns" : []
1133     },
1134     {
1135       "name" : "beforerender",
1136       "type" : "function",
1137       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1138       "sig" : "function (_self)\n{\n\n}",
1139       "memberOf" : "Roo.Component",
1140       "example" : "",
1141       "deprecated" : "",
1142       "since" : "",
1143       "see" : "",
1144       "params" : [
1145         {
1146           "name" : "this",
1147           "type" : "Roo.Component",
1148           "desc" : "",
1149           "isOptional" : false
1150         }
1151       ],
1152       "returns" : []
1153     },
1154     {
1155       "name" : "disable",
1156       "type" : "function",
1157       "desc" : "Fires after the component is disabled.",
1158       "sig" : "function (_self)\n{\n\n}",
1159       "memberOf" : "Roo.Component",
1160       "example" : "",
1161       "deprecated" : "",
1162       "since" : "",
1163       "see" : "",
1164       "params" : [
1165         {
1166           "name" : "this",
1167           "type" : "Roo.Component",
1168           "desc" : "",
1169           "isOptional" : false
1170         }
1171       ],
1172       "returns" : []
1173     },
1174     {
1175       "name" : "render",
1176       "type" : "function",
1177       "desc" : "Fires after the component is rendered.",
1178       "sig" : "function (_self)\n{\n\n}",
1179       "memberOf" : "Roo.Component",
1180       "example" : "",
1181       "deprecated" : "",
1182       "since" : "",
1183       "see" : "",
1184       "params" : [
1185         {
1186           "name" : "this",
1187           "type" : "Roo.Component",
1188           "desc" : "",
1189           "isOptional" : false
1190         }
1191       ],
1192       "returns" : []
1193     },
1194     {
1195       "name" : "destroy",
1196       "type" : "function",
1197       "desc" : "Fires after the component is destroyed.",
1198       "sig" : "function (_self)\n{\n\n}",
1199       "memberOf" : "Roo.Component",
1200       "example" : "",
1201       "deprecated" : "",
1202       "since" : "",
1203       "see" : "",
1204       "params" : [
1205         {
1206           "name" : "this",
1207           "type" : "Roo.Component",
1208           "desc" : "",
1209           "isOptional" : false
1210         }
1211       ],
1212       "returns" : []
1213     },
1214     {
1215       "name" : "beforehide",
1216       "type" : "function",
1217       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1218       "sig" : "function (_self)\n{\n\n}",
1219       "memberOf" : "Roo.Component",
1220       "example" : "",
1221       "deprecated" : "",
1222       "since" : "",
1223       "see" : "",
1224       "params" : [
1225         {
1226           "name" : "this",
1227           "type" : "Roo.Component",
1228           "desc" : "",
1229           "isOptional" : false
1230         }
1231       ],
1232       "returns" : []
1233     },
1234     {
1235       "name" : "beforeshow",
1236       "type" : "function",
1237       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1238       "sig" : "function (_self)\n{\n\n}",
1239       "memberOf" : "Roo.Component",
1240       "example" : "",
1241       "deprecated" : "",
1242       "since" : "",
1243       "see" : "",
1244       "params" : [
1245         {
1246           "name" : "this",
1247           "type" : "Roo.Component",
1248           "desc" : "",
1249           "isOptional" : false
1250         }
1251       ],
1252       "returns" : []
1253     },
1254     {
1255       "name" : "enable",
1256       "type" : "function",
1257       "desc" : "Fires after the component is enabled.",
1258       "sig" : "function (_self)\n{\n\n}",
1259       "memberOf" : "Roo.Component",
1260       "example" : "",
1261       "deprecated" : "",
1262       "since" : "",
1263       "see" : "",
1264       "params" : [
1265         {
1266           "name" : "this",
1267           "type" : "Roo.Component",
1268           "desc" : "",
1269           "isOptional" : false
1270         }
1271       ],
1272       "returns" : []
1273     },
1274     {
1275       "name" : "beforedestroy",
1276       "type" : "function",
1277       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1278       "sig" : "function (_self)\n{\n\n}",
1279       "memberOf" : "Roo.Component",
1280       "example" : "",
1281       "deprecated" : "",
1282       "since" : "",
1283       "see" : "",
1284       "params" : [
1285         {
1286           "name" : "this",
1287           "type" : "Roo.Component",
1288           "desc" : "",
1289           "isOptional" : false
1290         }
1291       ],
1292       "returns" : []
1293     }
1294   ]
1295 }