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

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