git.roojs.org Git - roojs1/blob - docs/symbols/Roo.bootstrap.nav.SidebarItem.json

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