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

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