Fix #6893 - fix roo docs
[roojs1] / docs / symbols / Roo.menu.Item.json
1 {
2   "name" : "Roo.menu.Item",
3   "augments" : [
4     "Roo.menu.BaseItem",
5     "Roo.Component",
6     "Roo.util.Observable"
7   ],
8   "desc" : "A base class for all menu items that require menu-related functionality (like sub-menus) and are not static\ndisplay items.  Item extends the base functionality of {@link Roo.menu.BaseItem} by adding menu-specific\nactivation and click handling.",
9   "isSingleton" : false,
10   "isStatic" : false,
11   "isBuiltin" : false,
12   "memberOf" : "Item",
13   "example" : "",
14   "deprecated" : "",
15   "since" : "",
16   "see" : "",
17   "params" : [
18     {
19       "name" : "config",
20       "type" : "Object",
21       "desc" : "Configuration options",
22       "isOptional" : false
23     }
24   ],
25   "returns" : [],
26   "config" : [
27     {
28       "name" : "listeners",
29       "type" : "Object",
30       "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>",
31       "memberOf" : "Roo.util.Observable",
32       "optvals" : []
33     },
34     {
35       "name" : "showDelay",
36       "type" : "Number",
37       "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)",
38       "memberOf" : "Roo.menu.Item",
39       "optvals" : []
40     },
41     {
42       "name" : "text",
43       "type" : "String",
44       "desc" : "The text to show on the menu item.",
45       "memberOf" : "Roo.menu.Item",
46       "optvals" : []
47     },
48     {
49       "name" : "activeClass",
50       "type" : "String",
51       "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
52       "memberOf" : "Roo.menu.BaseItem",
53       "optvals" : []
54     },
55     {
56       "name" : "hidden",
57       "type" : "Boolean",
58       "desc" : "True to prevent creation of this menu item (defaults to false)",
59       "memberOf" : "Roo.menu.BaseItem",
60       "optvals" : []
61     },
62     {
63       "name" : "hideMode",
64       "type" : "String",
65       "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\".",
66       "memberOf" : "Roo.Component",
67       "optvals" : [
68         "display",
69         "visibility"
70       ]
71     },
72     {
73       "name" : "handler",
74       "type" : "Function",
75       "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
76       "memberOf" : "Roo.menu.BaseItem",
77       "optvals" : []
78     },
79     {
80       "name" : "hideDelay",
81       "type" : "Number",
82       "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
83       "memberOf" : "Roo.menu.BaseItem",
84       "optvals" : []
85     },
86     {
87       "name" : "hideOnClick",
88       "type" : "Boolean",
89       "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
90       "memberOf" : "Roo.menu.BaseItem",
91       "optvals" : []
92     },
93     {
94       "name" : "allowDomMove",
95       "type" : "Boolean",
96       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
97       "memberOf" : "Roo.Component",
98       "optvals" : []
99     },
100     {
101       "name" : "itemCls",
102       "type" : "String",
103       "desc" : "The default CSS class to use for menu items (defaults to \"x-menu-item\")",
104       "memberOf" : "Roo.menu.Item",
105       "optvals" : []
106     },
107     {
108       "name" : "HTML",
109       "type" : "String",
110       "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
111       "memberOf" : "Roo.menu.Item",
112       "optvals" : []
113     },
114     {
115       "name" : "actionMode",
116       "type" : "String",
117       "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",
118       "memberOf" : "Roo.Component",
119       "optvals" : []
120     },
121     {
122       "name" : "canActivate",
123       "type" : "Boolean",
124       "desc" : "True if this item can be visually activated (defaults to true)",
125       "memberOf" : "Roo.menu.Item",
126       "optvals" : []
127     },
128     {
129       "name" : "icon",
130       "type" : "String",
131       "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
132       "memberOf" : "Roo.menu.Item",
133       "optvals" : []
134     },
135     {
136       "name" : "disableClass",
137       "type" : "String",
138       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
139       "memberOf" : "Roo.Component",
140       "optvals" : []
141     }
142   ],
143   "methods" : [
144     {
145       "name" : "setText",
146       "desc" : "Sets the text to display in this menu item",
147       "isStatic" : false,
148       "isConstructor" : false,
149       "isPrivate" : false,
150       "memberOf" : "Roo.menu.Item",
151       "example" : "",
152       "deprecated" : "",
153       "since" : "",
154       "see" : "",
155       "params" : [
156         {
157           "name" : "text",
158           "type" : "String",
159           "desc" : "The text to display",
160           "isOptional" : false
161         },
162         {
163           "name" : "isHTML",
164           "type" : "Boolean",
165           "desc" : "true to indicate text is pure html.",
166           "isOptional" : false
167         }
168       ],
169       "returns" : []
170     },
171     {
172       "name" : "getId",
173       "desc" : "Returns the id of this component.",
174       "isStatic" : false,
175       "isConstructor" : false,
176       "isPrivate" : false,
177       "memberOf" : "Roo.Component",
178       "example" : "",
179       "deprecated" : "",
180       "since" : "",
181       "see" : "",
182       "params" : [],
183       "returns" : [
184         {
185           "name" : "",
186           "type" : "String",
187           "desc" : ""
188         }
189       ]
190     },
191     {
192       "name" : "render",
193       "desc" : "If this is a lazy rendering component, render it to its container element.",
194       "isStatic" : false,
195       "isConstructor" : false,
196       "isPrivate" : false,
197       "memberOf" : "Roo.Component",
198       "example" : "",
199       "deprecated" : "",
200       "since" : "",
201       "see" : "",
202       "params" : [
203         {
204           "name" : "container",
205           "type" : "String/HTMLElement/Element",
206           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
207           "isOptional" : false
208         }
209       ],
210       "returns" : []
211     },
212     {
213       "name" : "destroy",
214       "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}.",
215       "isStatic" : false,
216       "isConstructor" : false,
217       "isPrivate" : false,
218       "memberOf" : "Roo.Component",
219       "example" : "",
220       "deprecated" : "",
221       "since" : "",
222       "see" : "",
223       "params" : [],
224       "returns" : []
225     },
226     {
227       "name" : "isVisible",
228       "desc" : "Returns true if this component is visible.",
229       "isStatic" : false,
230       "isConstructor" : false,
231       "isPrivate" : false,
232       "memberOf" : "Roo.Component",
233       "example" : "",
234       "deprecated" : "",
235       "since" : "",
236       "see" : "",
237       "params" : [],
238       "returns" : []
239     },
240     {
241       "name" : "setDisabled",
242       "desc" : "Convenience function for setting disabled/enabled by boolean.",
243       "isStatic" : false,
244       "isConstructor" : false,
245       "isPrivate" : false,
246       "memberOf" : "Roo.Component",
247       "example" : "",
248       "deprecated" : "",
249       "since" : "",
250       "see" : "",
251       "params" : [
252         {
253           "name" : "disabled",
254           "type" : "Boolean",
255           "desc" : "",
256           "isOptional" : false
257         }
258       ],
259       "returns" : []
260     },
261     {
262       "name" : "hide",
263       "desc" : "Hide this component.",
264       "isStatic" : false,
265       "isConstructor" : false,
266       "isPrivate" : false,
267       "memberOf" : "Roo.Component",
268       "example" : "",
269       "deprecated" : "",
270       "since" : "",
271       "see" : "",
272       "params" : [],
273       "returns" : [
274         {
275           "name" : "",
276           "type" : "Roo.Component",
277           "desc" : "this"
278         }
279       ]
280     },
281     {
282       "name" : "focus",
283       "desc" : "Try to focus this component.",
284       "isStatic" : false,
285       "isConstructor" : false,
286       "isPrivate" : false,
287       "memberOf" : "Roo.Component",
288       "example" : "",
289       "deprecated" : "",
290       "since" : "",
291       "see" : "",
292       "params" : [
293         {
294           "name" : "selectText",
295           "type" : "Boolean",
296           "desc" : "True to also select the text in this component (if applicable)",
297           "isOptional" : false
298         }
299       ],
300       "returns" : [
301         {
302           "name" : "",
303           "type" : "Roo.Component",
304           "desc" : "this"
305         }
306       ]
307     },
308     {
309       "name" : "show",
310       "desc" : "Show this component.",
311       "isStatic" : false,
312       "isConstructor" : false,
313       "isPrivate" : false,
314       "memberOf" : "Roo.Component",
315       "example" : "",
316       "deprecated" : "",
317       "since" : "",
318       "see" : "",
319       "params" : [],
320       "returns" : [
321         {
322           "name" : "",
323           "type" : "Roo.Component",
324           "desc" : "this"
325         }
326       ]
327     },
328     {
329       "name" : "enable",
330       "desc" : "Enable this component.",
331       "isStatic" : false,
332       "isConstructor" : false,
333       "isPrivate" : false,
334       "memberOf" : "Roo.Component",
335       "example" : "",
336       "deprecated" : "",
337       "since" : "",
338       "see" : "",
339       "params" : [],
340       "returns" : [
341         {
342           "name" : "",
343           "type" : "Roo.Component",
344           "desc" : "this"
345         }
346       ]
347     },
348     {
349       "name" : "setVisible",
350       "desc" : "Convenience function to hide or show this component by boolean.",
351       "isStatic" : false,
352       "isConstructor" : false,
353       "isPrivate" : false,
354       "memberOf" : "Roo.Component",
355       "example" : "",
356       "deprecated" : "",
357       "since" : "",
358       "see" : "",
359       "params" : [
360         {
361           "name" : "visible",
362           "type" : "Boolean",
363           "desc" : "True to show, false to hide",
364           "isOptional" : false
365         }
366       ],
367       "returns" : [
368         {
369           "name" : "",
370           "type" : "Roo.Component",
371           "desc" : "this"
372         }
373       ]
374     },
375     {
376       "name" : "disable",
377       "desc" : "Disable this component.",
378       "isStatic" : false,
379       "isConstructor" : false,
380       "isPrivate" : false,
381       "memberOf" : "Roo.Component",
382       "example" : "",
383       "deprecated" : "",
384       "since" : "",
385       "see" : "",
386       "params" : [],
387       "returns" : [
388         {
389           "name" : "",
390           "type" : "Roo.Component",
391           "desc" : "this"
392         }
393       ]
394     },
395     {
396       "name" : "getEl",
397       "desc" : "Returns the underlying {@link Roo.Element}.",
398       "isStatic" : false,
399       "isConstructor" : false,
400       "isPrivate" : false,
401       "memberOf" : "Roo.Component",
402       "example" : "",
403       "deprecated" : "",
404       "since" : "",
405       "see" : "",
406       "params" : [],
407       "returns" : [
408         {
409           "name" : "",
410           "type" : "Roo.Element",
411           "desc" : "The element"
412         }
413       ]
414     },
415     {
416       "name" : "purgeListeners",
417       "desc" : "Removes all listeners for this object",
418       "isStatic" : false,
419       "isConstructor" : false,
420       "isPrivate" : false,
421       "memberOf" : "Roo.util.Observable",
422       "example" : "",
423       "deprecated" : "",
424       "since" : "",
425       "see" : "",
426       "params" : [],
427       "returns" : []
428     },
429     {
430       "name" : "on",
431       "desc" : "Appends an event handler to this element (shorthand for addListener)",
432       "isStatic" : false,
433       "isConstructor" : false,
434       "isPrivate" : false,
435       "memberOf" : "Roo.util.Observable",
436       "example" : "",
437       "deprecated" : "",
438       "since" : "",
439       "see" : "",
440       "params" : [
441         {
442           "name" : "eventName",
443           "type" : "String",
444           "desc" : "The type of event to listen for",
445           "isOptional" : false
446         },
447         {
448           "name" : "handler",
449           "type" : "Function",
450           "desc" : "The method the event invokes",
451           "isOptional" : false
452         },
453         {
454           "name" : "scope",
455           "type" : "Object",
456           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
457           "isOptional" : false
458         },
459         {
460           "name" : "options",
461           "type" : "Object",
462           "desc" : "(optional)",
463           "isOptional" : false
464         }
465       ],
466       "returns" : []
467     },
468     {
469       "name" : "un",
470       "desc" : "Removes a listener (shorthand for removeListener)",
471       "isStatic" : false,
472       "isConstructor" : false,
473       "isPrivate" : false,
474       "memberOf" : "Roo.util.Observable",
475       "example" : "",
476       "deprecated" : "",
477       "since" : "",
478       "see" : "",
479       "params" : [
480         {
481           "name" : "eventName",
482           "type" : "String",
483           "desc" : "The type of event to listen for",
484           "isOptional" : false
485         },
486         {
487           "name" : "handler",
488           "type" : "Function",
489           "desc" : "The handler to remove",
490           "isOptional" : false
491         },
492         {
493           "name" : "scope",
494           "type" : "Object",
495           "desc" : "(optional) The scope (this object) for the handler",
496           "isOptional" : false
497         }
498       ],
499       "returns" : []
500     },
501     {
502       "name" : "addEvents",
503       "desc" : "Used to define events on this Observable",
504       "isStatic" : false,
505       "isConstructor" : false,
506       "isPrivate" : false,
507       "memberOf" : "Roo.util.Observable",
508       "example" : "",
509       "deprecated" : "",
510       "since" : "",
511       "see" : "",
512       "params" : [
513         {
514           "name" : "object",
515           "type" : "Object",
516           "desc" : "The object with the events defined",
517           "isOptional" : false
518         }
519       ],
520       "returns" : []
521     },
522     {
523       "name" : "releaseCapture",
524       "desc" : "Removes <b>all</b> added captures from the Observable.",
525       "isStatic" : true,
526       "isConstructor" : false,
527       "isPrivate" : false,
528       "memberOf" : "Roo.util.Observable",
529       "example" : "",
530       "deprecated" : "",
531       "since" : "",
532       "see" : "",
533       "params" : [
534         {
535           "name" : "o",
536           "type" : "Observable",
537           "desc" : "The Observable to release",
538           "isOptional" : false
539         }
540       ],
541       "returns" : []
542     },
543     {
544       "name" : "removeListener",
545       "desc" : "Removes a listener",
546       "isStatic" : false,
547       "isConstructor" : false,
548       "isPrivate" : false,
549       "memberOf" : "Roo.util.Observable",
550       "example" : "",
551       "deprecated" : "",
552       "since" : "",
553       "see" : "",
554       "params" : [
555         {
556           "name" : "eventName",
557           "type" : "String",
558           "desc" : "The type of event to listen for",
559           "isOptional" : false
560         },
561         {
562           "name" : "handler",
563           "type" : "Function",
564           "desc" : "The handler to remove",
565           "isOptional" : false
566         },
567         {
568           "name" : "scope",
569           "type" : "Object",
570           "desc" : "(optional) The scope (this object) for the handler",
571           "isOptional" : false
572         }
573       ],
574       "returns" : []
575     },
576     {
577       "name" : "fireEvent",
578       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
579       "isStatic" : false,
580       "isConstructor" : false,
581       "isPrivate" : false,
582       "memberOf" : "Roo.util.Observable",
583       "example" : "",
584       "deprecated" : "",
585       "since" : "",
586       "see" : "",
587       "params" : [
588         {
589           "name" : "eventName",
590           "type" : "String",
591           "desc" : "",
592           "isOptional" : false
593         },
594         {
595           "name" : "args",
596           "type" : "Object...",
597           "desc" : "Variable number of parameters are passed to handlers",
598           "isOptional" : false
599         }
600       ],
601       "returns" : [
602         {
603           "name" : "",
604           "type" : "Boolean",
605           "desc" : "returns false if any of the handlers return false otherwise it returns true"
606         }
607       ]
608     },
609     {
610       "name" : "hasListener",
611       "desc" : "Checks to see if this object has any listeners for a specified event",
612       "isStatic" : false,
613       "isConstructor" : false,
614       "isPrivate" : false,
615       "memberOf" : "Roo.util.Observable",
616       "example" : "",
617       "deprecated" : "",
618       "since" : "",
619       "see" : "",
620       "params" : [
621         {
622           "name" : "eventName",
623           "type" : "String",
624           "desc" : "The name of the event to check for",
625           "isOptional" : false
626         }
627       ],
628       "returns" : [
629         {
630           "name" : "",
631           "type" : "Boolean",
632           "desc" : "True if the event is being listened for, else false"
633         }
634       ]
635     },
636     {
637       "name" : "capture",
638       "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.",
639       "isStatic" : true,
640       "isConstructor" : false,
641       "isPrivate" : false,
642       "memberOf" : "Roo.util.Observable",
643       "example" : "",
644       "deprecated" : "",
645       "since" : "",
646       "see" : "",
647       "params" : [
648         {
649           "name" : "o",
650           "type" : "Observable",
651           "desc" : "The Observable to capture",
652           "isOptional" : false
653         },
654         {
655           "name" : "fn",
656           "type" : "Function",
657           "desc" : "The function to call",
658           "isOptional" : false
659         },
660         {
661           "name" : "scope",
662           "type" : "Object",
663           "desc" : "(optional) The scope (this object) for the fn",
664           "isOptional" : false
665         }
666       ],
667       "returns" : []
668     },
669     {
670       "name" : "addListener",
671       "desc" : "Appends an event handler to this component",
672       "isStatic" : false,
673       "isConstructor" : false,
674       "isPrivate" : false,
675       "memberOf" : "Roo.util.Observable",
676       "example" : "",
677       "deprecated" : "",
678       "since" : "",
679       "see" : "",
680       "params" : [
681         {
682           "name" : "eventName",
683           "type" : "String",
684           "desc" : "The type of event to listen for",
685           "isOptional" : false
686         },
687         {
688           "name" : "handler",
689           "type" : "Function",
690           "desc" : "The method the event invokes",
691           "isOptional" : false
692         },
693         {
694           "name" : "scope",
695           "type" : "Object",
696           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
697           "isOptional" : false
698         },
699         {
700           "name" : "options",
701           "type" : "Object",
702           "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>",
703           "isOptional" : false
704         }
705       ],
706       "returns" : []
707     }
708   ],
709   "events" : [
710     {
711       "name" : "click",
712       "desc" : "Fires when this item is clicked",
713       "memberOf" : "Roo.menu.BaseItem",
714       "example" : "",
715       "deprecated" : "",
716       "since" : "",
717       "see" : "",
718       "params" : [
719         {
720           "name" : "this",
721           "type" : "Roo.menu.BaseItem",
722           "desc" : "",
723           "isOptional" : false
724         },
725         {
726           "name" : "e",
727           "type" : "Roo.EventObject",
728           "desc" : "",
729           "isOptional" : false
730         }
731       ],
732       "returns" : []
733     },
734     {
735       "name" : "activate",
736       "desc" : "Fires when this item is activated",
737       "memberOf" : "Roo.menu.BaseItem",
738       "example" : "",
739       "deprecated" : "",
740       "since" : "",
741       "see" : "",
742       "params" : [
743         {
744           "name" : "this",
745           "type" : "Roo.menu.BaseItem",
746           "desc" : "",
747           "isOptional" : false
748         }
749       ],
750       "returns" : []
751     },
752     {
753       "name" : "deactivate",
754       "desc" : "Fires when this item is deactivated",
755       "memberOf" : "Roo.menu.BaseItem",
756       "example" : "",
757       "deprecated" : "",
758       "since" : "",
759       "see" : "",
760       "params" : [
761         {
762           "name" : "this",
763           "type" : "Roo.menu.BaseItem",
764           "desc" : "",
765           "isOptional" : false
766         }
767       ],
768       "returns" : []
769     },
770     {
771       "name" : "beforerender",
772       "desc" : "Fires before the component is rendered. Return false to stop the render.",
773       "memberOf" : "Roo.Component",
774       "example" : "",
775       "deprecated" : "",
776       "since" : "",
777       "see" : "",
778       "params" : [
779         {
780           "name" : "this",
781           "type" : "Roo.Component",
782           "desc" : "",
783           "isOptional" : false
784         }
785       ],
786       "returns" : []
787     },
788     {
789       "name" : "disable",
790       "desc" : "Fires after the component is disabled.",
791       "memberOf" : "Roo.Component",
792       "example" : "",
793       "deprecated" : "",
794       "since" : "",
795       "see" : "",
796       "params" : [
797         {
798           "name" : "this",
799           "type" : "Roo.Component",
800           "desc" : "",
801           "isOptional" : false
802         }
803       ],
804       "returns" : []
805     },
806     {
807       "name" : "render",
808       "desc" : "Fires after the component is rendered.",
809       "memberOf" : "Roo.Component",
810       "example" : "",
811       "deprecated" : "",
812       "since" : "",
813       "see" : "",
814       "params" : [
815         {
816           "name" : "this",
817           "type" : "Roo.Component",
818           "desc" : "",
819           "isOptional" : false
820         }
821       ],
822       "returns" : []
823     },
824     {
825       "name" : "destroy",
826       "desc" : "Fires after the component is destroyed.",
827       "memberOf" : "Roo.Component",
828       "example" : "",
829       "deprecated" : "",
830       "since" : "",
831       "see" : "",
832       "params" : [
833         {
834           "name" : "this",
835           "type" : "Roo.Component",
836           "desc" : "",
837           "isOptional" : false
838         }
839       ],
840       "returns" : []
841     },
842     {
843       "name" : "hide",
844       "desc" : "Fires after the component is hidden.",
845       "memberOf" : "Roo.Component",
846       "example" : "",
847       "deprecated" : "",
848       "since" : "",
849       "see" : "",
850       "params" : [
851         {
852           "name" : "this",
853           "type" : "Roo.Component",
854           "desc" : "",
855           "isOptional" : false
856         }
857       ],
858       "returns" : []
859     },
860     {
861       "name" : "beforehide",
862       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
863       "memberOf" : "Roo.Component",
864       "example" : "",
865       "deprecated" : "",
866       "since" : "",
867       "see" : "",
868       "params" : [
869         {
870           "name" : "this",
871           "type" : "Roo.Component",
872           "desc" : "",
873           "isOptional" : false
874         }
875       ],
876       "returns" : []
877     },
878     {
879       "name" : "show",
880       "desc" : "Fires after the component is shown.",
881       "memberOf" : "Roo.Component",
882       "example" : "",
883       "deprecated" : "",
884       "since" : "",
885       "see" : "",
886       "params" : [
887         {
888           "name" : "this",
889           "type" : "Roo.Component",
890           "desc" : "",
891           "isOptional" : false
892         }
893       ],
894       "returns" : []
895     },
896     {
897       "name" : "beforeshow",
898       "desc" : "Fires before the component is shown.  Return false to stop the show.",
899       "memberOf" : "Roo.Component",
900       "example" : "",
901       "deprecated" : "",
902       "since" : "",
903       "see" : "",
904       "params" : [
905         {
906           "name" : "this",
907           "type" : "Roo.Component",
908           "desc" : "",
909           "isOptional" : false
910         }
911       ],
912       "returns" : []
913     },
914     {
915       "name" : "enable",
916       "desc" : "Fires after the component is enabled.",
917       "memberOf" : "Roo.Component",
918       "example" : "",
919       "deprecated" : "",
920       "since" : "",
921       "see" : "",
922       "params" : [
923         {
924           "name" : "this",
925           "type" : "Roo.Component",
926           "desc" : "",
927           "isOptional" : false
928         }
929       ],
930       "returns" : []
931     },
932     {
933       "name" : "beforedestroy",
934       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
935       "memberOf" : "Roo.Component",
936       "example" : "",
937       "deprecated" : "",
938       "since" : "",
939       "see" : "",
940       "params" : [
941         {
942           "name" : "this",
943           "type" : "Roo.Component",
944           "desc" : "",
945           "isOptional" : false
946         }
947       ],
948       "returns" : []
949     }
950   ]
951 }