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       "optvals" : []
  34     },
  35     {
  36       "name" : "animateRef",
  37       "type" : "Boolean",
  38       "desc" : "e) link to element default false",
  39       "memberOf" : "Roo.bootstrap.NavItem",
  40       "optvals" : [
  41         "true",
  42         "false"
  43       ]
  44     },
  45     {
  46       "name" : "linkcls",
  47       "type" : "String",
  48       "desc" : "Link Class",
  49       "memberOf" : "Roo.bootstrap.NavItem",
  50       "optvals" : []
  51     },
  52     {
  53       "name" : "tagtype",
  54       "type" : "String",
  55       "desc" : "n) render as a href or span?",
  56       "memberOf" : "Roo.bootstrap.NavItem",
  57       "optvals" : [
  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       "optvals" : []
  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       "optvals" : []
  75     },
  76     {
  77       "name" : "visibilityEl",
  78       "type" : "string|object",
  79       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
  80       "memberOf" : "Roo.bootstrap.Component",
  81       "optvals" : [
  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       "optvals" : []
  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       "optvals" : []
  99     },
 100     {
 101       "name" : "hideMode",
 102       "type" : "String",
 103       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
 104       "memberOf" : "Roo.Component",
 105       "optvals" : [
 106         "display",
 107         "visibility"
 108       ]
 109     },
 110     {
 111       "name" : "badge",
 112       "type" : "String",
 113       "desc" : "text inside badge",
 114       "memberOf" : "Roo.bootstrap.NavItem",
 115       "optvals" : []
 116     },
 117     {
 118       "name" : "disabled",
 119       "type" : "Boolean",
 120       "desc" : "Is item disabled",
 121       "memberOf" : "Roo.bootstrap.NavItem",
 122       "optvals" : []
 123     },
 124     {
 125       "name" : "style",
 126       "type" : "String",
 127       "desc" : "any extra css",
 128       "memberOf" : "Roo.bootstrap.Component",
 129       "optvals" : []
 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       "optvals" : []
 137     },
 138     {
 139       "name" : "button_outline",
 140       "type" : "Boolean",
 141       "desc" : "show and outlined button",
 142       "memberOf" : "Roo.bootstrap.NavItem",
 143       "optvals" : []
 144     },
 145     {
 146       "name" : "html",
 147       "type" : "String",
 148       "desc" : "content of button",
 149       "memberOf" : "Roo.bootstrap.NavItem",
 150       "optvals" : []
 151     },
 152     {
 153       "name" : "preventDefault",
 154       "type" : "Boolean",
 155       "desc" : "e) default false",
 156       "memberOf" : "Roo.bootstrap.NavItem",
 157       "optvals" : [
 158         "true",
 159         "false"
 160       ]
 161     },
 162     {
 163       "name" : "cls",
 164       "type" : "String",
 165       "desc" : "css class",
 166       "memberOf" : "Roo.bootstrap.Component",
 167       "optvals" : []
 168     },
 169     {
 170       "name" : "glyphicon",
 171       "type" : "String",
 172       "desc" : "DEPRICATED - use fa",
 173       "memberOf" : "Roo.bootstrap.NavItem",
 174       "optvals" : []
 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       "optvals" : []
 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       "optvals" : []
 189     },
 190     {
 191       "name" : "icon",
 192       "type" : "String",
 193       "desc" : "DEPRICATED - use fa",
 194       "memberOf" : "Roo.bootstrap.NavItem",
 195       "optvals" : []
 196     },
 197     {
 198       "name" : "badgecls",
 199       "type" : "String",
 200       "desc" : "w)the extra classes for the badge",
 201       "memberOf" : "Roo.bootstrap.NavItem",
 202       "optvals" : [
 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       "optvals" : []
 214     },
 215     {
 216       "name" : "button_weight",
 217       "type" : "String",
 218       "desc" : "k) default none",
 219       "memberOf" : "Roo.bootstrap.NavItem",
 220       "optvals" : [
 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       "optvals" : []
 239     },
 240     {
 241       "name" : "active",
 242       "type" : "Boolean",
 243       "desc" : "Is item active",
 244       "memberOf" : "Roo.bootstrap.NavItem",
 245       "optvals" : []
 246     },
 247     {
 248       "name" : "name",
 249       "type" : "string",
 250       "desc" : "Specifies name attribute",
 251       "memberOf" : "Roo.bootstrap.Component",
 252       "optvals" : []
 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       "optvals" : []
 260     },
 261     {
 262       "name" : "href",
 263       "type" : "String",
 264       "desc" : "link to",
 265       "memberOf" : "Roo.bootstrap.NavItem",
 266       "optvals" : []
 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" : "setHtml",
 292       "desc" : "Set the HTML (text content) of the item",
 293       "isStatic" : false,
 294       "isConstructor" : false,
 295       "isPrivate" : false,
 296       "memberOf" : "Roo.bootstrap.NavItem",
 297       "example" : "",
 298       "deprecated" : "",
 299       "since" : "",
 300       "see" : "",
 301       "params" : [
 302         {
 303           "name" : "html",
 304           "type" : "string",
 305           "desc" : "content for the nav item",
 306           "isOptional" : false
 307         }
 308       ],
 309       "returns" : []
 310     },
 311     {
 312       "name" : "hide",
 313       "desc" : "Hide a component - adds 'hidden' class",
 314       "isStatic" : false,
 315       "isConstructor" : false,
 316       "isPrivate" : false,
 317       "memberOf" : "Roo.bootstrap.Component",
 318       "example" : "",
 319       "deprecated" : "",
 320       "since" : "",
 321       "see" : "",
 322       "params" : [],
 323       "returns" : []
 324     },
 325     {
 326       "name" : "show",
 327       "desc" : "Show a component - removes 'hidden' class",
 328       "isStatic" : false,
 329       "isConstructor" : false,
 330       "isPrivate" : false,
 331       "memberOf" : "Roo.bootstrap.Component",
 332       "example" : "",
 333       "deprecated" : "",
 334       "since" : "",
 335       "see" : "",
 336       "params" : [],
 337       "returns" : []
 338     },
 339     {
 340       "name" : "setVisibilityEl",
 341       "desc" : "Set the element that will be used to show or hide",
 342       "isStatic" : false,
 343       "isConstructor" : false,
 344       "isPrivate" : false,
 345       "memberOf" : "Roo.bootstrap.Component",
 346       "example" : "",
 347       "deprecated" : "",
 348       "since" : "",
 349       "see" : "",
 350       "params" : [],
 351       "returns" : []
 352     },
 353     {
 354       "name" : "getVisibilityEl",
 355       "desc" : "Get the element that will be used to show or hide",
 356       "isStatic" : false,
 357       "isConstructor" : false,
 358       "isPrivate" : false,
 359       "memberOf" : "Roo.bootstrap.Component",
 360       "example" : "",
 361       "deprecated" : "",
 362       "since" : "",
 363       "see" : "",
 364       "params" : [],
 365       "returns" : []
 366     },
 367     {
 368       "name" : "initEvents",
 369       "desc" : "Initialize Events for the element",
 370       "isStatic" : false,
 371       "isConstructor" : false,
 372       "isPrivate" : false,
 373       "memberOf" : "Roo.bootstrap.Component",
 374       "example" : "",
 375       "deprecated" : "",
 376       "since" : "",
 377       "see" : "",
 378       "params" : [],
 379       "returns" : []
 380     },
 381     {
 382       "name" : "getChildContainer",
 383       "desc" : "Fetch the element to add children to",
 384       "isStatic" : false,
 385       "isConstructor" : false,
 386       "isPrivate" : false,
 387       "memberOf" : "Roo.bootstrap.Component",
 388       "example" : "",
 389       "deprecated" : "",
 390       "since" : "",
 391       "see" : "",
 392       "params" : [],
 393       "returns" : [
 394         {
 395           "name" : "",
 396           "type" : "Roo.Element",
 397           "desc" : "defaults to this.el"
 398         }
 399       ]
 400     },
 401     {
 402       "name" : "getId",
 403       "desc" : "Returns the id of this component.",
 404       "isStatic" : false,
 405       "isConstructor" : false,
 406       "isPrivate" : false,
 407       "memberOf" : "Roo.Component",
 408       "example" : "",
 409       "deprecated" : "",
 410       "since" : "",
 411       "see" : "",
 412       "params" : [],
 413       "returns" : [
 414         {
 415           "name" : "",
 416           "type" : "String",
 417           "desc" : ""
 418         }
 419       ]
 420     },
 421     {
 422       "name" : "render",
 423       "desc" : "If this is a lazy rendering component, render it to its container element.",
 424       "isStatic" : false,
 425       "isConstructor" : false,
 426       "isPrivate" : false,
 427       "memberOf" : "Roo.Component",
 428       "example" : "",
 429       "deprecated" : "",
 430       "since" : "",
 431       "see" : "",
 432       "params" : [
 433         {
 434           "name" : "container",
 435           "type" : "String/HTMLElement/Element",
 436           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 437           "isOptional" : false
 438         }
 439       ],
 440       "returns" : []
 441     },
 442     {
 443       "name" : "destroy",
 444       "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}.",
 445       "isStatic" : false,
 446       "isConstructor" : false,
 447       "isPrivate" : false,
 448       "memberOf" : "Roo.Component",
 449       "example" : "",
 450       "deprecated" : "",
 451       "since" : "",
 452       "see" : "",
 453       "params" : [],
 454       "returns" : []
 455     },
 456     {
 457       "name" : "isVisible",
 458       "desc" : "Returns true if this component is visible.",
 459       "isStatic" : false,
 460       "isConstructor" : false,
 461       "isPrivate" : false,
 462       "memberOf" : "Roo.Component",
 463       "example" : "",
 464       "deprecated" : "",
 465       "since" : "",
 466       "see" : "",
 467       "params" : [],
 468       "returns" : []
 469     },
 470     {
 471       "name" : "setDisabled",
 472       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 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" : "disabled",
 484           "type" : "Boolean",
 485           "desc" : "",
 486           "isOptional" : false
 487         }
 488       ],
 489       "returns" : []
 490     },
 491     {
 492       "name" : "focus",
 493       "desc" : "Try to focus this component.",
 494       "isStatic" : false,
 495       "isConstructor" : false,
 496       "isPrivate" : false,
 497       "memberOf" : "Roo.Component",
 498       "example" : "",
 499       "deprecated" : "",
 500       "since" : "",
 501       "see" : "",
 502       "params" : [
 503         {
 504           "name" : "selectText",
 505           "type" : "Boolean",
 506           "desc" : "True to also select the text in this component (if applicable)",
 507           "isOptional" : false
 508         }
 509       ],
 510       "returns" : [
 511         {
 512           "name" : "",
 513           "type" : "Roo.Component",
 514           "desc" : "this"
 515         }
 516       ]
 517     },
 518     {
 519       "name" : "enable",
 520       "desc" : "Enable this component.",
 521       "isStatic" : false,
 522       "isConstructor" : false,
 523       "isPrivate" : false,
 524       "memberOf" : "Roo.Component",
 525       "example" : "",
 526       "deprecated" : "",
 527       "since" : "",
 528       "see" : "",
 529       "params" : [],
 530       "returns" : [
 531         {
 532           "name" : "",
 533           "type" : "Roo.Component",
 534           "desc" : "this"
 535         }
 536       ]
 537     },
 538     {
 539       "name" : "setVisible",
 540       "desc" : "Convenience function to hide or show this component by boolean.",
 541       "isStatic" : false,
 542       "isConstructor" : false,
 543       "isPrivate" : false,
 544       "memberOf" : "Roo.Component",
 545       "example" : "",
 546       "deprecated" : "",
 547       "since" : "",
 548       "see" : "",
 549       "params" : [
 550         {
 551           "name" : "visible",
 552           "type" : "Boolean",
 553           "desc" : "True to show, false to hide",
 554           "isOptional" : false
 555         }
 556       ],
 557       "returns" : [
 558         {
 559           "name" : "",
 560           "type" : "Roo.Component",
 561           "desc" : "this"
 562         }
 563       ]
 564     },
 565     {
 566       "name" : "disable",
 567       "desc" : "Disable this component.",
 568       "isStatic" : false,
 569       "isConstructor" : false,
 570       "isPrivate" : false,
 571       "memberOf" : "Roo.Component",
 572       "example" : "",
 573       "deprecated" : "",
 574       "since" : "",
 575       "see" : "",
 576       "params" : [],
 577       "returns" : [
 578         {
 579           "name" : "",
 580           "type" : "Roo.Component",
 581           "desc" : "this"
 582         }
 583       ]
 584     },
 585     {
 586       "name" : "getEl",
 587       "desc" : "Returns the underlying {@link Roo.Element}.",
 588       "isStatic" : false,
 589       "isConstructor" : false,
 590       "isPrivate" : false,
 591       "memberOf" : "Roo.Component",
 592       "example" : "",
 593       "deprecated" : "",
 594       "since" : "",
 595       "see" : "",
 596       "params" : [],
 597       "returns" : [
 598         {
 599           "name" : "",
 600           "type" : "Roo.Element",
 601           "desc" : "The element"
 602         }
 603       ]
 604     },
 605     {
 606       "name" : "purgeListeners",
 607       "desc" : "Removes all listeners for this object",
 608       "isStatic" : false,
 609       "isConstructor" : false,
 610       "isPrivate" : false,
 611       "memberOf" : "Roo.util.Observable",
 612       "example" : "",
 613       "deprecated" : "",
 614       "since" : "",
 615       "see" : "",
 616       "params" : [],
 617       "returns" : []
 618     },
 619     {
 620       "name" : "on",
 621       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 622       "isStatic" : false,
 623       "isConstructor" : false,
 624       "isPrivate" : false,
 625       "memberOf" : "Roo.util.Observable",
 626       "example" : "",
 627       "deprecated" : "",
 628       "since" : "",
 629       "see" : "",
 630       "params" : [
 631         {
 632           "name" : "eventName",
 633           "type" : "String",
 634           "desc" : "The type of event to listen for",
 635           "isOptional" : false
 636         },
 637         {
 638           "name" : "handler",
 639           "type" : "Function",
 640           "desc" : "The method the event invokes",
 641           "isOptional" : false
 642         },
 643         {
 644           "name" : "scope",
 645           "type" : "Object",
 646           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 647           "isOptional" : false
 648         },
 649         {
 650           "name" : "options",
 651           "type" : "Object",
 652           "desc" : "(optional)",
 653           "isOptional" : false
 654         }
 655       ],
 656       "returns" : []
 657     },
 658     {
 659       "name" : "un",
 660       "desc" : "Removes a listener (shorthand for removeListener)",
 661       "isStatic" : false,
 662       "isConstructor" : false,
 663       "isPrivate" : false,
 664       "memberOf" : "Roo.util.Observable",
 665       "example" : "",
 666       "deprecated" : "",
 667       "since" : "",
 668       "see" : "",
 669       "params" : [
 670         {
 671           "name" : "eventName",
 672           "type" : "String",
 673           "desc" : "The type of event to listen for",
 674           "isOptional" : false
 675         },
 676         {
 677           "name" : "handler",
 678           "type" : "Function",
 679           "desc" : "The handler to remove",
 680           "isOptional" : false
 681         },
 682         {
 683           "name" : "scope",
 684           "type" : "Object",
 685           "desc" : "(optional) The scope (this object) for the handler",
 686           "isOptional" : false
 687         }
 688       ],
 689       "returns" : []
 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       "name" : "releaseCapture",
 714       "desc" : "Removes <b>all</b> added captures from the Observable.",
 715       "isStatic" : true,
 716       "isConstructor" : false,
 717       "isPrivate" : false,
 718       "memberOf" : "Roo.util.Observable",
 719       "example" : "",
 720       "deprecated" : "",
 721       "since" : "",
 722       "see" : "",
 723       "params" : [
 724         {
 725           "name" : "o",
 726           "type" : "Observable",
 727           "desc" : "The Observable to release",
 728           "isOptional" : false
 729         }
 730       ],
 731       "returns" : []
 732     },
 733     {
 734       "name" : "removeListener",
 735       "desc" : "Removes a listener",
 736       "isStatic" : false,
 737       "isConstructor" : false,
 738       "isPrivate" : false,
 739       "memberOf" : "Roo.util.Observable",
 740       "example" : "",
 741       "deprecated" : "",
 742       "since" : "",
 743       "see" : "",
 744       "params" : [
 745         {
 746           "name" : "eventName",
 747           "type" : "String",
 748           "desc" : "The type of event to listen for",
 749           "isOptional" : false
 750         },
 751         {
 752           "name" : "handler",
 753           "type" : "Function",
 754           "desc" : "The handler to remove",
 755           "isOptional" : false
 756         },
 757         {
 758           "name" : "scope",
 759           "type" : "Object",
 760           "desc" : "(optional) The scope (this object) for the handler",
 761           "isOptional" : false
 762         }
 763       ],
 764       "returns" : []
 765     },
 766     {
 767       "name" : "fireEvent",
 768       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 769       "isStatic" : false,
 770       "isConstructor" : false,
 771       "isPrivate" : false,
 772       "memberOf" : "Roo.util.Observable",
 773       "example" : "",
 774       "deprecated" : "",
 775       "since" : "",
 776       "see" : "",
 777       "params" : [
 778         {
 779           "name" : "eventName",
 780           "type" : "String",
 781           "desc" : "",
 782           "isOptional" : false
 783         },
 784         {
 785           "name" : "args",
 786           "type" : "Object...",
 787           "desc" : "Variable number of parameters are passed to handlers",
 788           "isOptional" : false
 789         }
 790       ],
 791       "returns" : [
 792         {
 793           "name" : "",
 794           "type" : "Boolean",
 795           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 796         }
 797       ]
 798     },
 799     {
 800       "name" : "hasListener",
 801       "desc" : "Checks to see if this object has any listeners for a specified event",
 802       "isStatic" : false,
 803       "isConstructor" : false,
 804       "isPrivate" : false,
 805       "memberOf" : "Roo.util.Observable",
 806       "example" : "",
 807       "deprecated" : "",
 808       "since" : "",
 809       "see" : "",
 810       "params" : [
 811         {
 812           "name" : "eventName",
 813           "type" : "String",
 814           "desc" : "The name of the event to check for",
 815           "isOptional" : false
 816         }
 817       ],
 818       "returns" : [
 819         {
 820           "name" : "",
 821           "type" : "Boolean",
 822           "desc" : "True if the event is being listened for, else false"
 823         }
 824       ]
 825     },
 826     {
 827       "name" : "capture",
 828       "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.",
 829       "isStatic" : true,
 830       "isConstructor" : false,
 831       "isPrivate" : false,
 832       "memberOf" : "Roo.util.Observable",
 833       "example" : "",
 834       "deprecated" : "",
 835       "since" : "",
 836       "see" : "",
 837       "params" : [
 838         {
 839           "name" : "o",
 840           "type" : "Observable",
 841           "desc" : "The Observable to capture",
 842           "isOptional" : false
 843         },
 844         {
 845           "name" : "fn",
 846           "type" : "Function",
 847           "desc" : "The function to call",
 848           "isOptional" : false
 849         },
 850         {
 851           "name" : "scope",
 852           "type" : "Object",
 853           "desc" : "(optional) The scope (this object) for the fn",
 854           "isOptional" : false
 855         }
 856       ],
 857       "returns" : []
 858     },
 859     {
 860       "name" : "addListener",
 861       "desc" : "Appends an event handler to this component",
 862       "isStatic" : false,
 863       "isConstructor" : false,
 864       "isPrivate" : false,
 865       "memberOf" : "Roo.util.Observable",
 866       "example" : "",
 867       "deprecated" : "",
 868       "since" : "",
 869       "see" : "",
 870       "params" : [
 871         {
 872           "name" : "eventName",
 873           "type" : "String",
 874           "desc" : "The type of event to listen for",
 875           "isOptional" : false
 876         },
 877         {
 878           "name" : "handler",
 879           "type" : "Function",
 880           "desc" : "The method the event invokes",
 881           "isOptional" : false
 882         },
 883         {
 884           "name" : "scope",
 885           "type" : "Object",
 886           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 887           "isOptional" : false
 888         },
 889         {
 890           "name" : "options",
 891           "type" : "Object",
 892           "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>",
 893           "isOptional" : false
 894         }
 895       ],
 896       "returns" : []
 897     }
 898   ],
 899   "events" : [
 900     {
 901       "name" : "changed",
 902       "desc" : "Fires when the active item active state changes",
 903       "memberOf" : "Roo.bootstrap.NavSidebarItem",
 904       "example" : "",
 905       "deprecated" : "",
 906       "since" : "",
 907       "see" : "",
 908       "params" : [
 909         {
 910           "name" : "this",
 911           "type" : "Roo.bootstrap.NavSidebarItem",
 912           "desc" : "",
 913           "isOptional" : false
 914         },
 915         {
 916           "name" : "state",
 917           "type" : "boolean",
 918           "desc" : "the new state",
 919           "isOptional" : false
 920         }
 921       ],
 922       "returns" : []
 923     },
 924     {
 925       "name" : "click",
 926       "desc" : "The raw click event for the entire grid.",
 927       "memberOf" : "Roo.bootstrap.NavSidebarItem",
 928       "example" : "",
 929       "deprecated" : "",
 930       "since" : "",
 931       "see" : "",
 932       "params" : [
 933         {
 934           "name" : "e",
 935           "type" : "Roo.EventObject",
 936           "desc" : "",
 937           "isOptional" : false
 938         }
 939       ],
 940       "returns" : []
 941     },
 942     {
 943       "name" : "scrollto",
 944       "desc" : "Fires when scroll to element",
 945       "memberOf" : "Roo.bootstrap.NavItem",
 946       "example" : "",
 947       "deprecated" : "",
 948       "since" : "",
 949       "see" : "",
 950       "params" : [
 951         {
 952           "name" : "this",
 953           "type" : "Roo.bootstrap.NavItem",
 954           "desc" : "",
 955           "isOptional" : false
 956         },
 957         {
 958           "name" : "options",
 959           "type" : "Object",
 960           "desc" : "",
 961           "isOptional" : false
 962         },
 963         {
 964           "name" : "e",
 965           "type" : "Roo.EventObject",
 966           "desc" : "",
 967           "isOptional" : false
 968         }
 969       ],
 970       "returns" : []
 971     },
 972     {
 973       "name" : "childrenrendered",
 974       "desc" : "Fires when the children have been rendered..",
 975       "memberOf" : "Roo.bootstrap.Component",
 976       "example" : "",
 977       "deprecated" : "",
 978       "since" : "",
 979       "see" : "",
 980       "params" : [
 981         {
 982           "name" : "this",
 983           "type" : "Roo.bootstrap.Component",
 984           "desc" : "",
 985           "isOptional" : false
 986         }
 987       ],
 988       "returns" : []
 989     },
 990     {
 991       "name" : "beforerender",
 992       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 993       "memberOf" : "Roo.Component",
 994       "example" : "",
 995       "deprecated" : "",
 996       "since" : "",
 997       "see" : "",
 998       "params" : [
 999         {
1000           "name" : "this",
1001           "type" : "Roo.Component",
1002           "desc" : "",
1003           "isOptional" : false
1004         }
1005       ],
1006       "returns" : []
1007     },
1008     {
1009       "name" : "disable",
1010       "desc" : "Fires after the component is disabled.",
1011       "memberOf" : "Roo.Component",
1012       "example" : "",
1013       "deprecated" : "",
1014       "since" : "",
1015       "see" : "",
1016       "params" : [
1017         {
1018           "name" : "this",
1019           "type" : "Roo.Component",
1020           "desc" : "",
1021           "isOptional" : false
1022         }
1023       ],
1024       "returns" : []
1025     },
1026     {
1027       "name" : "render",
1028       "desc" : "Fires after the component is rendered.",
1029       "memberOf" : "Roo.Component",
1030       "example" : "",
1031       "deprecated" : "",
1032       "since" : "",
1033       "see" : "",
1034       "params" : [
1035         {
1036           "name" : "this",
1037           "type" : "Roo.Component",
1038           "desc" : "",
1039           "isOptional" : false
1040         }
1041       ],
1042       "returns" : []
1043     },
1044     {
1045       "name" : "destroy",
1046       "desc" : "Fires after the component is destroyed.",
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       "name" : "hide",
1064       "desc" : "Fires after the component is hidden.",
1065       "memberOf" : "Roo.Component",
1066       "example" : "",
1067       "deprecated" : "",
1068       "since" : "",
1069       "see" : "",
1070       "params" : [
1071         {
1072           "name" : "this",
1073           "type" : "Roo.Component",
1074           "desc" : "",
1075           "isOptional" : false
1076         }
1077       ],
1078       "returns" : []
1079     },
1080     {
1081       "name" : "beforehide",
1082       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1083       "memberOf" : "Roo.Component",
1084       "example" : "",
1085       "deprecated" : "",
1086       "since" : "",
1087       "see" : "",
1088       "params" : [
1089         {
1090           "name" : "this",
1091           "type" : "Roo.Component",
1092           "desc" : "",
1093           "isOptional" : false
1094         }
1095       ],
1096       "returns" : []
1097     },
1098     {
1099       "name" : "show",
1100       "desc" : "Fires after the component is shown.",
1101       "memberOf" : "Roo.Component",
1102       "example" : "",
1103       "deprecated" : "",
1104       "since" : "",
1105       "see" : "",
1106       "params" : [
1107         {
1108           "name" : "this",
1109           "type" : "Roo.Component",
1110           "desc" : "",
1111           "isOptional" : false
1112         }
1113       ],
1114       "returns" : []
1115     },
1116     {
1117       "name" : "beforeshow",
1118       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1119       "memberOf" : "Roo.Component",
1120       "example" : "",
1121       "deprecated" : "",
1122       "since" : "",
1123       "see" : "",
1124       "params" : [
1125         {
1126           "name" : "this",
1127           "type" : "Roo.Component",
1128           "desc" : "",
1129           "isOptional" : false
1130         }
1131       ],
1132       "returns" : []
1133     },
1134     {
1135       "name" : "enable",
1136       "desc" : "Fires after the component is enabled.",
1137       "memberOf" : "Roo.Component",
1138       "example" : "",
1139       "deprecated" : "",
1140       "since" : "",
1141       "see" : "",
1142       "params" : [
1143         {
1144           "name" : "this",
1145           "type" : "Roo.Component",
1146           "desc" : "",
1147           "isOptional" : false
1148         }
1149       ],
1150       "returns" : []
1151     },
1152     {
1153       "name" : "beforedestroy",
1154       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1155       "memberOf" : "Roo.Component",
1156       "example" : "",
1157       "deprecated" : "",
1158       "since" : "",
1159       "see" : "",
1160       "params" : [
1161         {
1162           "name" : "this",
1163           "type" : "Roo.Component",
1164           "desc" : "",
1165           "isOptional" : false
1166         }
1167       ],
1168       "returns" : []
1169     }
1170   ]
1171 }