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