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

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