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