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