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