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

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