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