git.roojs.org Git - roojs1/blob - docs/symbols/Roo.form.BasicForm.json

   1 {
   2   "name" : "Roo.form.BasicForm",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "Supplies the functionality to do \"actions\" on forms and initialize Roo.form.Field types on existing markup.",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "BasicForm",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "el",
  18       "type" : "String/HTMLElement/Roo.Element",
  19       "desc" : "The form element or its id",
  20       "isOptional" : false
  21     },
  22     {
  23       "name" : "config",
  24       "type" : "Object",
  25       "desc" : "Configuration options",
  26       "isOptional" : false
  27     }
  28   ],
  29   "returns" : [
  30   ],
  31   "config" : [
  32     {
  33       "name" : "listeners",
  34       "type" : "Object",
  35       "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>",
  36       "memberOf" : "Roo.util.Observable",
  37       "values" : [
  38       ]
  39     },
  40     {
  41       "name" : "fileUpload",
  42       "type" : "Boolean",
  43       "desc" : "Set to true if this form is a file upload.",
  44       "memberOf" : "Roo.form.BasicForm",
  45       "values" : [
  46       ]
  47     },
  48     {
  49       "name" : "method",
  50       "type" : "String",
  51       "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
  52       "memberOf" : "Roo.form.BasicForm",
  53       "values" : [
  54       ]
  55     },
  56     {
  57       "name" : "timeout",
  58       "type" : "Number",
  59       "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
  60       "memberOf" : "Roo.form.BasicForm",
  61       "values" : [
  62       ]
  63     },
  64     {
  65       "name" : "baseParams",
  66       "type" : "Object",
  67       "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
  68       "memberOf" : "Roo.form.BasicForm",
  69       "values" : [
  70       ]
  71     },
  72     {
  73       "name" : "trackResetOnLoad",
  74       "type" : "Boolean",
  75       "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
  76       "memberOf" : "Roo.form.BasicForm",
  77       "values" : [
  78       ]
  79     },
  80     {
  81       "name" : "reader",
  82       "type" : "DataReader",
  83       "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
  84       "memberOf" : "Roo.form.BasicForm",
  85       "values" : [
  86       ]
  87     },
  88     {
  89       "name" : "errorReader",
  90       "type" : "DataReader",
  91       "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
  92       "memberOf" : "Roo.form.BasicForm",
  93       "values" : [
  94       ]
  95     },
  96     {
  97       "name" : "url",
  98       "type" : "String",
  99       "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
 100       "memberOf" : "Roo.form.BasicForm",
 101       "values" : [
 102       ]
 103     }
 104   ],
 105   "methods" : [
 106     {
 107       "name" : "remove",
 108       "desc" : "Removes a field from the items collection (does NOT remove its markup).",
 109       "isStatic" : false,
 110       "isConstructor" : false,
 111       "isPrivate" : false,
 112       "memberOf" : "Roo.form.BasicForm",
 113       "example" : "",
 114       "deprecated" : "",
 115       "since" : "",
 116       "see" : "",
 117       "params" : [
 118         {
 119           "name" : "field",
 120           "type" : "Field",
 121           "desc" : "",
 122           "isOptional" : false
 123         }
 124       ],
 125       "returns" : [
 126         {
 127           "name" : "",
 128           "type" : "BasicForm",
 129           "desc" : "this"
 130         }
 131       ]
 132     },
 133     {
 134       "name" : "loadRecord",
 135       "desc" : "Loads an Roo.data.Record into this form.",
 136       "isStatic" : false,
 137       "isConstructor" : false,
 138       "isPrivate" : false,
 139       "memberOf" : "Roo.form.BasicForm",
 140       "example" : "",
 141       "deprecated" : "",
 142       "since" : "",
 143       "see" : "",
 144       "params" : [
 145         {
 146           "name" : "record",
 147           "type" : "Record",
 148           "desc" : "The record to load",
 149           "isOptional" : false
 150         }
 151       ],
 152       "returns" : [
 153         {
 154           "name" : "",
 155           "type" : "BasicForm",
 156           "desc" : "this"
 157         }
 158       ]
 159     },
 160     {
 161       "name" : "load",
 162       "desc" : "Shortcut to do a load action.",
 163       "isStatic" : false,
 164       "isConstructor" : false,
 165       "isPrivate" : false,
 166       "memberOf" : "Roo.form.BasicForm",
 167       "example" : "",
 168       "deprecated" : "",
 169       "since" : "",
 170       "see" : "",
 171       "params" : [
 172         {
 173           "name" : "options",
 174           "type" : "Object",
 175           "desc" : "The options to pass to the action (see {@link #doAction} for details)",
 176           "isOptional" : false
 177         }
 178       ],
 179       "returns" : [
 180         {
 181           "name" : "",
 182           "type" : "BasicForm",
 183           "desc" : "this"
 184         }
 185       ]
 186     },
 187     {
 188       "name" : "doAction",
 189       "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
 190       "isStatic" : false,
 191       "isConstructor" : false,
 192       "isPrivate" : false,
 193       "memberOf" : "Roo.form.BasicForm",
 194       "example" : "",
 195       "deprecated" : "",
 196       "since" : "",
 197       "see" : "",
 198       "params" : [
 199         {
 200           "name" : "actionName",
 201           "type" : "String",
 202           "desc" : "The name of the action type",
 203           "isOptional" : false
 204         },
 205         {
 206           "name" : "options",
 207           "type" : "Object",
 208           "desc" : "(optional) The options to pass to the action.  All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty          Type             Description\n----------------  ---------------  ----------------------------------------------------------------------------------\nurl               String           The url for the action (defaults to the form's url)\nmethod            String           The form method to use (defaults to the form's method, or POST if not defined)\nparams            String/Object    The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation  Boolean          Applies to submit only.  Pass true to call form.isValid() prior to posting to\n                                   validate the form on the client (defaults to false)\n</pre>",
 209           "isOptional" : false
 210         }
 211       ],
 212       "returns" : [
 213         {
 214           "name" : "",
 215           "type" : "BasicForm",
 216           "desc" : "this"
 217         }
 218       ]
 219     },
 220     {
 221       "name" : "getValues",
 222       "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
 223       "isStatic" : false,
 224       "isConstructor" : false,
 225       "isPrivate" : false,
 226       "memberOf" : "Roo.form.BasicForm",
 227       "example" : "",
 228       "deprecated" : "",
 229       "since" : "",
 230       "see" : "",
 231       "params" : [
 232         {
 233           "name" : "asString",
 234           "type" : "Boolean",
 235           "desc" : "",
 236           "isOptional" : false
 237         }
 238       ],
 239       "returns" : [
 240         {
 241           "name" : "",
 242           "type" : "Object",
 243           "desc" : ""
 244         }
 245       ]
 246     },
 247     {
 248       "name" : "resetHasChanged",
 249       "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
 250       "isStatic" : false,
 251       "isConstructor" : false,
 252       "isPrivate" : false,
 253       "memberOf" : "Roo.form.BasicForm",
 254       "example" : "",
 255       "deprecated" : "",
 256       "since" : "",
 257       "see" : "",
 258       "params" : [
 259       ],
 260       "returns" : [
 261         {
 262           "name" : "",
 263           "type" : "",
 264           "desc" : "Boolean"
 265         }
 266       ]
 267     },
 268     {
 269       "name" : "clearInvalid",
 270       "desc" : "Clears all invalid messages in this form.",
 271       "isStatic" : false,
 272       "isConstructor" : false,
 273       "isPrivate" : false,
 274       "memberOf" : "Roo.form.BasicForm",
 275       "example" : "",
 276       "deprecated" : "",
 277       "since" : "",
 278       "see" : "",
 279       "params" : [
 280       ],
 281       "returns" : [
 282         {
 283           "name" : "",
 284           "type" : "BasicForm",
 285           "desc" : "this"
 286         }
 287       ]
 288     },
 289     {
 290       "name" : "isDirty",
 291       "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
 292       "isStatic" : false,
 293       "isConstructor" : false,
 294       "isPrivate" : false,
 295       "memberOf" : "Roo.form.BasicForm",
 296       "example" : "",
 297       "deprecated" : "",
 298       "since" : "",
 299       "see" : "",
 300       "params" : [
 301       ],
 302       "returns" : [
 303         {
 304           "name" : "",
 305           "type" : "",
 306           "desc" : "Boolean"
 307         }
 308       ]
 309     },
 310     {
 311       "name" : "updateRecord",
 312       "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
 313       "isStatic" : false,
 314       "isConstructor" : false,
 315       "isPrivate" : false,
 316       "memberOf" : "Roo.form.BasicForm",
 317       "example" : "",
 318       "deprecated" : "",
 319       "since" : "",
 320       "see" : "",
 321       "params" : [
 322         {
 323           "name" : "record",
 324           "type" : "Record",
 325           "desc" : "The record to edit",
 326           "isOptional" : false
 327         }
 328       ],
 329       "returns" : [
 330         {
 331           "name" : "",
 332           "type" : "BasicForm",
 333           "desc" : "this"
 334         }
 335       ]
 336     },
 337     {
 338       "name" : "hasChanged",
 339       "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
 340       "isStatic" : false,
 341       "isConstructor" : false,
 342       "isPrivate" : false,
 343       "memberOf" : "Roo.form.BasicForm",
 344       "example" : "",
 345       "deprecated" : "",
 346       "since" : "",
 347       "see" : "",
 348       "params" : [
 349       ],
 350       "returns" : [
 351         {
 352           "name" : "",
 353           "type" : "",
 354           "desc" : "Boolean"
 355         }
 356       ]
 357     },
 358     {
 359       "name" : "applyToFields",
 360       "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
 361       "isStatic" : false,
 362       "isConstructor" : false,
 363       "isPrivate" : false,
 364       "memberOf" : "Roo.form.BasicForm",
 365       "example" : "",
 366       "deprecated" : "",
 367       "since" : "",
 368       "see" : "",
 369       "params" : [
 370         {
 371           "name" : "values",
 372           "type" : "Object",
 373           "desc" : "",
 374           "isOptional" : false
 375         }
 376       ],
 377       "returns" : [
 378         {
 379           "name" : "",
 380           "type" : "BasicForm",
 381           "desc" : "this"
 382         }
 383       ]
 384     },
 385     {
 386       "name" : "getFieldValues",
 387       "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
 388       "isStatic" : false,
 389       "isConstructor" : false,
 390       "isPrivate" : false,
 391       "memberOf" : "Roo.form.BasicForm",
 392       "example" : "",
 393       "deprecated" : "",
 394       "since" : "",
 395       "see" : "",
 396       "params" : [
 397       ],
 398       "returns" : [
 399         {
 400           "name" : "",
 401           "type" : "Object",
 402           "desc" : ""
 403         }
 404       ]
 405     },
 406     {
 407       "name" : "submit",
 408       "desc" : "Shortcut to do a submit action.",
 409       "isStatic" : false,
 410       "isConstructor" : false,
 411       "isPrivate" : false,
 412       "memberOf" : "Roo.form.BasicForm",
 413       "example" : "",
 414       "deprecated" : "",
 415       "since" : "",
 416       "see" : "",
 417       "params" : [
 418         {
 419           "name" : "options",
 420           "type" : "Object",
 421           "desc" : "The options to pass to the action (see {@link #doAction} for details)",
 422           "isOptional" : false
 423         }
 424       ],
 425       "returns" : [
 426         {
 427           "name" : "",
 428           "type" : "BasicForm",
 429           "desc" : "this"
 430         }
 431       ]
 432     },
 433     {
 434       "name" : "markInvalid",
 435       "desc" : "Mark fields in this form invalid in bulk.",
 436       "isStatic" : false,
 437       "isConstructor" : false,
 438       "isPrivate" : false,
 439       "memberOf" : "Roo.form.BasicForm",
 440       "example" : "",
 441       "deprecated" : "",
 442       "since" : "",
 443       "see" : "",
 444       "params" : [
 445         {
 446           "name" : "errors",
 447           "type" : "Array/Object",
 448           "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
 449           "isOptional" : false
 450         }
 451       ],
 452       "returns" : [
 453         {
 454           "name" : "",
 455           "type" : "BasicForm",
 456           "desc" : "this"
 457         }
 458       ]
 459     },
 460     {
 461       "name" : "setValues",
 462       "desc" : "Set values for fields in this form in bulk.",
 463       "isStatic" : false,
 464       "isConstructor" : false,
 465       "isPrivate" : false,
 466       "memberOf" : "Roo.form.BasicForm",
 467       "example" : "",
 468       "deprecated" : "",
 469       "since" : "",
 470       "see" : "",
 471       "params" : [
 472         {
 473           "name" : "values",
 474           "type" : "Array/Object",
 475           "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
 476           "isOptional" : false
 477         }
 478       ],
 479       "returns" : [
 480         {
 481           "name" : "",
 482           "type" : "BasicForm",
 483           "desc" : "this"
 484         }
 485       ]
 486     },
 487     {
 488       "name" : "isValid",
 489       "desc" : "Returns true if client-side validation on the form is successful.",
 490       "isStatic" : false,
 491       "isConstructor" : false,
 492       "isPrivate" : false,
 493       "memberOf" : "Roo.form.BasicForm",
 494       "example" : "",
 495       "deprecated" : "",
 496       "since" : "",
 497       "see" : "",
 498       "params" : [
 499       ],
 500       "returns" : [
 501         {
 502           "name" : "",
 503           "type" : "",
 504           "desc" : "Boolean"
 505         }
 506       ]
 507     },
 508     {
 509       "name" : "render",
 510       "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.",
 511       "isStatic" : false,
 512       "isConstructor" : false,
 513       "isPrivate" : false,
 514       "memberOf" : "Roo.form.BasicForm",
 515       "example" : "",
 516       "deprecated" : "",
 517       "since" : "",
 518       "see" : "",
 519       "params" : [
 520       ],
 521       "returns" : [
 522         {
 523           "name" : "",
 524           "type" : "BasicForm",
 525           "desc" : "this"
 526         }
 527       ]
 528     },
 529     {
 530       "name" : "add",
 531       "desc" : "Add Roo.form components to this form.",
 532       "isStatic" : false,
 533       "isConstructor" : false,
 534       "isPrivate" : false,
 535       "memberOf" : "Roo.form.BasicForm",
 536       "example" : "",
 537       "deprecated" : "",
 538       "since" : "",
 539       "see" : "",
 540       "params" : [
 541         {
 542           "name" : "field1",
 543           "type" : "Field",
 544           "desc" : "",
 545           "isOptional" : false
 546         },
 547         {
 548           "name" : "field2",
 549           "type" : "Field",
 550           "desc" : "(optional)",
 551           "isOptional" : false
 552         },
 553         {
 554           "name" : "etc",
 555           "type" : "Field",
 556           "desc" : "(optional)",
 557           "isOptional" : false
 558         }
 559       ],
 560       "returns" : [
 561         {
 562           "name" : "",
 563           "type" : "BasicForm",
 564           "desc" : "this"
 565         }
 566       ]
 567     },
 568     {
 569       "name" : "applyIfToFields",
 570       "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
 571       "isStatic" : false,
 572       "isConstructor" : false,
 573       "isPrivate" : false,
 574       "memberOf" : "Roo.form.BasicForm",
 575       "example" : "",
 576       "deprecated" : "",
 577       "since" : "",
 578       "see" : "",
 579       "params" : [
 580         {
 581           "name" : "values",
 582           "type" : "Object",
 583           "desc" : "",
 584           "isOptional" : false
 585         }
 586       ],
 587       "returns" : [
 588         {
 589           "name" : "",
 590           "type" : "BasicForm",
 591           "desc" : "this"
 592         }
 593       ]
 594     },
 595     {
 596       "name" : "findField",
 597       "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
 598       "isStatic" : false,
 599       "isConstructor" : false,
 600       "isPrivate" : false,
 601       "memberOf" : "Roo.form.BasicForm",
 602       "example" : "",
 603       "deprecated" : "",
 604       "since" : "",
 605       "see" : "",
 606       "params" : [
 607         {
 608           "name" : "id",
 609           "type" : "String",
 610           "desc" : "The value to search for",
 611           "isOptional" : false
 612         }
 613       ],
 614       "returns" : [
 615         {
 616           "name" : "",
 617           "type" : "",
 618           "desc" : "Field"
 619         }
 620       ]
 621     },
 622     {
 623       "name" : "reset",
 624       "desc" : "Resets this form.",
 625       "isStatic" : false,
 626       "isConstructor" : false,
 627       "isPrivate" : false,
 628       "memberOf" : "Roo.form.BasicForm",
 629       "example" : "",
 630       "deprecated" : "",
 631       "since" : "",
 632       "see" : "",
 633       "params" : [
 634       ],
 635       "returns" : [
 636         {
 637           "name" : "",
 638           "type" : "BasicForm",
 639           "desc" : "this"
 640         }
 641       ]
 642     },
 643     {
 644       "name" : "addForm",
 645       "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
 646       "isStatic" : false,
 647       "isConstructor" : false,
 648       "isPrivate" : false,
 649       "memberOf" : "Roo.form.BasicForm",
 650       "example" : "",
 651       "deprecated" : "",
 652       "since" : "",
 653       "see" : "",
 654       "params" : [
 655         {
 656           "name" : "form",
 657           "type" : "Roo.form.Form",
 658           "desc" : "to add.",
 659           "isOptional" : false
 660         }
 661       ],
 662       "returns" : [
 663       ]
 664     },
 665     {
 666       "name" : "purgeListeners",
 667       "desc" : "Removes all listeners for this object",
 668       "isStatic" : false,
 669       "isConstructor" : false,
 670       "isPrivate" : false,
 671       "memberOf" : "Roo.util.Observable",
 672       "example" : "",
 673       "deprecated" : "",
 674       "since" : "",
 675       "see" : "",
 676       "params" : [
 677       ],
 678       "returns" : [
 679       ]
 680     },
 681     {
 682       "name" : "on",
 683       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 684       "isStatic" : false,
 685       "isConstructor" : false,
 686       "isPrivate" : false,
 687       "memberOf" : "Roo.util.Observable",
 688       "example" : "",
 689       "deprecated" : "",
 690       "since" : "",
 691       "see" : "",
 692       "params" : [
 693         {
 694           "name" : "eventName",
 695           "type" : "String",
 696           "desc" : "The type of event to listen for",
 697           "isOptional" : false
 698         },
 699         {
 700           "name" : "handler",
 701           "type" : "Function",
 702           "desc" : "The method the event invokes",
 703           "isOptional" : false
 704         },
 705         {
 706           "name" : "scope",
 707           "type" : "Object",
 708           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 709           "isOptional" : false
 710         },
 711         {
 712           "name" : "options",
 713           "type" : "Object",
 714           "desc" : "(optional)",
 715           "isOptional" : false
 716         }
 717       ],
 718       "returns" : [
 719       ]
 720     },
 721     {
 722       "name" : "un",
 723       "desc" : "Removes a listener (shorthand for removeListener)",
 724       "isStatic" : false,
 725       "isConstructor" : false,
 726       "isPrivate" : false,
 727       "memberOf" : "Roo.util.Observable",
 728       "example" : "",
 729       "deprecated" : "",
 730       "since" : "",
 731       "see" : "",
 732       "params" : [
 733         {
 734           "name" : "eventName",
 735           "type" : "String",
 736           "desc" : "The type of event to listen for",
 737           "isOptional" : false
 738         },
 739         {
 740           "name" : "handler",
 741           "type" : "Function",
 742           "desc" : "The handler to remove",
 743           "isOptional" : false
 744         },
 745         {
 746           "name" : "scope",
 747           "type" : "Object",
 748           "desc" : "(optional) The scope (this object) for the handler",
 749           "isOptional" : false
 750         }
 751       ],
 752       "returns" : [
 753       ]
 754     },
 755     {
 756       "name" : "addEvents",
 757       "desc" : "Used to define events on this Observable",
 758       "isStatic" : false,
 759       "isConstructor" : false,
 760       "isPrivate" : false,
 761       "memberOf" : "Roo.util.Observable",
 762       "example" : "",
 763       "deprecated" : "",
 764       "since" : "",
 765       "see" : "",
 766       "params" : [
 767         {
 768           "name" : "object",
 769           "type" : "Object",
 770           "desc" : "The object with the events defined",
 771           "isOptional" : false
 772         }
 773       ],
 774       "returns" : [
 775       ]
 776     },
 777     {
 778       "name" : "releaseCapture",
 779       "desc" : "Removes <b>all</b> added captures from the Observable.",
 780       "isStatic" : true,
 781       "isConstructor" : false,
 782       "isPrivate" : false,
 783       "memberOf" : "Roo.util.Observable",
 784       "example" : "",
 785       "deprecated" : "",
 786       "since" : "",
 787       "see" : "",
 788       "params" : [
 789         {
 790           "name" : "o",
 791           "type" : "Observable",
 792           "desc" : "The Observable to release",
 793           "isOptional" : false
 794         }
 795       ],
 796       "returns" : [
 797       ]
 798     },
 799     {
 800       "name" : "removeListener",
 801       "desc" : "Removes a listener",
 802       "isStatic" : false,
 803       "isConstructor" : false,
 804       "isPrivate" : false,
 805       "memberOf" : "Roo.util.Observable",
 806       "example" : "",
 807       "deprecated" : "",
 808       "since" : "",
 809       "see" : "",
 810       "params" : [
 811         {
 812           "name" : "eventName",
 813           "type" : "String",
 814           "desc" : "The type of event to listen for",
 815           "isOptional" : false
 816         },
 817         {
 818           "name" : "handler",
 819           "type" : "Function",
 820           "desc" : "The handler to remove",
 821           "isOptional" : false
 822         },
 823         {
 824           "name" : "scope",
 825           "type" : "Object",
 826           "desc" : "(optional) The scope (this object) for the handler",
 827           "isOptional" : false
 828         }
 829       ],
 830       "returns" : [
 831       ]
 832     },
 833     {
 834       "name" : "fireEvent",
 835       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 836       "isStatic" : false,
 837       "isConstructor" : false,
 838       "isPrivate" : false,
 839       "memberOf" : "Roo.util.Observable",
 840       "example" : "",
 841       "deprecated" : "",
 842       "since" : "",
 843       "see" : "",
 844       "params" : [
 845         {
 846           "name" : "eventName",
 847           "type" : "String",
 848           "desc" : "",
 849           "isOptional" : false
 850         },
 851         {
 852           "name" : "args",
 853           "type" : "Object...",
 854           "desc" : "Variable number of parameters are passed to handlers",
 855           "isOptional" : false
 856         }
 857       ],
 858       "returns" : [
 859         {
 860           "name" : "",
 861           "type" : "Boolean",
 862           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 863         }
 864       ]
 865     },
 866     {
 867       "name" : "hasListener",
 868       "desc" : "Checks to see if this object has any listeners for a specified event",
 869       "isStatic" : false,
 870       "isConstructor" : false,
 871       "isPrivate" : false,
 872       "memberOf" : "Roo.util.Observable",
 873       "example" : "",
 874       "deprecated" : "",
 875       "since" : "",
 876       "see" : "",
 877       "params" : [
 878         {
 879           "name" : "eventName",
 880           "type" : "String",
 881           "desc" : "The name of the event to check for",
 882           "isOptional" : false
 883         }
 884       ],
 885       "returns" : [
 886         {
 887           "name" : "",
 888           "type" : "Boolean",
 889           "desc" : "True if the event is being listened for, else false"
 890         }
 891       ]
 892     },
 893     {
 894       "name" : "capture",
 895       "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.",
 896       "isStatic" : true,
 897       "isConstructor" : false,
 898       "isPrivate" : false,
 899       "memberOf" : "Roo.util.Observable",
 900       "example" : "",
 901       "deprecated" : "",
 902       "since" : "",
 903       "see" : "",
 904       "params" : [
 905         {
 906           "name" : "o",
 907           "type" : "Observable",
 908           "desc" : "The Observable to capture",
 909           "isOptional" : false
 910         },
 911         {
 912           "name" : "fn",
 913           "type" : "Function",
 914           "desc" : "The function to call",
 915           "isOptional" : false
 916         },
 917         {
 918           "name" : "scope",
 919           "type" : "Object",
 920           "desc" : "(optional) The scope (this object) for the fn",
 921           "isOptional" : false
 922         }
 923       ],
 924       "returns" : [
 925       ]
 926     },
 927     {
 928       "name" : "addListener",
 929       "desc" : "Appends an event handler to this component",
 930       "isStatic" : false,
 931       "isConstructor" : false,
 932       "isPrivate" : false,
 933       "memberOf" : "Roo.util.Observable",
 934       "example" : "",
 935       "deprecated" : "",
 936       "since" : "",
 937       "see" : "",
 938       "params" : [
 939         {
 940           "name" : "eventName",
 941           "type" : "String",
 942           "desc" : "The type of event to listen for",
 943           "isOptional" : false
 944         },
 945         {
 946           "name" : "handler",
 947           "type" : "Function",
 948           "desc" : "The method the event invokes",
 949           "isOptional" : false
 950         },
 951         {
 952           "name" : "scope",
 953           "type" : "Object",
 954           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 955           "isOptional" : false
 956         },
 957         {
 958           "name" : "options",
 959           "type" : "Object",
 960           "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>",
 961           "isOptional" : false
 962         }
 963       ],
 964       "returns" : [
 965       ]
 966     }
 967   ],
 968   "events" : [
 969     {
 970       "name" : "beforeaction",
 971       "desc" : "Fires before any action is performed. Return false to cancel the action.",
 972       "memberOf" : "Roo.form.BasicForm",
 973       "example" : "",
 974       "deprecated" : "",
 975       "since" : "",
 976       "see" : "",
 977       "params" : [
 978         {
 979           "name" : "this",
 980           "type" : "Form",
 981           "desc" : "",
 982           "isOptional" : false
 983         },
 984         {
 985           "name" : "action",
 986           "type" : "Action",
 987           "desc" : "The action to be performed",
 988           "isOptional" : false
 989         }
 990       ],
 991       "returns" : [
 992       ]
 993     },
 994     {
 995       "name" : "actioncomplete",
 996       "desc" : "Fires when an action is completed.",
 997       "memberOf" : "Roo.form.BasicForm",
 998       "example" : "",
 999       "deprecated" : "",
1000       "since" : "",
1001       "see" : "",
1002       "params" : [
1003         {
1004           "name" : "this",
1005           "type" : "Form",
1006           "desc" : "",
1007           "isOptional" : false
1008         },
1009         {
1010           "name" : "action",
1011           "type" : "Action",
1012           "desc" : "The action that completed",
1013           "isOptional" : false
1014         }
1015       ],
1016       "returns" : [
1017       ]
1018     },
1019     {
1020       "name" : "actionfailed",
1021       "desc" : "Fires when an action fails.",
1022       "memberOf" : "Roo.form.BasicForm",
1023       "example" : "",
1024       "deprecated" : "",
1025       "since" : "",
1026       "see" : "",
1027       "params" : [
1028         {
1029           "name" : "this",
1030           "type" : "Form",
1031           "desc" : "",
1032           "isOptional" : false
1033         },
1034         {
1035           "name" : "action",
1036           "type" : "Action",
1037           "desc" : "The action that failed",
1038           "isOptional" : false
1039         }
1040       ],
1041       "returns" : [
1042       ]
1043     }
1044   ]
1045 }