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

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