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