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