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