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

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