git.roojs.org Git - roojs1/blob - docs/symbols/Roo.bootstrap.Pagination.json

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