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

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