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

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