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

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