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