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