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" : "tooltipEl",
 235       "desc" : "Fetch the element to display the tooltip on.",
 236       "isStatic" : false,
 237       "isConstructor" : false,
 238       "isPrivate" : false,
 239       "memberOf" : "Roo.bootstrap.Component",
 240       "example" : "",
 241       "deprecated" : "",
 242       "since" : "",
 243       "see" : "",
 244       "params" : [
 245       ],
 246       "returns" : [
 247         {
 248           "name" : "",
 249           "type" : "Roo.Element",
 250           "desc" : "defaults to this.el"
 251         }
 252       ]
 253     },
 254     {
 255       "name" : "hide",
 256       "desc" : "Hide a component - adds 'hidden' class",
 257       "isStatic" : false,
 258       "isConstructor" : false,
 259       "isPrivate" : false,
 260       "memberOf" : "Roo.bootstrap.Component",
 261       "example" : "",
 262       "deprecated" : "",
 263       "since" : "",
 264       "see" : "",
 265       "params" : [
 266       ],
 267       "returns" : [
 268       ]
 269     },
 270     {
 271       "name" : "show",
 272       "desc" : "Show a component - removes 'hidden' class",
 273       "isStatic" : false,
 274       "isConstructor" : false,
 275       "isPrivate" : false,
 276       "memberOf" : "Roo.bootstrap.Component",
 277       "example" : "",
 278       "deprecated" : "",
 279       "since" : "",
 280       "see" : "",
 281       "params" : [
 282       ],
 283       "returns" : [
 284       ]
 285     },
 286     {
 287       "name" : "setVisibilityEl",
 288       "desc" : "Set the element that will be used to show or hide",
 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" : "getVisibilityEl",
 304       "desc" : "Get the element that will be used to show or hide",
 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" : "initEvents",
 320       "desc" : "Initialize Events for the element",
 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" : "getChildContainer",
 336       "desc" : "Fetch the element to add children to",
 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           "name" : "",
 350           "type" : "Roo.Element",
 351           "desc" : "defaults to this.el"
 352         }
 353       ]
 354     },
 355     {
 356       "name" : "getId",
 357       "desc" : "Returns the id of this component.",
 358       "isStatic" : false,
 359       "isConstructor" : false,
 360       "isPrivate" : false,
 361       "memberOf" : "Roo.Component",
 362       "example" : "",
 363       "deprecated" : "",
 364       "since" : "",
 365       "see" : "",
 366       "params" : [
 367       ],
 368       "returns" : [
 369         {
 370           "name" : "",
 371           "type" : "String",
 372           "desc" : ""
 373         }
 374       ]
 375     },
 376     {
 377       "name" : "render",
 378       "desc" : "If this is a lazy rendering component, render it to its container element.",
 379       "isStatic" : false,
 380       "isConstructor" : false,
 381       "isPrivate" : false,
 382       "memberOf" : "Roo.Component",
 383       "example" : "",
 384       "deprecated" : "",
 385       "since" : "",
 386       "see" : "",
 387       "params" : [
 388         {
 389           "name" : "container",
 390           "type" : "String/HTMLElement/Element",
 391           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 392           "isOptional" : false
 393         }
 394       ],
 395       "returns" : [
 396       ]
 397     },
 398     {
 399       "name" : "destroy",
 400       "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}.",
 401       "isStatic" : false,
 402       "isConstructor" : false,
 403       "isPrivate" : false,
 404       "memberOf" : "Roo.Component",
 405       "example" : "",
 406       "deprecated" : "",
 407       "since" : "",
 408       "see" : "",
 409       "params" : [
 410       ],
 411       "returns" : [
 412       ]
 413     },
 414     {
 415       "name" : "isVisible",
 416       "desc" : "Returns true if this component is visible.",
 417       "isStatic" : false,
 418       "isConstructor" : false,
 419       "isPrivate" : false,
 420       "memberOf" : "Roo.Component",
 421       "example" : "",
 422       "deprecated" : "",
 423       "since" : "",
 424       "see" : "",
 425       "params" : [
 426       ],
 427       "returns" : [
 428       ]
 429     },
 430     {
 431       "name" : "setDisabled",
 432       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 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           "name" : "disabled",
 444           "type" : "Boolean",
 445           "desc" : "",
 446           "isOptional" : false
 447         }
 448       ],
 449       "returns" : [
 450       ]
 451     },
 452     {
 453       "name" : "focus",
 454       "desc" : "Try to focus this component.",
 455       "isStatic" : false,
 456       "isConstructor" : false,
 457       "isPrivate" : false,
 458       "memberOf" : "Roo.Component",
 459       "example" : "",
 460       "deprecated" : "",
 461       "since" : "",
 462       "see" : "",
 463       "params" : [
 464         {
 465           "name" : "selectText",
 466           "type" : "Boolean",
 467           "desc" : "True to also select the text in this component (if applicable)",
 468           "isOptional" : false
 469         }
 470       ],
 471       "returns" : [
 472         {
 473           "name" : "",
 474           "type" : "Roo.Component",
 475           "desc" : "this"
 476         }
 477       ]
 478     },
 479     {
 480       "name" : "enable",
 481       "desc" : "Enable this component.",
 482       "isStatic" : false,
 483       "isConstructor" : false,
 484       "isPrivate" : false,
 485       "memberOf" : "Roo.Component",
 486       "example" : "",
 487       "deprecated" : "",
 488       "since" : "",
 489       "see" : "",
 490       "params" : [
 491       ],
 492       "returns" : [
 493         {
 494           "name" : "",
 495           "type" : "Roo.Component",
 496           "desc" : "this"
 497         }
 498       ]
 499     },
 500     {
 501       "name" : "setVisible",
 502       "desc" : "Convenience function to hide or show this component by boolean.",
 503       "isStatic" : false,
 504       "isConstructor" : false,
 505       "isPrivate" : false,
 506       "memberOf" : "Roo.Component",
 507       "example" : "",
 508       "deprecated" : "",
 509       "since" : "",
 510       "see" : "",
 511       "params" : [
 512         {
 513           "name" : "visible",
 514           "type" : "Boolean",
 515           "desc" : "True to show, false to hide",
 516           "isOptional" : false
 517         }
 518       ],
 519       "returns" : [
 520         {
 521           "name" : "",
 522           "type" : "Roo.Component",
 523           "desc" : "this"
 524         }
 525       ]
 526     },
 527     {
 528       "name" : "disable",
 529       "desc" : "Disable this component.",
 530       "isStatic" : false,
 531       "isConstructor" : false,
 532       "isPrivate" : false,
 533       "memberOf" : "Roo.Component",
 534       "example" : "",
 535       "deprecated" : "",
 536       "since" : "",
 537       "see" : "",
 538       "params" : [
 539       ],
 540       "returns" : [
 541         {
 542           "name" : "",
 543           "type" : "Roo.Component",
 544           "desc" : "this"
 545         }
 546       ]
 547     },
 548     {
 549       "name" : "getEl",
 550       "desc" : "Returns the underlying {@link Roo.Element}.",
 551       "isStatic" : false,
 552       "isConstructor" : false,
 553       "isPrivate" : false,
 554       "memberOf" : "Roo.Component",
 555       "example" : "",
 556       "deprecated" : "",
 557       "since" : "",
 558       "see" : "",
 559       "params" : [
 560       ],
 561       "returns" : [
 562         {
 563           "name" : "",
 564           "type" : "Roo.Element",
 565           "desc" : "The element"
 566         }
 567       ]
 568     },
 569     {
 570       "name" : "purgeListeners",
 571       "desc" : "Removes all listeners for this object",
 572       "isStatic" : false,
 573       "isConstructor" : false,
 574       "isPrivate" : false,
 575       "memberOf" : "Roo.util.Observable",
 576       "example" : "",
 577       "deprecated" : "",
 578       "since" : "",
 579       "see" : "",
 580       "params" : [
 581       ],
 582       "returns" : [
 583       ]
 584     },
 585     {
 586       "name" : "on",
 587       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 588       "isStatic" : false,
 589       "isConstructor" : false,
 590       "isPrivate" : false,
 591       "memberOf" : "Roo.util.Observable",
 592       "example" : "",
 593       "deprecated" : "",
 594       "since" : "",
 595       "see" : "",
 596       "params" : [
 597         {
 598           "name" : "eventName",
 599           "type" : "String",
 600           "desc" : "The type of event to listen for",
 601           "isOptional" : false
 602         },
 603         {
 604           "name" : "handler",
 605           "type" : "Function",
 606           "desc" : "The method the event invokes",
 607           "isOptional" : false
 608         },
 609         {
 610           "name" : "scope",
 611           "type" : "Object",
 612           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 613           "isOptional" : false
 614         },
 615         {
 616           "name" : "options",
 617           "type" : "Object",
 618           "desc" : "(optional)",
 619           "isOptional" : false
 620         }
 621       ],
 622       "returns" : [
 623       ]
 624     },
 625     {
 626       "name" : "un",
 627       "desc" : "Removes a listener (shorthand for removeListener)",
 628       "isStatic" : false,
 629       "isConstructor" : false,
 630       "isPrivate" : false,
 631       "memberOf" : "Roo.util.Observable",
 632       "example" : "",
 633       "deprecated" : "",
 634       "since" : "",
 635       "see" : "",
 636       "params" : [
 637         {
 638           "name" : "eventName",
 639           "type" : "String",
 640           "desc" : "The type of event to listen for",
 641           "isOptional" : false
 642         },
 643         {
 644           "name" : "handler",
 645           "type" : "Function",
 646           "desc" : "The handler to remove",
 647           "isOptional" : false
 648         },
 649         {
 650           "name" : "scope",
 651           "type" : "Object",
 652           "desc" : "(optional) The scope (this object) for the handler",
 653           "isOptional" : false
 654         }
 655       ],
 656       "returns" : [
 657       ]
 658     },
 659     {
 660       "name" : "addEvents",
 661       "desc" : "Used to define events on this Observable",
 662       "isStatic" : false,
 663       "isConstructor" : false,
 664       "isPrivate" : false,
 665       "memberOf" : "Roo.util.Observable",
 666       "example" : "",
 667       "deprecated" : "",
 668       "since" : "",
 669       "see" : "",
 670       "params" : [
 671         {
 672           "name" : "object",
 673           "type" : "Object",
 674           "desc" : "The object with the events defined",
 675           "isOptional" : false
 676         }
 677       ],
 678       "returns" : [
 679       ]
 680     },
 681     {
 682       "name" : "releaseCapture",
 683       "desc" : "Removes <b>all</b> added captures from the Observable.",
 684       "isStatic" : true,
 685       "isConstructor" : false,
 686       "isPrivate" : false,
 687       "memberOf" : "Roo.util.Observable",
 688       "example" : "",
 689       "deprecated" : "",
 690       "since" : "",
 691       "see" : "",
 692       "params" : [
 693         {
 694           "name" : "o",
 695           "type" : "Observable",
 696           "desc" : "The Observable to release",
 697           "isOptional" : false
 698         }
 699       ],
 700       "returns" : [
 701       ]
 702     },
 703     {
 704       "name" : "removeListener",
 705       "desc" : "Removes a listener",
 706       "isStatic" : false,
 707       "isConstructor" : false,
 708       "isPrivate" : false,
 709       "memberOf" : "Roo.util.Observable",
 710       "example" : "",
 711       "deprecated" : "",
 712       "since" : "",
 713       "see" : "",
 714       "params" : [
 715         {
 716           "name" : "eventName",
 717           "type" : "String",
 718           "desc" : "The type of event to listen for",
 719           "isOptional" : false
 720         },
 721         {
 722           "name" : "handler",
 723           "type" : "Function",
 724           "desc" : "The handler to remove",
 725           "isOptional" : false
 726         },
 727         {
 728           "name" : "scope",
 729           "type" : "Object",
 730           "desc" : "(optional) The scope (this object) for the handler",
 731           "isOptional" : false
 732         }
 733       ],
 734       "returns" : [
 735       ]
 736     },
 737     {
 738       "name" : "fireEvent",
 739       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 740       "isStatic" : false,
 741       "isConstructor" : false,
 742       "isPrivate" : false,
 743       "memberOf" : "Roo.util.Observable",
 744       "example" : "",
 745       "deprecated" : "",
 746       "since" : "",
 747       "see" : "",
 748       "params" : [
 749         {
 750           "name" : "eventName",
 751           "type" : "String",
 752           "desc" : "",
 753           "isOptional" : false
 754         },
 755         {
 756           "name" : "args",
 757           "type" : "Object...",
 758           "desc" : "Variable number of parameters are passed to handlers",
 759           "isOptional" : false
 760         }
 761       ],
 762       "returns" : [
 763         {
 764           "name" : "",
 765           "type" : "Boolean",
 766           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 767         }
 768       ]
 769     },
 770     {
 771       "name" : "hasListener",
 772       "desc" : "Checks to see if this object has any listeners for a specified event",
 773       "isStatic" : false,
 774       "isConstructor" : false,
 775       "isPrivate" : false,
 776       "memberOf" : "Roo.util.Observable",
 777       "example" : "",
 778       "deprecated" : "",
 779       "since" : "",
 780       "see" : "",
 781       "params" : [
 782         {
 783           "name" : "eventName",
 784           "type" : "String",
 785           "desc" : "The name of the event to check for",
 786           "isOptional" : false
 787         }
 788       ],
 789       "returns" : [
 790         {
 791           "name" : "",
 792           "type" : "Boolean",
 793           "desc" : "True if the event is being listened for, else false"
 794         }
 795       ]
 796     },
 797     {
 798       "name" : "capture",
 799       "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.",
 800       "isStatic" : true,
 801       "isConstructor" : false,
 802       "isPrivate" : false,
 803       "memberOf" : "Roo.util.Observable",
 804       "example" : "",
 805       "deprecated" : "",
 806       "since" : "",
 807       "see" : "",
 808       "params" : [
 809         {
 810           "name" : "o",
 811           "type" : "Observable",
 812           "desc" : "The Observable to capture",
 813           "isOptional" : false
 814         },
 815         {
 816           "name" : "fn",
 817           "type" : "Function",
 818           "desc" : "The function to call",
 819           "isOptional" : false
 820         },
 821         {
 822           "name" : "scope",
 823           "type" : "Object",
 824           "desc" : "(optional) The scope (this object) for the fn",
 825           "isOptional" : false
 826         }
 827       ],
 828       "returns" : [
 829       ]
 830     },
 831     {
 832       "name" : "addListener",
 833       "desc" : "Appends an event handler to this component",
 834       "isStatic" : false,
 835       "isConstructor" : false,
 836       "isPrivate" : false,
 837       "memberOf" : "Roo.util.Observable",
 838       "example" : "",
 839       "deprecated" : "",
 840       "since" : "",
 841       "see" : "",
 842       "params" : [
 843         {
 844           "name" : "eventName",
 845           "type" : "String",
 846           "desc" : "The type of event to listen for",
 847           "isOptional" : false
 848         },
 849         {
 850           "name" : "handler",
 851           "type" : "Function",
 852           "desc" : "The method the event invokes",
 853           "isOptional" : false
 854         },
 855         {
 856           "name" : "scope",
 857           "type" : "Object",
 858           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 859           "isOptional" : false
 860         },
 861         {
 862           "name" : "options",
 863           "type" : "Object",
 864           "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>",
 865           "isOptional" : false
 866         }
 867       ],
 868       "returns" : [
 869       ]
 870     }
 871   ],
 872   "events" : [
 873     {
 874       "name" : "beforetoggle",
 875       "desc" : "Fire before toggle the menu",
 876       "memberOf" : "Roo.bootstrap.Navbar",
 877       "example" : "",
 878       "deprecated" : "",
 879       "since" : "",
 880       "see" : "",
 881       "params" : [
 882         {
 883           "name" : "e",
 884           "type" : "Roo.EventObject",
 885           "desc" : "",
 886           "isOptional" : false
 887         }
 888       ],
 889       "returns" : [
 890       ]
 891     },
 892     {
 893       "name" : "childrenrendered",
 894       "desc" : "Fires when the children have been rendered..",
 895       "memberOf" : "Roo.bootstrap.Component",
 896       "example" : "",
 897       "deprecated" : "",
 898       "since" : "",
 899       "see" : "",
 900       "params" : [
 901         {
 902           "name" : "this",
 903           "type" : "Roo.bootstrap.Component",
 904           "desc" : "",
 905           "isOptional" : false
 906         }
 907       ],
 908       "returns" : [
 909       ]
 910     },
 911     {
 912       "name" : "beforerender",
 913       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 914       "memberOf" : "Roo.Component",
 915       "example" : "",
 916       "deprecated" : "",
 917       "since" : "",
 918       "see" : "",
 919       "params" : [
 920         {
 921           "name" : "this",
 922           "type" : "Roo.Component",
 923           "desc" : "",
 924           "isOptional" : false
 925         }
 926       ],
 927       "returns" : [
 928       ]
 929     },
 930     {
 931       "name" : "disable",
 932       "desc" : "Fires after the component is disabled.",
 933       "memberOf" : "Roo.Component",
 934       "example" : "",
 935       "deprecated" : "",
 936       "since" : "",
 937       "see" : "",
 938       "params" : [
 939         {
 940           "name" : "this",
 941           "type" : "Roo.Component",
 942           "desc" : "",
 943           "isOptional" : false
 944         }
 945       ],
 946       "returns" : [
 947       ]
 948     },
 949     {
 950       "name" : "render",
 951       "desc" : "Fires after the component is rendered.",
 952       "memberOf" : "Roo.Component",
 953       "example" : "",
 954       "deprecated" : "",
 955       "since" : "",
 956       "see" : "",
 957       "params" : [
 958         {
 959           "name" : "this",
 960           "type" : "Roo.Component",
 961           "desc" : "",
 962           "isOptional" : false
 963         }
 964       ],
 965       "returns" : [
 966       ]
 967     },
 968     {
 969       "name" : "destroy",
 970       "desc" : "Fires after the component is destroyed.",
 971       "memberOf" : "Roo.Component",
 972       "example" : "",
 973       "deprecated" : "",
 974       "since" : "",
 975       "see" : "",
 976       "params" : [
 977         {
 978           "name" : "this",
 979           "type" : "Roo.Component",
 980           "desc" : "",
 981           "isOptional" : false
 982         }
 983       ],
 984       "returns" : [
 985       ]
 986     },
 987     {
 988       "name" : "hide",
 989       "desc" : "Fires after the component is hidden.",
 990       "memberOf" : "Roo.Component",
 991       "example" : "",
 992       "deprecated" : "",
 993       "since" : "",
 994       "see" : "",
 995       "params" : [
 996         {
 997           "name" : "this",
 998           "type" : "Roo.Component",
 999           "desc" : "",
1000           "isOptional" : false
1001         }
1002       ],
1003       "returns" : [
1004       ]
1005     },
1006     {
1007       "name" : "beforehide",
1008       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1009       "memberOf" : "Roo.Component",
1010       "example" : "",
1011       "deprecated" : "",
1012       "since" : "",
1013       "see" : "",
1014       "params" : [
1015         {
1016           "name" : "this",
1017           "type" : "Roo.Component",
1018           "desc" : "",
1019           "isOptional" : false
1020         }
1021       ],
1022       "returns" : [
1023       ]
1024     },
1025     {
1026       "name" : "show",
1027       "desc" : "Fires after the component is shown.",
1028       "memberOf" : "Roo.Component",
1029       "example" : "",
1030       "deprecated" : "",
1031       "since" : "",
1032       "see" : "",
1033       "params" : [
1034         {
1035           "name" : "this",
1036           "type" : "Roo.Component",
1037           "desc" : "",
1038           "isOptional" : false
1039         }
1040       ],
1041       "returns" : [
1042       ]
1043     },
1044     {
1045       "name" : "beforeshow",
1046       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1047       "memberOf" : "Roo.Component",
1048       "example" : "",
1049       "deprecated" : "",
1050       "since" : "",
1051       "see" : "",
1052       "params" : [
1053         {
1054           "name" : "this",
1055           "type" : "Roo.Component",
1056           "desc" : "",
1057           "isOptional" : false
1058         }
1059       ],
1060       "returns" : [
1061       ]
1062     },
1063     {
1064       "name" : "enable",
1065       "desc" : "Fires after the component is enabled.",
1066       "memberOf" : "Roo.Component",
1067       "example" : "",
1068       "deprecated" : "",
1069       "since" : "",
1070       "see" : "",
1071       "params" : [
1072         {
1073           "name" : "this",
1074           "type" : "Roo.Component",
1075           "desc" : "",
1076           "isOptional" : false
1077         }
1078       ],
1079       "returns" : [
1080       ]
1081     },
1082     {
1083       "name" : "beforedestroy",
1084       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1085       "memberOf" : "Roo.Component",
1086       "example" : "",
1087       "deprecated" : "",
1088       "since" : "",
1089       "see" : "",
1090       "params" : [
1091         {
1092           "name" : "this",
1093           "type" : "Roo.Component",
1094           "desc" : "",
1095           "isOptional" : false
1096         }
1097       ],
1098       "returns" : [
1099       ]
1100     }
1101   ]
1102 }