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

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