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