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