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

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