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