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

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