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