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

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