fix docs add optvalues
[roojs1] / docs / symbols / Roo.menu.DateMenu.json
1 {
2   "name" : "Roo.menu.DateMenu",
3   "augments" : [
4     "Roo.menu.Menu",
5     "Roo.util.Observable"
6   ],
7   "childClasses" : {  },
8   "tree_children" : [],
9   "tree_parent" : [],
10   "desc" : "A menu containing a {@link Roo.menu.DateItem} component (which provides a date picker).",
11   "isSingleton" : false,
12   "isStatic" : false,
13   "isBuiltin" : false,
14   "isAbstract" : false,
15   "isBuilderTop" : false,
16   "memberOf" : "DateMenu",
17   "example" : "",
18   "deprecated" : "",
19   "since" : "",
20   "see" : "",
21   "params" : [
22     {
23       "name" : "config",
24       "type" : "Object",
25       "desc" : "Configuration options",
26       "isOptional" : false
27     }
28   ],
29   "returns" : [],
30   "throws" : "",
31   "requires" : "",
32   "config" : [
33     {
34       "name" : "listeners",
35       "type" : "Object",
36       "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>",
37       "memberOf" : "Roo.util.Observable",
38       "isOptional" : false,
39       "optvalues" : []
40     },
41     {
42       "name" : "shadow",
43       "type" : "Boolean/String",
44       "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
45       "memberOf" : "Roo.menu.Menu",
46       "isOptional" : false,
47       "optvalues" : []
48     },
49     {
50       "name" : "defaultAlign",
51       "type" : "String",
52       "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
53       "memberOf" : "Roo.menu.Menu",
54       "isOptional" : false,
55       "optvalues" : []
56     },
57     {
58       "name" : "subMenuAlign",
59       "type" : "String",
60       "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
61       "memberOf" : "Roo.menu.Menu",
62       "isOptional" : false,
63       "optvalues" : []
64     },
65     {
66       "name" : "minWidth",
67       "type" : "Number",
68       "desc" : "The minimum width of the menu in pixels (defaults to 120)",
69       "memberOf" : "Roo.menu.Menu",
70       "isOptional" : false,
71       "optvalues" : []
72     },
73     {
74       "name" : "registerMenu",
75       "type" : "Boolean",
76       "desc" : "True (default) - means that clicking on screen etc. hides it.",
77       "memberOf" : "Roo.menu.Menu",
78       "isOptional" : false,
79       "optvalues" : []
80     },
81     {
82       "name" : "allowOtherMenus",
83       "type" : "Boolean",
84       "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
85       "memberOf" : "Roo.menu.Menu",
86       "isOptional" : false,
87       "optvalues" : []
88     }
89   ],
90   "methods" : [
91     {
92       "name" : "addMenuItem",
93       "type" : "function",
94       "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
95       "sig" : "(config)",
96       "static" : false,
97       "memberOf" : "Roo.menu.Menu",
98       "isStatic" : false,
99       "isConstructor" : false,
100       "isPrivate" : false,
101       "example" : "",
102       "deprecated" : "",
103       "since" : "",
104       "see" : "",
105       "exceptions" : "",
106       "requires" : "",
107       "params" : [
108         {
109           "name" : "config",
110           "type" : "Object",
111           "desc" : "A MenuItem config object",
112           "isOptional" : false
113         }
114       ],
115       "returns" : [
116         {
117           "name" : "",
118           "type" : "Roo.menu.Item",
119           "desc" : "The menu item that was added"
120         }
121       ]
122     },
123     {
124       "name" : "addElement",
125       "type" : "function",
126       "desc" : "Adds an {@link Roo.Element} object to the menu",
127       "sig" : "(el)",
128       "static" : false,
129       "memberOf" : "Roo.menu.Menu",
130       "isStatic" : false,
131       "isConstructor" : false,
132       "isPrivate" : false,
133       "example" : "",
134       "deprecated" : "",
135       "since" : "",
136       "see" : "",
137       "exceptions" : "",
138       "requires" : "",
139       "params" : [
140         {
141           "name" : "el",
142           "type" : "String/HTMLElement/Roo.Element",
143           "desc" : "The element or DOM node to add, or its id",
144           "isOptional" : false
145         }
146       ],
147       "returns" : [
148         {
149           "name" : "",
150           "type" : "Roo.menu.Item",
151           "desc" : "The menu item that was added"
152         }
153       ]
154     },
155     {
156       "name" : "isVisible",
157       "type" : "function",
158       "desc" : "Read-only.  Returns true if the menu is currently displayed, else false.",
159       "sig" : "()\n{\n\n}",
160       "static" : false,
161       "memberOf" : "Roo.menu.Menu",
162       "isStatic" : false,
163       "isConstructor" : false,
164       "isPrivate" : false,
165       "example" : "",
166       "deprecated" : "",
167       "since" : "",
168       "see" : "",
169       "exceptions" : "",
170       "requires" : "",
171       "params" : [],
172       "returns" : []
173     },
174     {
175       "name" : "add",
176       "type" : "function",
177       "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n<ul>\n<li>Any menu item object based on {@link Roo.menu.Item}</li>\n<li>An HTMLElement object which will be converted to a menu item</li>\n<li>A menu item config object that will be created as a new menu item</li>\n<li>A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added</li>\n</ul>\nUsage:\n<pre><code>\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n</code></pre>",
178       "sig" : "(args)",
179       "static" : false,
180       "memberOf" : "Roo.menu.Menu",
181       "isStatic" : false,
182       "isConstructor" : false,
183       "isPrivate" : false,
184       "example" : "",
185       "deprecated" : "",
186       "since" : "",
187       "see" : "",
188       "exceptions" : "",
189       "requires" : "",
190       "params" : [
191         {
192           "name" : "args",
193           "type" : "Mixed",
194           "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
195           "isOptional" : false
196         }
197       ],
198       "returns" : [
199         {
200           "name" : "",
201           "type" : "Roo.menu.Item",
202           "desc" : "The menu item that was added, or the last one if multiple items were added"
203         }
204       ]
205     },
206     {
207       "name" : "addSeparator",
208       "type" : "function",
209       "desc" : "Adds a separator bar to the menu",
210       "sig" : "()\n{\n\n}",
211       "static" : false,
212       "memberOf" : "Roo.menu.Menu",
213       "isStatic" : false,
214       "isConstructor" : false,
215       "isPrivate" : false,
216       "example" : "",
217       "deprecated" : "",
218       "since" : "",
219       "see" : "",
220       "exceptions" : "",
221       "requires" : "",
222       "params" : [],
223       "returns" : [
224         {
225           "name" : "",
226           "type" : "Roo.menu.Item",
227           "desc" : "The menu item that was added"
228         }
229       ]
230     },
231     {
232       "name" : "removeAll",
233       "type" : "function",
234       "desc" : "Removes and destroys all items in the menu",
235       "sig" : "()\n{\n\n}",
236       "static" : false,
237       "memberOf" : "Roo.menu.Menu",
238       "isStatic" : false,
239       "isConstructor" : false,
240       "isPrivate" : false,
241       "example" : "",
242       "deprecated" : "",
243       "since" : "",
244       "see" : "",
245       "exceptions" : "",
246       "requires" : "",
247       "params" : [],
248       "returns" : []
249     },
250     {
251       "name" : "remove",
252       "type" : "function",
253       "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
254       "sig" : "(item)",
255       "static" : false,
256       "memberOf" : "Roo.menu.Menu",
257       "isStatic" : false,
258       "isConstructor" : false,
259       "isPrivate" : false,
260       "example" : "",
261       "deprecated" : "",
262       "since" : "",
263       "see" : "",
264       "exceptions" : "",
265       "requires" : "",
266       "params" : [
267         {
268           "name" : "item",
269           "type" : "Roo.menu.Item",
270           "desc" : "The menu item to remove",
271           "isOptional" : false
272         }
273       ],
274       "returns" : []
275     },
276     {
277       "name" : "getEl",
278       "type" : "function",
279       "desc" : "Returns this menu's underlying {@link Roo.Element} object",
280       "sig" : "()\n{\n\n}",
281       "static" : false,
282       "memberOf" : "Roo.menu.Menu",
283       "isStatic" : false,
284       "isConstructor" : false,
285       "isPrivate" : false,
286       "example" : "",
287       "deprecated" : "",
288       "since" : "",
289       "see" : "",
290       "exceptions" : "",
291       "requires" : "",
292       "params" : [],
293       "returns" : [
294         {
295           "name" : "",
296           "type" : "Roo.Element",
297           "desc" : "The element"
298         }
299       ]
300     },
301     {
302       "name" : "insert",
303       "type" : "function",
304       "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
305       "sig" : "(index, item)",
306       "static" : false,
307       "memberOf" : "Roo.menu.Menu",
308       "isStatic" : false,
309       "isConstructor" : false,
310       "isPrivate" : false,
311       "example" : "",
312       "deprecated" : "",
313       "since" : "",
314       "see" : "",
315       "exceptions" : "",
316       "requires" : "",
317       "params" : [
318         {
319           "name" : "index",
320           "type" : "Number",
321           "desc" : "The index in the menu's list of current items where the new item should be inserted",
322           "isOptional" : false
323         },
324         {
325           "name" : "item",
326           "type" : "Roo.menu.Item",
327           "desc" : "The menu item to add",
328           "isOptional" : false
329         }
330       ],
331       "returns" : [
332         {
333           "name" : "",
334           "type" : "Roo.menu.Item",
335           "desc" : "The menu item that was added"
336         }
337       ]
338     },
339     {
340       "name" : "hide",
341       "type" : "function",
342       "desc" : "Hides this menu and optionally all parent menus",
343       "sig" : "(deep)",
344       "static" : false,
345       "memberOf" : "Roo.menu.Menu",
346       "isStatic" : false,
347       "isConstructor" : false,
348       "isPrivate" : false,
349       "example" : "",
350       "deprecated" : "",
351       "since" : "",
352       "see" : "",
353       "exceptions" : "",
354       "requires" : "",
355       "params" : [
356         {
357           "name" : "deep",
358           "type" : "Boolean",
359           "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
360           "isOptional" : false
361         }
362       ],
363       "returns" : []
364     },
365     {
366       "name" : "show",
367       "type" : "function",
368       "desc" : "Displays this menu relative to another element",
369       "sig" : "(element, position, parentMenu)",
370       "static" : false,
371       "memberOf" : "Roo.menu.Menu",
372       "isStatic" : false,
373       "isConstructor" : false,
374       "isPrivate" : false,
375       "example" : "",
376       "deprecated" : "",
377       "since" : "",
378       "see" : "",
379       "exceptions" : "",
380       "requires" : "",
381       "params" : [
382         {
383           "name" : "element",
384           "type" : "String/HTMLElement/Roo.Element",
385           "desc" : "The element to align to",
386           "isOptional" : false
387         },
388         {
389           "name" : "position",
390           "type" : "String",
391           "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
392           "isOptional" : false
393         },
394         {
395           "name" : "parentMenu",
396           "type" : "Roo.menu.Menu",
397           "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
398           "isOptional" : false
399         }
400       ],
401       "returns" : []
402     },
403     {
404       "name" : "addText",
405       "type" : "function",
406       "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
407       "sig" : "(text)",
408       "static" : false,
409       "memberOf" : "Roo.menu.Menu",
410       "isStatic" : false,
411       "isConstructor" : false,
412       "isPrivate" : false,
413       "example" : "",
414       "deprecated" : "",
415       "since" : "",
416       "see" : "",
417       "exceptions" : "",
418       "requires" : "",
419       "params" : [
420         {
421           "name" : "text",
422           "type" : "String",
423           "desc" : "The text to display in the menu item",
424           "isOptional" : false
425         }
426       ],
427       "returns" : [
428         {
429           "name" : "",
430           "type" : "Roo.menu.Item",
431           "desc" : "The menu item that was added"
432         }
433       ]
434     },
435     {
436       "name" : "addItem",
437       "type" : "function",
438       "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
439       "sig" : "(item)",
440       "static" : false,
441       "memberOf" : "Roo.menu.Menu",
442       "isStatic" : false,
443       "isConstructor" : false,
444       "isPrivate" : false,
445       "example" : "",
446       "deprecated" : "",
447       "since" : "",
448       "see" : "",
449       "exceptions" : "",
450       "requires" : "",
451       "params" : [
452         {
453           "name" : "item",
454           "type" : "Roo.menu.Item",
455           "desc" : "The menu item to add",
456           "isOptional" : false
457         }
458       ],
459       "returns" : [
460         {
461           "name" : "",
462           "type" : "Roo.menu.Item",
463           "desc" : "The menu item that was added"
464         }
465       ]
466     },
467     {
468       "name" : "showAt",
469       "type" : "function",
470       "desc" : "Displays this menu at a specific xy position",
471       "sig" : "(xyPosition, parentMenu)",
472       "static" : false,
473       "memberOf" : "Roo.menu.Menu",
474       "isStatic" : false,
475       "isConstructor" : false,
476       "isPrivate" : false,
477       "example" : "",
478       "deprecated" : "",
479       "since" : "",
480       "see" : "",
481       "exceptions" : "",
482       "requires" : "",
483       "params" : [
484         {
485           "name" : "xyPosition",
486           "type" : "Array",
487           "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
488           "isOptional" : false
489         },
490         {
491           "name" : "parentMenu",
492           "type" : "Roo.menu.Menu",
493           "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
494           "isOptional" : false
495         }
496       ],
497       "returns" : []
498     },
499     {
500       "name" : "purgeListeners",
501       "type" : "function",
502       "desc" : "Removes all listeners for this object",
503       "sig" : "()\n{\n\n}",
504       "static" : false,
505       "memberOf" : "Roo.util.Observable",
506       "isStatic" : false,
507       "isConstructor" : false,
508       "isPrivate" : false,
509       "example" : "",
510       "deprecated" : "",
511       "since" : "",
512       "see" : "",
513       "exceptions" : "",
514       "requires" : "",
515       "params" : [],
516       "returns" : []
517     },
518     {
519       "name" : "on",
520       "type" : "function",
521       "desc" : "Appends an event handler to this element (shorthand for addListener)",
522       "sig" : "(eventName, handler, scope, options)",
523       "static" : false,
524       "memberOf" : "Roo.util.Observable",
525       "isStatic" : false,
526       "isConstructor" : false,
527       "isPrivate" : false,
528       "example" : "",
529       "deprecated" : "",
530       "since" : "",
531       "see" : "",
532       "exceptions" : "",
533       "requires" : "",
534       "params" : [
535         {
536           "name" : "eventName",
537           "type" : "String",
538           "desc" : "The type of event to listen for",
539           "isOptional" : false
540         },
541         {
542           "name" : "handler",
543           "type" : "Function",
544           "desc" : "The method the event invokes",
545           "isOptional" : false
546         },
547         {
548           "name" : "scope",
549           "type" : "Object",
550           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
551           "isOptional" : false
552         },
553         {
554           "name" : "options",
555           "type" : "Object",
556           "desc" : "(optional)",
557           "isOptional" : false
558         }
559       ],
560       "returns" : []
561     },
562     {
563       "name" : "un",
564       "type" : "function",
565       "desc" : "Removes a listener (shorthand for removeListener)",
566       "sig" : "(eventName, handler, scope)",
567       "static" : false,
568       "memberOf" : "Roo.util.Observable",
569       "isStatic" : false,
570       "isConstructor" : false,
571       "isPrivate" : false,
572       "example" : "",
573       "deprecated" : "",
574       "since" : "",
575       "see" : "",
576       "exceptions" : "",
577       "requires" : "",
578       "params" : [
579         {
580           "name" : "eventName",
581           "type" : "String",
582           "desc" : "The type of event to listen for",
583           "isOptional" : false
584         },
585         {
586           "name" : "handler",
587           "type" : "Function",
588           "desc" : "The handler to remove",
589           "isOptional" : false
590         },
591         {
592           "name" : "scope",
593           "type" : "Object",
594           "desc" : "(optional) The scope (this object) for the handler",
595           "isOptional" : false
596         }
597       ],
598       "returns" : []
599     },
600     {
601       "name" : "addEvents",
602       "type" : "function",
603       "desc" : "Used to define events on this Observable",
604       "sig" : "(object)",
605       "static" : false,
606       "memberOf" : "Roo.util.Observable",
607       "isStatic" : false,
608       "isConstructor" : false,
609       "isPrivate" : false,
610       "example" : "",
611       "deprecated" : "",
612       "since" : "",
613       "see" : "",
614       "exceptions" : "",
615       "requires" : "",
616       "params" : [
617         {
618           "name" : "object",
619           "type" : "Object",
620           "desc" : "The object with the events defined",
621           "isOptional" : false
622         }
623       ],
624       "returns" : []
625     },
626     {
627       "name" : "releaseCapture",
628       "type" : "function",
629       "desc" : "Removes <b>all</b> added captures from the Observable.",
630       "sig" : "(o)",
631       "static" : true,
632       "memberOf" : "Roo.util.Observable",
633       "isStatic" : true,
634       "isConstructor" : false,
635       "isPrivate" : false,
636       "example" : "",
637       "deprecated" : "",
638       "since" : "",
639       "see" : "",
640       "exceptions" : "",
641       "requires" : "",
642       "params" : [
643         {
644           "name" : "o",
645           "type" : "Observable",
646           "desc" : "The Observable to release",
647           "isOptional" : false
648         }
649       ],
650       "returns" : []
651     },
652     {
653       "name" : "removeListener",
654       "type" : "function",
655       "desc" : "Removes a listener",
656       "sig" : "(eventName, handler, scope)",
657       "static" : false,
658       "memberOf" : "Roo.util.Observable",
659       "isStatic" : false,
660       "isConstructor" : false,
661       "isPrivate" : false,
662       "example" : "",
663       "deprecated" : "",
664       "since" : "",
665       "see" : "",
666       "exceptions" : "",
667       "requires" : "",
668       "params" : [
669         {
670           "name" : "eventName",
671           "type" : "String",
672           "desc" : "The type of event to listen for",
673           "isOptional" : false
674         },
675         {
676           "name" : "handler",
677           "type" : "Function",
678           "desc" : "The handler to remove",
679           "isOptional" : false
680         },
681         {
682           "name" : "scope",
683           "type" : "Object",
684           "desc" : "(optional) The scope (this object) for the handler",
685           "isOptional" : false
686         }
687       ],
688       "returns" : []
689     },
690     {
691       "name" : "fireEvent",
692       "type" : "function",
693       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
694       "sig" : "(eventName, args)",
695       "static" : false,
696       "memberOf" : "Roo.util.Observable",
697       "isStatic" : false,
698       "isConstructor" : false,
699       "isPrivate" : false,
700       "example" : "",
701       "deprecated" : "",
702       "since" : "",
703       "see" : "",
704       "exceptions" : "",
705       "requires" : "",
706       "params" : [
707         {
708           "name" : "eventName",
709           "type" : "String",
710           "desc" : "",
711           "isOptional" : false
712         },
713         {
714           "name" : "args",
715           "type" : "Object...",
716           "desc" : "Variable number of parameters are passed to handlers",
717           "isOptional" : false
718         }
719       ],
720       "returns" : [
721         {
722           "name" : "",
723           "type" : "Boolean",
724           "desc" : "returns false if any of the handlers return false otherwise it returns true"
725         }
726       ]
727     },
728     {
729       "name" : "hasListener",
730       "type" : "function",
731       "desc" : "Checks to see if this object has any listeners for a specified event",
732       "sig" : "(eventName)",
733       "static" : false,
734       "memberOf" : "Roo.util.Observable",
735       "isStatic" : false,
736       "isConstructor" : false,
737       "isPrivate" : false,
738       "example" : "",
739       "deprecated" : "",
740       "since" : "",
741       "see" : "",
742       "exceptions" : "",
743       "requires" : "",
744       "params" : [
745         {
746           "name" : "eventName",
747           "type" : "String",
748           "desc" : "The name of the event to check for",
749           "isOptional" : false
750         }
751       ],
752       "returns" : [
753         {
754           "name" : "",
755           "type" : "Boolean",
756           "desc" : "True if the event is being listened for, else false"
757         }
758       ]
759     },
760     {
761       "name" : "capture",
762       "type" : "function",
763       "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.",
764       "sig" : "(o, fn, scope)",
765       "static" : true,
766       "memberOf" : "Roo.util.Observable",
767       "isStatic" : true,
768       "isConstructor" : false,
769       "isPrivate" : false,
770       "example" : "",
771       "deprecated" : "",
772       "since" : "",
773       "see" : "",
774       "exceptions" : "",
775       "requires" : "",
776       "params" : [
777         {
778           "name" : "o",
779           "type" : "Observable",
780           "desc" : "The Observable to capture",
781           "isOptional" : false
782         },
783         {
784           "name" : "fn",
785           "type" : "Function",
786           "desc" : "The function to call",
787           "isOptional" : false
788         },
789         {
790           "name" : "scope",
791           "type" : "Object",
792           "desc" : "(optional) The scope (this object) for the fn",
793           "isOptional" : false
794         }
795       ],
796       "returns" : []
797     },
798     {
799       "name" : "addListener",
800       "type" : "function",
801       "desc" : "Appends an event handler to this component",
802       "sig" : "(eventName, handler, scope, options)",
803       "static" : false,
804       "memberOf" : "Roo.util.Observable",
805       "isStatic" : false,
806       "isConstructor" : false,
807       "isPrivate" : false,
808       "example" : "",
809       "deprecated" : "",
810       "since" : "",
811       "see" : "",
812       "exceptions" : "",
813       "requires" : "",
814       "params" : [
815         {
816           "name" : "eventName",
817           "type" : "String",
818           "desc" : "The type of event to listen for",
819           "isOptional" : false
820         },
821         {
822           "name" : "handler",
823           "type" : "Function",
824           "desc" : "The method the event invokes",
825           "isOptional" : false
826         },
827         {
828           "name" : "scope",
829           "type" : "Object",
830           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
831           "isOptional" : false
832         },
833         {
834           "name" : "options",
835           "type" : "Object",
836           "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>",
837           "isOptional" : false
838         }
839       ],
840       "returns" : []
841     }
842   ],
843   "events" : [
844     {
845       "name" : "select",
846       "type" : "function",
847       "desc" : "",
848       "sig" : "function (picker, date)\n{\n\n}",
849       "memberOf" : "",
850       "example" : "",
851       "deprecated" : "",
852       "since" : "",
853       "see" : "",
854       "params" : [
855         {
856           "name" : "picker",
857           "type" : "DatePicker",
858           "desc" : "",
859           "isOptional" : false
860         },
861         {
862           "name" : "date",
863           "type" : "Date",
864           "desc" : "",
865           "isOptional" : false
866         }
867       ],
868       "returns" : []
869     },
870     {
871       "name" : "mouseover",
872       "type" : "function",
873       "desc" : "Fires when the mouse is hovering over this menu",
874       "sig" : "function (_self, e, menuItem)\n{\n\n}",
875       "memberOf" : "Roo.menu.Menu",
876       "example" : "",
877       "deprecated" : "",
878       "since" : "",
879       "see" : "",
880       "params" : [
881         {
882           "name" : "this",
883           "type" : "Roo.menu.Menu",
884           "desc" : "",
885           "isOptional" : false
886         },
887         {
888           "name" : "e",
889           "type" : "Roo.EventObject",
890           "desc" : "",
891           "isOptional" : false
892         },
893         {
894           "name" : "menuItem",
895           "type" : "Roo.menu.Item",
896           "desc" : "The menu item that was clicked",
897           "isOptional" : false
898         }
899       ],
900       "returns" : []
901     },
902     {
903       "name" : "mouseout",
904       "type" : "function",
905       "desc" : "Fires when the mouse exits this menu",
906       "sig" : "function (_self, e, menuItem)\n{\n\n}",
907       "memberOf" : "Roo.menu.Menu",
908       "example" : "",
909       "deprecated" : "",
910       "since" : "",
911       "see" : "",
912       "params" : [
913         {
914           "name" : "this",
915           "type" : "Roo.menu.Menu",
916           "desc" : "",
917           "isOptional" : false
918         },
919         {
920           "name" : "e",
921           "type" : "Roo.EventObject",
922           "desc" : "",
923           "isOptional" : false
924         },
925         {
926           "name" : "menuItem",
927           "type" : "Roo.menu.Item",
928           "desc" : "The menu item that was clicked",
929           "isOptional" : false
930         }
931       ],
932       "returns" : []
933     },
934     {
935       "name" : "beforehide",
936       "type" : "function",
937       "desc" : "Fires before this menu is hidden",
938       "sig" : "function (_self)\n{\n\n}",
939       "memberOf" : "Roo.menu.Menu",
940       "example" : "",
941       "deprecated" : "",
942       "since" : "",
943       "see" : "",
944       "params" : [
945         {
946           "name" : "this",
947           "type" : "Roo.menu.Menu",
948           "desc" : "",
949           "isOptional" : false
950         }
951       ],
952       "returns" : []
953     },
954     {
955       "name" : "itemclick",
956       "type" : "function",
957       "desc" : "Fires when a menu item contained in this menu is clicked",
958       "sig" : "function (baseItem, e)\n{\n\n}",
959       "memberOf" : "Roo.menu.Menu",
960       "example" : "",
961       "deprecated" : "",
962       "since" : "",
963       "see" : "",
964       "params" : [
965         {
966           "name" : "baseItem",
967           "type" : "Roo.menu.BaseItem",
968           "desc" : "The BaseItem that was clicked",
969           "isOptional" : false
970         },
971         {
972           "name" : "e",
973           "type" : "Roo.EventObject",
974           "desc" : "",
975           "isOptional" : false
976         }
977       ],
978       "returns" : []
979     },
980     {
981       "name" : "beforeshow",
982       "type" : "function",
983       "desc" : "Fires before this menu is displayed",
984       "sig" : "function (_self)\n{\n\n}",
985       "memberOf" : "Roo.menu.Menu",
986       "example" : "",
987       "deprecated" : "",
988       "since" : "",
989       "see" : "",
990       "params" : [
991         {
992           "name" : "this",
993           "type" : "Roo.menu.Menu",
994           "desc" : "",
995           "isOptional" : false
996         }
997       ],
998       "returns" : []
999     },
1000     {
1001       "name" : "hide",
1002       "type" : "function",
1003       "desc" : "Fires after this menu is hidden",
1004       "sig" : "function (_self)\n{\n\n}",
1005       "memberOf" : "Roo.menu.Menu",
1006       "example" : "",
1007       "deprecated" : "",
1008       "since" : "",
1009       "see" : "",
1010       "params" : [
1011         {
1012           "name" : "this",
1013           "type" : "Roo.menu.Menu",
1014           "desc" : "",
1015           "isOptional" : false
1016         }
1017       ],
1018       "returns" : []
1019     },
1020     {
1021       "name" : "click",
1022       "type" : "function",
1023       "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
1024       "sig" : "function (_self, menuItem, e)\n{\n\n}",
1025       "memberOf" : "Roo.menu.Menu",
1026       "example" : "",
1027       "deprecated" : "",
1028       "since" : "",
1029       "see" : "",
1030       "params" : [
1031         {
1032           "name" : "this",
1033           "type" : "Roo.menu.Menu",
1034           "desc" : "",
1035           "isOptional" : false
1036         },
1037         {
1038           "name" : "menuItem",
1039           "type" : "Roo.menu.Item",
1040           "desc" : "The menu item that was clicked",
1041           "isOptional" : false
1042         },
1043         {
1044           "name" : "e",
1045           "type" : "Roo.EventObject",
1046           "desc" : "",
1047           "isOptional" : false
1048         }
1049       ],
1050       "returns" : []
1051     },
1052     {
1053       "name" : "show",
1054       "type" : "function",
1055       "desc" : "Fires after this menu is displayed",
1056       "sig" : "function (_self)\n{\n\n}",
1057       "memberOf" : "Roo.menu.Menu",
1058       "example" : "",
1059       "deprecated" : "",
1060       "since" : "",
1061       "see" : "",
1062       "params" : [
1063         {
1064           "name" : "this",
1065           "type" : "Roo.menu.Menu",
1066           "desc" : "",
1067           "isOptional" : false
1068         }
1069       ],
1070       "returns" : []
1071     }
1072   ]
1073 }