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

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