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

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