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