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