git.roojs.org Git - roojs1/blob - 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" : "setVisibilityEl",
 245       "desc" : "Set the element that will be used to show or hide",
 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" : "getVisibilityEl",
 261       "desc" : "Get 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" : "addxtype",
 277       "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..",
 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" : "addxtypeChild",
 293       "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.",
 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" : "initEvents",
 309       "desc" : "Initialize Events for the element",
 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" : "getChildContainer",
 325       "desc" : "Fetch the element to add children to",
 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           "name" : "",
 339           "type" : "Roo.Element",
 340           "desc" : "defaults to this.el"
 341         }
 342       ]
 343     },
 344     {
 345       "name" : "addxtypeChildren",
 346       "desc" : "add a number of children to this object,\n    which in turn calls render...",
 347       "isStatic" : false,
 348       "isConstructor" : false,
 349       "isPrivate" : false,
 350       "memberOf" : "Roo.bootstrap.Component",
 351       "example" : "",
 352       "deprecated" : "",
 353       "since" : "",
 354       "see" : "",
 355       "params" : [
 356       ],
 357       "returns" : [
 358       ]
 359     },
 360     {
 361       "name" : "getId",
 362       "desc" : "Returns the id of this component.",
 363       "isStatic" : false,
 364       "isConstructor" : false,
 365       "isPrivate" : false,
 366       "memberOf" : "Roo.Component",
 367       "example" : "",
 368       "deprecated" : "",
 369       "since" : "",
 370       "see" : "",
 371       "params" : [
 372       ],
 373       "returns" : [
 374         {
 375           "name" : "",
 376           "type" : "String",
 377           "desc" : ""
 378         }
 379       ]
 380     },
 381     {
 382       "name" : "render",
 383       "desc" : "If this is a lazy rendering component, render it to its container element.",
 384       "isStatic" : false,
 385       "isConstructor" : false,
 386       "isPrivate" : false,
 387       "memberOf" : "Roo.Component",
 388       "example" : "",
 389       "deprecated" : "",
 390       "since" : "",
 391       "see" : "",
 392       "params" : [
 393         {
 394           "name" : "container",
 395           "type" : "String/HTMLElement/Element",
 396           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 397           "isOptional" : false
 398         }
 399       ],
 400       "returns" : [
 401       ]
 402     },
 403     {
 404       "name" : "destroy",
 405       "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}.",
 406       "isStatic" : false,
 407       "isConstructor" : false,
 408       "isPrivate" : false,
 409       "memberOf" : "Roo.Component",
 410       "example" : "",
 411       "deprecated" : "",
 412       "since" : "",
 413       "see" : "",
 414       "params" : [
 415       ],
 416       "returns" : [
 417       ]
 418     },
 419     {
 420       "name" : "isVisible",
 421       "desc" : "Returns true if this component is visible.",
 422       "isStatic" : false,
 423       "isConstructor" : false,
 424       "isPrivate" : false,
 425       "memberOf" : "Roo.Component",
 426       "example" : "",
 427       "deprecated" : "",
 428       "since" : "",
 429       "see" : "",
 430       "params" : [
 431       ],
 432       "returns" : [
 433       ]
 434     },
 435     {
 436       "name" : "setDisabled",
 437       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 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           "name" : "disabled",
 449           "type" : "Boolean",
 450           "desc" : "",
 451           "isOptional" : false
 452         }
 453       ],
 454       "returns" : [
 455       ]
 456     },
 457     {
 458       "name" : "focus",
 459       "desc" : "Try to focus this component.",
 460       "isStatic" : false,
 461       "isConstructor" : false,
 462       "isPrivate" : false,
 463       "memberOf" : "Roo.Component",
 464       "example" : "",
 465       "deprecated" : "",
 466       "since" : "",
 467       "see" : "",
 468       "params" : [
 469         {
 470           "name" : "selectText",
 471           "type" : "Boolean",
 472           "desc" : "True to also select the text in this component (if applicable)",
 473           "isOptional" : false
 474         }
 475       ],
 476       "returns" : [
 477         {
 478           "name" : "",
 479           "type" : "Roo.Component",
 480           "desc" : "this"
 481         }
 482       ]
 483     },
 484     {
 485       "name" : "enable",
 486       "desc" : "Enable this component.",
 487       "isStatic" : false,
 488       "isConstructor" : false,
 489       "isPrivate" : false,
 490       "memberOf" : "Roo.Component",
 491       "example" : "",
 492       "deprecated" : "",
 493       "since" : "",
 494       "see" : "",
 495       "params" : [
 496       ],
 497       "returns" : [
 498         {
 499           "name" : "",
 500           "type" : "Roo.Component",
 501           "desc" : "this"
 502         }
 503       ]
 504     },
 505     {
 506       "name" : "setVisible",
 507       "desc" : "Convenience function to hide or show this component by boolean.",
 508       "isStatic" : false,
 509       "isConstructor" : false,
 510       "isPrivate" : false,
 511       "memberOf" : "Roo.Component",
 512       "example" : "",
 513       "deprecated" : "",
 514       "since" : "",
 515       "see" : "",
 516       "params" : [
 517         {
 518           "name" : "visible",
 519           "type" : "Boolean",
 520           "desc" : "True to show, false to hide",
 521           "isOptional" : false
 522         }
 523       ],
 524       "returns" : [
 525         {
 526           "name" : "",
 527           "type" : "Roo.Component",
 528           "desc" : "this"
 529         }
 530       ]
 531     },
 532     {
 533       "name" : "disable",
 534       "desc" : "Disable this component.",
 535       "isStatic" : false,
 536       "isConstructor" : false,
 537       "isPrivate" : false,
 538       "memberOf" : "Roo.Component",
 539       "example" : "",
 540       "deprecated" : "",
 541       "since" : "",
 542       "see" : "",
 543       "params" : [
 544       ],
 545       "returns" : [
 546         {
 547           "name" : "",
 548           "type" : "Roo.Component",
 549           "desc" : "this"
 550         }
 551       ]
 552     },
 553     {
 554       "name" : "getEl",
 555       "desc" : "Returns the underlying {@link Roo.Element}.",
 556       "isStatic" : false,
 557       "isConstructor" : false,
 558       "isPrivate" : false,
 559       "memberOf" : "Roo.Component",
 560       "example" : "",
 561       "deprecated" : "",
 562       "since" : "",
 563       "see" : "",
 564       "params" : [
 565       ],
 566       "returns" : [
 567         {
 568           "name" : "",
 569           "type" : "Roo.Element",
 570           "desc" : "The element"
 571         }
 572       ]
 573     },
 574     {
 575       "name" : "purgeListeners",
 576       "desc" : "Removes all listeners for this object",
 577       "isStatic" : false,
 578       "isConstructor" : false,
 579       "isPrivate" : false,
 580       "memberOf" : "Roo.util.Observable",
 581       "example" : "",
 582       "deprecated" : "",
 583       "since" : "",
 584       "see" : "",
 585       "params" : [
 586       ],
 587       "returns" : [
 588       ]
 589     },
 590     {
 591       "name" : "on",
 592       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 593       "isStatic" : false,
 594       "isConstructor" : false,
 595       "isPrivate" : false,
 596       "memberOf" : "Roo.util.Observable",
 597       "example" : "",
 598       "deprecated" : "",
 599       "since" : "",
 600       "see" : "",
 601       "params" : [
 602         {
 603           "name" : "eventName",
 604           "type" : "String",
 605           "desc" : "The type of event to listen for",
 606           "isOptional" : false
 607         },
 608         {
 609           "name" : "handler",
 610           "type" : "Function",
 611           "desc" : "The method the event invokes",
 612           "isOptional" : false
 613         },
 614         {
 615           "name" : "scope",
 616           "type" : "Object",
 617           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 618           "isOptional" : false
 619         },
 620         {
 621           "name" : "options",
 622           "type" : "Object",
 623           "desc" : "(optional)",
 624           "isOptional" : false
 625         }
 626       ],
 627       "returns" : [
 628       ]
 629     },
 630     {
 631       "name" : "un",
 632       "desc" : "Removes a listener (shorthand for removeListener)",
 633       "isStatic" : false,
 634       "isConstructor" : false,
 635       "isPrivate" : false,
 636       "memberOf" : "Roo.util.Observable",
 637       "example" : "",
 638       "deprecated" : "",
 639       "since" : "",
 640       "see" : "",
 641       "params" : [
 642         {
 643           "name" : "eventName",
 644           "type" : "String",
 645           "desc" : "The type of event to listen for",
 646           "isOptional" : false
 647         },
 648         {
 649           "name" : "handler",
 650           "type" : "Function",
 651           "desc" : "The handler to remove",
 652           "isOptional" : false
 653         },
 654         {
 655           "name" : "scope",
 656           "type" : "Object",
 657           "desc" : "(optional) The scope (this object) for the handler",
 658           "isOptional" : false
 659         }
 660       ],
 661       "returns" : [
 662       ]
 663     },
 664     {
 665       "name" : "addEvents",
 666       "desc" : "Used to define events on this Observable",
 667       "isStatic" : false,
 668       "isConstructor" : false,
 669       "isPrivate" : false,
 670       "memberOf" : "Roo.util.Observable",
 671       "example" : "",
 672       "deprecated" : "",
 673       "since" : "",
 674       "see" : "",
 675       "params" : [
 676         {
 677           "name" : "object",
 678           "type" : "Object",
 679           "desc" : "The object with the events defined",
 680           "isOptional" : false
 681         }
 682       ],
 683       "returns" : [
 684       ]
 685     },
 686     {
 687       "name" : "releaseCapture",
 688       "desc" : "Removes <b>all</b> added captures from the Observable.",
 689       "isStatic" : true,
 690       "isConstructor" : false,
 691       "isPrivate" : false,
 692       "memberOf" : "Roo.util.Observable",
 693       "example" : "",
 694       "deprecated" : "",
 695       "since" : "",
 696       "see" : "",
 697       "params" : [
 698         {
 699           "name" : "o",
 700           "type" : "Observable",
 701           "desc" : "The Observable to release",
 702           "isOptional" : false
 703         }
 704       ],
 705       "returns" : [
 706       ]
 707     },
 708     {
 709       "name" : "removeListener",
 710       "desc" : "Removes a listener",
 711       "isStatic" : false,
 712       "isConstructor" : false,
 713       "isPrivate" : false,
 714       "memberOf" : "Roo.util.Observable",
 715       "example" : "",
 716       "deprecated" : "",
 717       "since" : "",
 718       "see" : "",
 719       "params" : [
 720         {
 721           "name" : "eventName",
 722           "type" : "String",
 723           "desc" : "The type of event to listen for",
 724           "isOptional" : false
 725         },
 726         {
 727           "name" : "handler",
 728           "type" : "Function",
 729           "desc" : "The handler to remove",
 730           "isOptional" : false
 731         },
 732         {
 733           "name" : "scope",
 734           "type" : "Object",
 735           "desc" : "(optional) The scope (this object) for the handler",
 736           "isOptional" : false
 737         }
 738       ],
 739       "returns" : [
 740       ]
 741     },
 742     {
 743       "name" : "fireEvent",
 744       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 745       "isStatic" : false,
 746       "isConstructor" : false,
 747       "isPrivate" : false,
 748       "memberOf" : "Roo.util.Observable",
 749       "example" : "",
 750       "deprecated" : "",
 751       "since" : "",
 752       "see" : "",
 753       "params" : [
 754         {
 755           "name" : "eventName",
 756           "type" : "String",
 757           "desc" : "",
 758           "isOptional" : false
 759         },
 760         {
 761           "name" : "args",
 762           "type" : "Object...",
 763           "desc" : "Variable number of parameters are passed to handlers",
 764           "isOptional" : false
 765         }
 766       ],
 767       "returns" : [
 768         {
 769           "name" : "",
 770           "type" : "Boolean",
 771           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 772         }
 773       ]
 774     },
 775     {
 776       "name" : "hasListener",
 777       "desc" : "Checks to see if this object has any listeners for a specified event",
 778       "isStatic" : false,
 779       "isConstructor" : false,
 780       "isPrivate" : false,
 781       "memberOf" : "Roo.util.Observable",
 782       "example" : "",
 783       "deprecated" : "",
 784       "since" : "",
 785       "see" : "",
 786       "params" : [
 787         {
 788           "name" : "eventName",
 789           "type" : "String",
 790           "desc" : "The name of the event to check for",
 791           "isOptional" : false
 792         }
 793       ],
 794       "returns" : [
 795         {
 796           "name" : "",
 797           "type" : "Boolean",
 798           "desc" : "True if the event is being listened for, else false"
 799         }
 800       ]
 801     },
 802     {
 803       "name" : "capture",
 804       "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.",
 805       "isStatic" : true,
 806       "isConstructor" : false,
 807       "isPrivate" : false,
 808       "memberOf" : "Roo.util.Observable",
 809       "example" : "",
 810       "deprecated" : "",
 811       "since" : "",
 812       "see" : "",
 813       "params" : [
 814         {
 815           "name" : "o",
 816           "type" : "Observable",
 817           "desc" : "The Observable to capture",
 818           "isOptional" : false
 819         },
 820         {
 821           "name" : "fn",
 822           "type" : "Function",
 823           "desc" : "The function to call",
 824           "isOptional" : false
 825         },
 826         {
 827           "name" : "scope",
 828           "type" : "Object",
 829           "desc" : "(optional) The scope (this object) for the fn",
 830           "isOptional" : false
 831         }
 832       ],
 833       "returns" : [
 834       ]
 835     },
 836     {
 837       "name" : "addListener",
 838       "desc" : "Appends an event handler to this component",
 839       "isStatic" : false,
 840       "isConstructor" : false,
 841       "isPrivate" : false,
 842       "memberOf" : "Roo.util.Observable",
 843       "example" : "",
 844       "deprecated" : "",
 845       "since" : "",
 846       "see" : "",
 847       "params" : [
 848         {
 849           "name" : "eventName",
 850           "type" : "String",
 851           "desc" : "The type of event to listen for",
 852           "isOptional" : false
 853         },
 854         {
 855           "name" : "handler",
 856           "type" : "Function",
 857           "desc" : "The method the event invokes",
 858           "isOptional" : false
 859         },
 860         {
 861           "name" : "scope",
 862           "type" : "Object",
 863           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 864           "isOptional" : false
 865         },
 866         {
 867           "name" : "options",
 868           "type" : "Object",
 869           "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>",
 870           "isOptional" : false
 871         }
 872       ],
 873       "returns" : [
 874       ]
 875     }
 876   ],
 877   "events" : [
 878     {
 879       "name" : "click",
 880       "desc" : "The raw click event for the entire grid.",
 881       "memberOf" : "Roo.bootstrap.PaginationItem",
 882       "example" : "",
 883       "deprecated" : "",
 884       "since" : "",
 885       "see" : "",
 886       "params" : [
 887         {
 888           "name" : "e",
 889           "type" : "Roo.EventObject",
 890           "desc" : "",
 891           "isOptional" : false
 892         }
 893       ],
 894       "returns" : [
 895       ]
 896     },
 897     {
 898       "name" : "childrenrendered",
 899       "desc" : "Fires when the children have been rendered..",
 900       "memberOf" : "Roo.bootstrap.Component",
 901       "example" : "",
 902       "deprecated" : "",
 903       "since" : "",
 904       "see" : "",
 905       "params" : [
 906         {
 907           "name" : "this",
 908           "type" : "Roo.bootstrap.Component",
 909           "desc" : "",
 910           "isOptional" : false
 911         }
 912       ],
 913       "returns" : [
 914       ]
 915     },
 916     {
 917       "name" : "beforerender",
 918       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 919       "memberOf" : "Roo.Component",
 920       "example" : "",
 921       "deprecated" : "",
 922       "since" : "",
 923       "see" : "",
 924       "params" : [
 925         {
 926           "name" : "this",
 927           "type" : "Roo.Component",
 928           "desc" : "",
 929           "isOptional" : false
 930         }
 931       ],
 932       "returns" : [
 933       ]
 934     },
 935     {
 936       "name" : "disable",
 937       "desc" : "Fires after the component is disabled.",
 938       "memberOf" : "Roo.Component",
 939       "example" : "",
 940       "deprecated" : "",
 941       "since" : "",
 942       "see" : "",
 943       "params" : [
 944         {
 945           "name" : "this",
 946           "type" : "Roo.Component",
 947           "desc" : "",
 948           "isOptional" : false
 949         }
 950       ],
 951       "returns" : [
 952       ]
 953     },
 954     {
 955       "name" : "render",
 956       "desc" : "Fires after the component is rendered.",
 957       "memberOf" : "Roo.Component",
 958       "example" : "",
 959       "deprecated" : "",
 960       "since" : "",
 961       "see" : "",
 962       "params" : [
 963         {
 964           "name" : "this",
 965           "type" : "Roo.Component",
 966           "desc" : "",
 967           "isOptional" : false
 968         }
 969       ],
 970       "returns" : [
 971       ]
 972     },
 973     {
 974       "name" : "destroy",
 975       "desc" : "Fires after the component is destroyed.",
 976       "memberOf" : "Roo.Component",
 977       "example" : "",
 978       "deprecated" : "",
 979       "since" : "",
 980       "see" : "",
 981       "params" : [
 982         {
 983           "name" : "this",
 984           "type" : "Roo.Component",
 985           "desc" : "",
 986           "isOptional" : false
 987         }
 988       ],
 989       "returns" : [
 990       ]
 991     },
 992     {
 993       "name" : "hide",
 994       "desc" : "Fires after the component is hidden.",
 995       "memberOf" : "Roo.Component",
 996       "example" : "",
 997       "deprecated" : "",
 998       "since" : "",
 999       "see" : "",
1000       "params" : [
1001         {
1002           "name" : "this",
1003           "type" : "Roo.Component",
1004           "desc" : "",
1005           "isOptional" : false
1006         }
1007       ],
1008       "returns" : [
1009       ]
1010     },
1011     {
1012       "name" : "beforehide",
1013       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1014       "memberOf" : "Roo.Component",
1015       "example" : "",
1016       "deprecated" : "",
1017       "since" : "",
1018       "see" : "",
1019       "params" : [
1020         {
1021           "name" : "this",
1022           "type" : "Roo.Component",
1023           "desc" : "",
1024           "isOptional" : false
1025         }
1026       ],
1027       "returns" : [
1028       ]
1029     },
1030     {
1031       "name" : "show",
1032       "desc" : "Fires after the component is shown.",
1033       "memberOf" : "Roo.Component",
1034       "example" : "",
1035       "deprecated" : "",
1036       "since" : "",
1037       "see" : "",
1038       "params" : [
1039         {
1040           "name" : "this",
1041           "type" : "Roo.Component",
1042           "desc" : "",
1043           "isOptional" : false
1044         }
1045       ],
1046       "returns" : [
1047       ]
1048     },
1049     {
1050       "name" : "beforeshow",
1051       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1052       "memberOf" : "Roo.Component",
1053       "example" : "",
1054       "deprecated" : "",
1055       "since" : "",
1056       "see" : "",
1057       "params" : [
1058         {
1059           "name" : "this",
1060           "type" : "Roo.Component",
1061           "desc" : "",
1062           "isOptional" : false
1063         }
1064       ],
1065       "returns" : [
1066       ]
1067     },
1068     {
1069       "name" : "enable",
1070       "desc" : "Fires after the component is enabled.",
1071       "memberOf" : "Roo.Component",
1072       "example" : "",
1073       "deprecated" : "",
1074       "since" : "",
1075       "see" : "",
1076       "params" : [
1077         {
1078           "name" : "this",
1079           "type" : "Roo.Component",
1080           "desc" : "",
1081           "isOptional" : false
1082         }
1083       ],
1084       "returns" : [
1085       ]
1086     },
1087     {
1088       "name" : "beforedestroy",
1089       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1090       "memberOf" : "Roo.Component",
1091       "example" : "",
1092       "deprecated" : "",
1093       "since" : "",
1094       "see" : "",
1095       "params" : [
1096         {
1097           "name" : "this",
1098           "type" : "Roo.Component",
1099           "desc" : "",
1100           "isOptional" : false
1101         }
1102       ],
1103       "returns" : [
1104       ]
1105     }
1106   ]
1107 }