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