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