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

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