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

   1 {
   2   "name" : "Roo.form.Form",
   3   "augments" : [
   4     "Roo.form.BasicForm",
   5     "Roo.util.Observable"
   6   ],
   7   "desc" : "Adds the ability to dynamically render forms with JavaScript to {@link Roo.form.BasicForm}.",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "memberOf" : "Form",
  12   "example" : "",
  13   "deprecated" : "",
  14   "since" : "",
  15   "see" : "",
  16   "params" : [
  17     {
  18       "name" : "config",
  19       "type" : "Object",
  20       "desc" : "Configuration options",
  21       "isOptional" : false
  22     }
  23   ],
  24   "returns" : [
  25   ],
  26   "config" : [
  27     {
  28       "name" : "labelAlign",
  29       "type" : "String",
  30       "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not set.",
  31       "memberOf" : "Roo.form.Form",
  32       "optvals" : [
  33       ]
  34     },
  35     {
  36       "name" : "listeners",
  37       "type" : "Object",
  38       "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>",
  39       "memberOf" : "Roo.util.Observable",
  40       "optvals" : [
  41       ]
  42     },
  43     {
  44       "name" : "formData",
  45       "type" : "boolean|FormData",
  46       "desc" : "- true to use new 'FormData' post, or set to a new FormData({dom form}) Object, if\nsending a formdata with extra parameters - eg uploaded elements.",
  47       "memberOf" : "Roo.form.Form",
  48       "optvals" : [
  49       ]
  50     },
  51     {
  52       "name" : "monitorValid",
  53       "type" : "Boolean",
  54       "desc" : "If true the form monitors its valid state <b>client-side</b> and\nfires a looping event with that state. This is required to bind buttons to the valid\nstate using the config value formBind:true on the button.",
  55       "memberOf" : "Roo.form.Form",
  56       "optvals" : [
  57       ]
  58     },
  59     {
  60       "name" : "fileUpload",
  61       "type" : "Boolean",
  62       "desc" : "Set to true if this form is a file upload.",
  63       "memberOf" : "Roo.form.BasicForm",
  64       "optvals" : [
  65       ]
  66     },
  67     {
  68       "name" : "progressUrl",
  69       "type" : "String",
  70       "desc" : "- Url to return progress data",
  71       "memberOf" : "Roo.form.Form",
  72       "optvals" : [
  73       ]
  74     },
  75     {
  76       "name" : "minButtonWidth",
  77       "type" : "Number",
  78       "desc" : "Minimum width of all buttons in pixels (defaults to 75)",
  79       "memberOf" : "Roo.form.Form",
  80       "optvals" : [
  81       ]
  82     },
  83     {
  84       "name" : "buttonAlign",
  85       "type" : "String",
  86       "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
  87       "memberOf" : "Roo.form.Form",
  88       "optvals" : [
  89       ]
  90     },
  91     {
  92       "name" : "method",
  93       "type" : "String",
  94       "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
  95       "memberOf" : "Roo.form.BasicForm",
  96       "optvals" : [
  97       ]
  98     },
  99     {
 100       "name" : "errorMask",
 101       "type" : "Boolean",
 102       "desc" : "e) default false",
 103       "memberOf" : "Roo.form.BasicForm",
 104       "optvals" : [
 105         "true",
 106         "false"
 107       ]
 108     },
 109     {
 110       "name" : "labelWidth",
 111       "type" : "Number",
 112       "desc" : "The width of labels. This property cascades to child containers.",
 113       "memberOf" : "Roo.form.Form",
 114       "optvals" : [
 115       ]
 116     },
 117     {
 118       "name" : "itemCls",
 119       "type" : "String",
 120       "desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
 121       "memberOf" : "Roo.form.Form",
 122       "optvals" : [
 123       ]
 124     },
 125     {
 126       "name" : "timeout",
 127       "type" : "Number",
 128       "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
 129       "memberOf" : "Roo.form.BasicForm",
 130       "optvals" : [
 131       ]
 132     },
 133     {
 134       "name" : "monitorPoll",
 135       "type" : "Number",
 136       "desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
 137       "memberOf" : "Roo.form.Form",
 138       "optvals" : [
 139       ]
 140     },
 141     {
 142       "name" : "baseParams",
 143       "type" : "Object",
 144       "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
 145       "memberOf" : "Roo.form.BasicForm",
 146       "optvals" : [
 147       ]
 148     },
 149     {
 150       "name" : "trackResetOnLoad",
 151       "type" : "Boolean",
 152       "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
 153       "memberOf" : "Roo.form.BasicForm",
 154       "optvals" : [
 155       ]
 156     },
 157     {
 158       "name" : "reader",
 159       "type" : "DataReader",
 160       "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.",
 161       "memberOf" : "Roo.form.BasicForm",
 162       "optvals" : [
 163       ]
 164     },
 165     {
 166       "name" : "errorReader",
 167       "type" : "DataReader",
 168       "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.",
 169       "memberOf" : "Roo.form.BasicForm",
 170       "optvals" : [
 171       ]
 172     },
 173     {
 174       "name" : "url",
 175       "type" : "String",
 176       "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
 177       "memberOf" : "Roo.form.BasicForm",
 178       "optvals" : [
 179       ]
 180     },
 181     {
 182       "name" : "maskOffset",
 183       "type" : "Number",
 184       "desc" : "Default 100",
 185       "memberOf" : "Roo.form.BasicForm",
 186       "optvals" : [
 187       ]
 188     }
 189   ],
 190   "methods" : [
 191     {
 192       "name" : "addxtype",
 193       "desc" : "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are:  TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)",
 194       "isStatic" : false,
 195       "isConstructor" : false,
 196       "isPrivate" : false,
 197       "memberOf" : "Roo.form.Form",
 198       "example" : "",
 199       "deprecated" : "",
 200       "since" : "",
 201       "see" : "",
 202       "params" : [
 203         {
 204           "name" : "config",
 205           "type" : "Object",
 206           "desc" : "",
 207           "isOptional" : false
 208         }
 209       ],
 210       "returns" : [
 211       ]
 212     },
 213     {
 214       "name" : "fieldset",
 215       "desc" : "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called.",
 216       "isStatic" : false,
 217       "isConstructor" : false,
 218       "isPrivate" : false,
 219       "memberOf" : "Roo.form.Form",
 220       "example" : "",
 221       "deprecated" : "",
 222       "since" : "",
 223       "see" : "",
 224       "params" : [
 225         {
 226           "name" : "config",
 227           "type" : "Object",
 228           "desc" : "The config to pass to the fieldset",
 229           "isOptional" : false
 230         },
 231         {
 232           "name" : "field1",
 233           "type" : "Field",
 234           "desc" : "(optional)",
 235           "isOptional" : false
 236         },
 237         {
 238           "name" : "field2",
 239           "type" : "Field",
 240           "desc" : "(optional)",
 241           "isOptional" : false
 242         },
 243         {
 244           "name" : "etc",
 245           "type" : "Field",
 246           "desc" : "(optional)",
 247           "isOptional" : false
 248         }
 249       ],
 250       "returns" : [
 251         {
 252           "name" : "",
 253           "type" : "",
 254           "desc" : "FieldSet The fieldset container object"
 255         }
 256       ]
 257     },
 258     {
 259       "name" : "start",
 260       "desc" : "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.",
 261       "isStatic" : false,
 262       "isConstructor" : false,
 263       "isPrivate" : false,
 264       "memberOf" : "Roo.form.Form",
 265       "example" : "",
 266       "deprecated" : "",
 267       "since" : "",
 268       "see" : "",
 269       "params" : [
 270         {
 271           "name" : "container",
 272           "type" : "Object",
 273           "desc" : "A Roo.form.Layout or subclass of Layout",
 274           "isOptional" : false
 275         }
 276       ],
 277       "returns" : [
 278         {
 279           "name" : "",
 280           "type" : "Form",
 281           "desc" : "this"
 282         }
 283       ]
 284     },
 285     {
 286       "name" : "container",
 287       "desc" : "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called.",
 288       "isStatic" : false,
 289       "isConstructor" : false,
 290       "isPrivate" : false,
 291       "memberOf" : "Roo.form.Form",
 292       "example" : "",
 293       "deprecated" : "",
 294       "since" : "",
 295       "see" : "",
 296       "params" : [
 297         {
 298           "name" : "config",
 299           "type" : "Object",
 300           "desc" : "The config to pass to the Layout",
 301           "isOptional" : false
 302         },
 303         {
 304           "name" : "field1",
 305           "type" : "Field",
 306           "desc" : "(optional)",
 307           "isOptional" : false
 308         },
 309         {
 310           "name" : "field2",
 311           "type" : "Field",
 312           "desc" : "(optional)",
 313           "isOptional" : false
 314         },
 315         {
 316           "name" : "etc",
 317           "type" : "Field",
 318           "desc" : "(optional)",
 319           "isOptional" : false
 320         }
 321       ],
 322       "returns" : [
 323         {
 324           "name" : "",
 325           "type" : "",
 326           "desc" : "Layout The container object"
 327         }
 328       ]
 329     },
 330     {
 331       "name" : "render",
 332       "desc" : "Render this form into the passed container. This should only be called once!",
 333       "isStatic" : false,
 334       "isConstructor" : false,
 335       "isPrivate" : false,
 336       "memberOf" : "Roo.form.Form",
 337       "example" : "",
 338       "deprecated" : "",
 339       "since" : "",
 340       "see" : "",
 341       "params" : [
 342         {
 343           "name" : "container",
 344           "type" : "String/HTMLElement/Element",
 345           "desc" : "The element this component should be rendered into",
 346           "isOptional" : false
 347         }
 348       ],
 349       "returns" : [
 350         {
 351           "name" : "",
 352           "type" : "Form",
 353           "desc" : "this"
 354         }
 355       ]
 356     },
 357     {
 358       "name" : "startMonitoring",
 359       "desc" : "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\"",
 360       "isStatic" : false,
 361       "isConstructor" : false,
 362       "isPrivate" : false,
 363       "memberOf" : "Roo.form.Form",
 364       "example" : "",
 365       "deprecated" : "",
 366       "since" : "",
 367       "see" : "",
 368       "params" : [
 369       ],
 370       "returns" : [
 371       ]
 372     },
 373     {
 374       "name" : "addButton",
 375       "desc" : "Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.",
 376       "isStatic" : false,
 377       "isConstructor" : false,
 378       "isPrivate" : false,
 379       "memberOf" : "Roo.form.Form",
 380       "example" : "",
 381       "deprecated" : "",
 382       "since" : "",
 383       "see" : "",
 384       "params" : [
 385         {
 386           "name" : "config",
 387           "type" : "String/Object",
 388           "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
 389           "isOptional" : false
 390         },
 391         {
 392           "name" : "handler",
 393           "type" : "Function",
 394           "desc" : "The function called when the button is clicked",
 395           "isOptional" : false
 396         },
 397         {
 398           "name" : "scope",
 399           "type" : "Object",
 400           "desc" : "(optional) The scope of the handler function",
 401           "isOptional" : false
 402         }
 403       ],
 404       "returns" : [
 405         {
 406           "name" : "",
 407           "type" : "Roo.Button",
 408           "desc" : ""
 409         }
 410       ]
 411     },
 412     {
 413       "name" : "stopMonitoring",
 414       "desc" : "Stops monitoring of the valid state of this form",
 415       "isStatic" : false,
 416       "isConstructor" : false,
 417       "isPrivate" : false,
 418       "memberOf" : "Roo.form.Form",
 419       "example" : "",
 420       "deprecated" : "",
 421       "since" : "",
 422       "see" : "",
 423       "params" : [
 424       ],
 425       "returns" : [
 426       ]
 427     },
 428     {
 429       "name" : "add",
 430       "desc" : "Add Roo.form components to the current open container (e.g. column, fieldset, etc.).  Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field.",
 431       "isStatic" : false,
 432       "isConstructor" : false,
 433       "isPrivate" : false,
 434       "memberOf" : "Roo.form.Form",
 435       "example" : "",
 436       "deprecated" : "",
 437       "since" : "",
 438       "see" : "",
 439       "params" : [
 440         {
 441           "name" : "field1",
 442           "type" : "Field",
 443           "desc" : "",
 444           "isOptional" : false
 445         },
 446         {
 447           "name" : "field2",
 448           "type" : "Field",
 449           "desc" : "(optional)",
 450           "isOptional" : false
 451         }
 452       ],
 453       "returns" : [
 454         {
 455           "name" : "",
 456           "type" : "Form",
 457           "desc" : "this"
 458         }
 459       ]
 460     },
 461     {
 462       "name" : "findbyId",
 463       "desc" : "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields..",
 464       "isStatic" : false,
 465       "isConstructor" : false,
 466       "isPrivate" : false,
 467       "memberOf" : "Roo.form.Form",
 468       "example" : "",
 469       "deprecated" : "",
 470       "since" : "",
 471       "see" : "",
 472       "params" : [
 473         {
 474           "name" : "id",
 475           "type" : "String",
 476           "desc" : "- id or name to find.",
 477           "isOptional" : false
 478         }
 479       ],
 480       "returns" : [
 481         {
 482           "name" : "",
 483           "type" : "Element",
 484           "desc" : "e - or false if nothing found."
 485         }
 486       ]
 487     },
 488     {
 489       "name" : "column",
 490       "desc" : "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called.",
 491       "isStatic" : false,
 492       "isConstructor" : false,
 493       "isPrivate" : false,
 494       "memberOf" : "Roo.form.Form",
 495       "example" : "",
 496       "deprecated" : "",
 497       "since" : "",
 498       "see" : "",
 499       "params" : [
 500         {
 501           "name" : "config",
 502           "type" : "Object",
 503           "desc" : "The config to pass to the column",
 504           "isOptional" : false
 505         },
 506         {
 507           "name" : "field1",
 508           "type" : "Field",
 509           "desc" : "(optional)",
 510           "isOptional" : false
 511         },
 512         {
 513           "name" : "field2",
 514           "type" : "Field",
 515           "desc" : "(optional)",
 516           "isOptional" : false
 517         },
 518         {
 519           "name" : "etc",
 520           "type" : "Field",
 521           "desc" : "(optional)",
 522           "isOptional" : false
 523         }
 524       ],
 525       "returns" : [
 526         {
 527           "name" : "",
 528           "type" : "",
 529           "desc" : "Column The column container object"
 530         }
 531       ]
 532     },
 533     {
 534       "name" : "end",
 535       "desc" : "Closes the current open container",
 536       "isStatic" : false,
 537       "isConstructor" : false,
 538       "isPrivate" : false,
 539       "memberOf" : "Roo.form.Form",
 540       "example" : "",
 541       "deprecated" : "",
 542       "since" : "",
 543       "see" : "",
 544       "params" : [
 545       ],
 546       "returns" : [
 547         {
 548           "name" : "",
 549           "type" : "Form",
 550           "desc" : "this"
 551         }
 552       ]
 553     },
 554     {
 555       "name" : "remove",
 556       "desc" : "Removes a field from the items collection (does NOT remove its markup).",
 557       "isStatic" : false,
 558       "isConstructor" : false,
 559       "isPrivate" : false,
 560       "memberOf" : "Roo.form.BasicForm",
 561       "example" : "",
 562       "deprecated" : "",
 563       "since" : "",
 564       "see" : "",
 565       "params" : [
 566         {
 567           "name" : "field",
 568           "type" : "Field",
 569           "desc" : "",
 570           "isOptional" : false
 571         }
 572       ],
 573       "returns" : [
 574         {
 575           "name" : "",
 576           "type" : "BasicForm",
 577           "desc" : "this"
 578         }
 579       ]
 580     },
 581     {
 582       "name" : "loadRecord",
 583       "desc" : "Loads an Roo.data.Record into this form.",
 584       "isStatic" : false,
 585       "isConstructor" : false,
 586       "isPrivate" : false,
 587       "memberOf" : "Roo.form.BasicForm",
 588       "example" : "",
 589       "deprecated" : "",
 590       "since" : "",
 591       "see" : "",
 592       "params" : [
 593         {
 594           "name" : "record",
 595           "type" : "Record",
 596           "desc" : "The record to load",
 597           "isOptional" : false
 598         }
 599       ],
 600       "returns" : [
 601         {
 602           "name" : "",
 603           "type" : "BasicForm",
 604           "desc" : "this"
 605         }
 606       ]
 607     },
 608     {
 609       "name" : "load",
 610       "desc" : "Shortcut to do a load action.",
 611       "isStatic" : false,
 612       "isConstructor" : false,
 613       "isPrivate" : false,
 614       "memberOf" : "Roo.form.BasicForm",
 615       "example" : "",
 616       "deprecated" : "",
 617       "since" : "",
 618       "see" : "",
 619       "params" : [
 620         {
 621           "name" : "options",
 622           "type" : "Object",
 623           "desc" : "The options to pass to the action (see {@link #doAction} for details)",
 624           "isOptional" : false
 625         }
 626       ],
 627       "returns" : [
 628         {
 629           "name" : "",
 630           "type" : "BasicForm",
 631           "desc" : "this"
 632         }
 633       ]
 634     },
 635     {
 636       "name" : "doAction",
 637       "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
 638       "isStatic" : false,
 639       "isConstructor" : false,
 640       "isPrivate" : false,
 641       "memberOf" : "Roo.form.BasicForm",
 642       "example" : "",
 643       "deprecated" : "",
 644       "since" : "",
 645       "see" : "",
 646       "params" : [
 647         {
 648           "name" : "actionName",
 649           "type" : "String",
 650           "desc" : "The name of the action type",
 651           "isOptional" : false
 652         },
 653         {
 654           "name" : "options",
 655           "type" : "Object",
 656           "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>",
 657           "isOptional" : false
 658         }
 659       ],
 660       "returns" : [
 661         {
 662           "name" : "",
 663           "type" : "BasicForm",
 664           "desc" : "this"
 665         }
 666       ]
 667     },
 668     {
 669       "name" : "getValues",
 670       "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.",
 671       "isStatic" : false,
 672       "isConstructor" : false,
 673       "isPrivate" : false,
 674       "memberOf" : "Roo.form.BasicForm",
 675       "example" : "",
 676       "deprecated" : "",
 677       "since" : "",
 678       "see" : "",
 679       "params" : [
 680         {
 681           "name" : "asString",
 682           "type" : "Boolean",
 683           "desc" : "",
 684           "isOptional" : false
 685         }
 686       ],
 687       "returns" : [
 688         {
 689           "name" : "",
 690           "type" : "Object",
 691           "desc" : ""
 692         }
 693       ]
 694     },
 695     {
 696       "name" : "resetHasChanged",
 697       "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",
 698       "isStatic" : false,
 699       "isConstructor" : false,
 700       "isPrivate" : false,
 701       "memberOf" : "Roo.form.BasicForm",
 702       "example" : "",
 703       "deprecated" : "",
 704       "since" : "",
 705       "see" : "",
 706       "params" : [
 707       ],
 708       "returns" : [
 709         {
 710           "name" : "",
 711           "type" : "",
 712           "desc" : "Boolean"
 713         }
 714       ]
 715     },
 716     {
 717       "name" : "clearInvalid",
 718       "desc" : "Clears all invalid messages in this form.",
 719       "isStatic" : false,
 720       "isConstructor" : false,
 721       "isPrivate" : false,
 722       "memberOf" : "Roo.form.BasicForm",
 723       "example" : "",
 724       "deprecated" : "",
 725       "since" : "",
 726       "see" : "",
 727       "params" : [
 728       ],
 729       "returns" : [
 730         {
 731           "name" : "",
 732           "type" : "BasicForm",
 733           "desc" : "this"
 734         }
 735       ]
 736     },
 737     {
 738       "name" : "isDirty",
 739       "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
 740       "isStatic" : false,
 741       "isConstructor" : false,
 742       "isPrivate" : false,
 743       "memberOf" : "Roo.form.BasicForm",
 744       "example" : "",
 745       "deprecated" : "",
 746       "since" : "",
 747       "see" : "",
 748       "params" : [
 749       ],
 750       "returns" : [
 751         {
 752           "name" : "",
 753           "type" : "",
 754           "desc" : "Boolean"
 755         }
 756       ]
 757     },
 758     {
 759       "name" : "updateRecord",
 760       "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
 761       "isStatic" : false,
 762       "isConstructor" : false,
 763       "isPrivate" : false,
 764       "memberOf" : "Roo.form.BasicForm",
 765       "example" : "",
 766       "deprecated" : "",
 767       "since" : "",
 768       "see" : "",
 769       "params" : [
 770         {
 771           "name" : "record",
 772           "type" : "Record",
 773           "desc" : "The record to edit",
 774           "isOptional" : false
 775         }
 776       ],
 777       "returns" : [
 778         {
 779           "name" : "",
 780           "type" : "BasicForm",
 781           "desc" : "this"
 782         }
 783       ]
 784     },
 785     {
 786       "name" : "hasChanged",
 787       "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
 788       "isStatic" : false,
 789       "isConstructor" : false,
 790       "isPrivate" : false,
 791       "memberOf" : "Roo.form.BasicForm",
 792       "example" : "",
 793       "deprecated" : "",
 794       "since" : "",
 795       "see" : "",
 796       "params" : [
 797       ],
 798       "returns" : [
 799         {
 800           "name" : "",
 801           "type" : "",
 802           "desc" : "Boolean"
 803         }
 804       ]
 805     },
 806     {
 807       "name" : "applyToFields",
 808       "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
 809       "isStatic" : false,
 810       "isConstructor" : false,
 811       "isPrivate" : false,
 812       "memberOf" : "Roo.form.BasicForm",
 813       "example" : "",
 814       "deprecated" : "",
 815       "since" : "",
 816       "see" : "",
 817       "params" : [
 818         {
 819           "name" : "values",
 820           "type" : "Object",
 821           "desc" : "",
 822           "isOptional" : false
 823         }
 824       ],
 825       "returns" : [
 826         {
 827           "name" : "",
 828           "type" : "BasicForm",
 829           "desc" : "this"
 830         }
 831       ]
 832     },
 833     {
 834       "name" : "getFieldValues",
 835       "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.",
 836       "isStatic" : false,
 837       "isConstructor" : false,
 838       "isPrivate" : false,
 839       "memberOf" : "Roo.form.BasicForm",
 840       "example" : "",
 841       "deprecated" : "",
 842       "since" : "",
 843       "see" : "",
 844       "params" : [
 845       ],
 846       "returns" : [
 847         {
 848           "name" : "",
 849           "type" : "Object",
 850           "desc" : ""
 851         }
 852       ]
 853     },
 854     {
 855       "name" : "submit",
 856       "desc" : "Shortcut to do a submit action.",
 857       "isStatic" : false,
 858       "isConstructor" : false,
 859       "isPrivate" : false,
 860       "memberOf" : "Roo.form.BasicForm",
 861       "example" : "",
 862       "deprecated" : "",
 863       "since" : "",
 864       "see" : "",
 865       "params" : [
 866         {
 867           "name" : "options",
 868           "type" : "Object",
 869           "desc" : "The options to pass to the action (see {@link #doAction} for details)",
 870           "isOptional" : false
 871         }
 872       ],
 873       "returns" : [
 874         {
 875           "name" : "",
 876           "type" : "BasicForm",
 877           "desc" : "this"
 878         }
 879       ]
 880     },
 881     {
 882       "name" : "markInvalid",
 883       "desc" : "Mark fields in this form invalid in bulk.",
 884       "isStatic" : false,
 885       "isConstructor" : false,
 886       "isPrivate" : false,
 887       "memberOf" : "Roo.form.BasicForm",
 888       "example" : "",
 889       "deprecated" : "",
 890       "since" : "",
 891       "see" : "",
 892       "params" : [
 893         {
 894           "name" : "errors",
 895           "type" : "Array/Object",
 896           "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
 897           "isOptional" : false
 898         }
 899       ],
 900       "returns" : [
 901         {
 902           "name" : "",
 903           "type" : "BasicForm",
 904           "desc" : "this"
 905         }
 906       ]
 907     },
 908     {
 909       "name" : "setValues",
 910       "desc" : "Set values for fields in this form in bulk.",
 911       "isStatic" : false,
 912       "isConstructor" : false,
 913       "isPrivate" : false,
 914       "memberOf" : "Roo.form.BasicForm",
 915       "example" : "",
 916       "deprecated" : "",
 917       "since" : "",
 918       "see" : "",
 919       "params" : [
 920         {
 921           "name" : "values",
 922           "type" : "Array/Object",
 923           "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
 924           "isOptional" : false
 925         }
 926       ],
 927       "returns" : [
 928         {
 929           "name" : "",
 930           "type" : "BasicForm",
 931           "desc" : "this"
 932         }
 933       ]
 934     },
 935     {
 936       "name" : "isValid",
 937       "desc" : "Returns true if client-side validation on the form is successful.",
 938       "isStatic" : false,
 939       "isConstructor" : false,
 940       "isPrivate" : false,
 941       "memberOf" : "Roo.form.BasicForm",
 942       "example" : "",
 943       "deprecated" : "",
 944       "since" : "",
 945       "see" : "",
 946       "params" : [
 947       ],
 948       "returns" : [
 949         {
 950           "name" : "",
 951           "type" : "",
 952           "desc" : "Boolean"
 953         }
 954       ]
 955     },
 956     {
 957       "name" : "applyIfToFields",
 958       "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
 959       "isStatic" : false,
 960       "isConstructor" : false,
 961       "isPrivate" : false,
 962       "memberOf" : "Roo.form.BasicForm",
 963       "example" : "",
 964       "deprecated" : "",
 965       "since" : "",
 966       "see" : "",
 967       "params" : [
 968         {
 969           "name" : "values",
 970           "type" : "Object",
 971           "desc" : "",
 972           "isOptional" : false
 973         }
 974       ],
 975       "returns" : [
 976         {
 977           "name" : "",
 978           "type" : "BasicForm",
 979           "desc" : "this"
 980         }
 981       ]
 982     },
 983     {
 984       "name" : "findField",
 985       "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
 986       "isStatic" : false,
 987       "isConstructor" : false,
 988       "isPrivate" : false,
 989       "memberOf" : "Roo.form.BasicForm",
 990       "example" : "",
 991       "deprecated" : "",
 992       "since" : "",
 993       "see" : "",
 994       "params" : [
 995         {
 996           "name" : "id",
 997           "type" : "String",
 998           "desc" : "The value to search for",
 999           "isOptional" : false
1000         }
1001       ],
1002       "returns" : [
1003         {
1004           "name" : "",
1005           "type" : "",
1006           "desc" : "Field"
1007         }
1008       ]
1009     },
1010     {
1011       "name" : "reset",
1012       "desc" : "Resets this form.",
1013       "isStatic" : false,
1014       "isConstructor" : false,
1015       "isPrivate" : false,
1016       "memberOf" : "Roo.form.BasicForm",
1017       "example" : "",
1018       "deprecated" : "",
1019       "since" : "",
1020       "see" : "",
1021       "params" : [
1022       ],
1023       "returns" : [
1024         {
1025           "name" : "",
1026           "type" : "BasicForm",
1027           "desc" : "this"
1028         }
1029       ]
1030     },
1031     {
1032       "name" : "addForm",
1033       "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.",
1034       "isStatic" : false,
1035       "isConstructor" : false,
1036       "isPrivate" : false,
1037       "memberOf" : "Roo.form.BasicForm",
1038       "example" : "",
1039       "deprecated" : "",
1040       "since" : "",
1041       "see" : "",
1042       "params" : [
1043         {
1044           "name" : "form",
1045           "type" : "Roo.form.Form",
1046           "desc" : "to add.",
1047           "isOptional" : false
1048         }
1049       ],
1050       "returns" : [
1051       ]
1052     },
1053     {
1054       "name" : "purgeListeners",
1055       "desc" : "Removes all listeners for this object",
1056       "isStatic" : false,
1057       "isConstructor" : false,
1058       "isPrivate" : false,
1059       "memberOf" : "Roo.util.Observable",
1060       "example" : "",
1061       "deprecated" : "",
1062       "since" : "",
1063       "see" : "",
1064       "params" : [
1065       ],
1066       "returns" : [
1067       ]
1068     },
1069     {
1070       "name" : "on",
1071       "desc" : "Appends an event handler to this element (shorthand for addListener)",
1072       "isStatic" : false,
1073       "isConstructor" : false,
1074       "isPrivate" : false,
1075       "memberOf" : "Roo.util.Observable",
1076       "example" : "",
1077       "deprecated" : "",
1078       "since" : "",
1079       "see" : "",
1080       "params" : [
1081         {
1082           "name" : "eventName",
1083           "type" : "String",
1084           "desc" : "The type of event to listen for",
1085           "isOptional" : false
1086         },
1087         {
1088           "name" : "handler",
1089           "type" : "Function",
1090           "desc" : "The method the event invokes",
1091           "isOptional" : false
1092         },
1093         {
1094           "name" : "scope",
1095           "type" : "Object",
1096           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1097           "isOptional" : false
1098         },
1099         {
1100           "name" : "options",
1101           "type" : "Object",
1102           "desc" : "(optional)",
1103           "isOptional" : false
1104         }
1105       ],
1106       "returns" : [
1107       ]
1108     },
1109     {
1110       "name" : "un",
1111       "desc" : "Removes a listener (shorthand for removeListener)",
1112       "isStatic" : false,
1113       "isConstructor" : false,
1114       "isPrivate" : false,
1115       "memberOf" : "Roo.util.Observable",
1116       "example" : "",
1117       "deprecated" : "",
1118       "since" : "",
1119       "see" : "",
1120       "params" : [
1121         {
1122           "name" : "eventName",
1123           "type" : "String",
1124           "desc" : "The type of event to listen for",
1125           "isOptional" : false
1126         },
1127         {
1128           "name" : "handler",
1129           "type" : "Function",
1130           "desc" : "The handler to remove",
1131           "isOptional" : false
1132         },
1133         {
1134           "name" : "scope",
1135           "type" : "Object",
1136           "desc" : "(optional) The scope (this object) for the handler",
1137           "isOptional" : false
1138         }
1139       ],
1140       "returns" : [
1141       ]
1142     },
1143     {
1144       "name" : "addEvents",
1145       "desc" : "Used to define events on this Observable",
1146       "isStatic" : false,
1147       "isConstructor" : false,
1148       "isPrivate" : false,
1149       "memberOf" : "Roo.util.Observable",
1150       "example" : "",
1151       "deprecated" : "",
1152       "since" : "",
1153       "see" : "",
1154       "params" : [
1155         {
1156           "name" : "object",
1157           "type" : "Object",
1158           "desc" : "The object with the events defined",
1159           "isOptional" : false
1160         }
1161       ],
1162       "returns" : [
1163       ]
1164     },
1165     {
1166       "name" : "releaseCapture",
1167       "desc" : "Removes <b>all</b> added captures from the Observable.",
1168       "isStatic" : true,
1169       "isConstructor" : false,
1170       "isPrivate" : false,
1171       "memberOf" : "Roo.util.Observable",
1172       "example" : "",
1173       "deprecated" : "",
1174       "since" : "",
1175       "see" : "",
1176       "params" : [
1177         {
1178           "name" : "o",
1179           "type" : "Observable",
1180           "desc" : "The Observable to release",
1181           "isOptional" : false
1182         }
1183       ],
1184       "returns" : [
1185       ]
1186     },
1187     {
1188       "name" : "removeListener",
1189       "desc" : "Removes a listener",
1190       "isStatic" : false,
1191       "isConstructor" : false,
1192       "isPrivate" : false,
1193       "memberOf" : "Roo.util.Observable",
1194       "example" : "",
1195       "deprecated" : "",
1196       "since" : "",
1197       "see" : "",
1198       "params" : [
1199         {
1200           "name" : "eventName",
1201           "type" : "String",
1202           "desc" : "The type of event to listen for",
1203           "isOptional" : false
1204         },
1205         {
1206           "name" : "handler",
1207           "type" : "Function",
1208           "desc" : "The handler to remove",
1209           "isOptional" : false
1210         },
1211         {
1212           "name" : "scope",
1213           "type" : "Object",
1214           "desc" : "(optional) The scope (this object) for the handler",
1215           "isOptional" : false
1216         }
1217       ],
1218       "returns" : [
1219       ]
1220     },
1221     {
1222       "name" : "fireEvent",
1223       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1224       "isStatic" : false,
1225       "isConstructor" : false,
1226       "isPrivate" : false,
1227       "memberOf" : "Roo.util.Observable",
1228       "example" : "",
1229       "deprecated" : "",
1230       "since" : "",
1231       "see" : "",
1232       "params" : [
1233         {
1234           "name" : "eventName",
1235           "type" : "String",
1236           "desc" : "",
1237           "isOptional" : false
1238         },
1239         {
1240           "name" : "args",
1241           "type" : "Object...",
1242           "desc" : "Variable number of parameters are passed to handlers",
1243           "isOptional" : false
1244         }
1245       ],
1246       "returns" : [
1247         {
1248           "name" : "",
1249           "type" : "Boolean",
1250           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1251         }
1252       ]
1253     },
1254     {
1255       "name" : "hasListener",
1256       "desc" : "Checks to see if this object has any listeners for a specified event",
1257       "isStatic" : false,
1258       "isConstructor" : false,
1259       "isPrivate" : false,
1260       "memberOf" : "Roo.util.Observable",
1261       "example" : "",
1262       "deprecated" : "",
1263       "since" : "",
1264       "see" : "",
1265       "params" : [
1266         {
1267           "name" : "eventName",
1268           "type" : "String",
1269           "desc" : "The name of the event to check for",
1270           "isOptional" : false
1271         }
1272       ],
1273       "returns" : [
1274         {
1275           "name" : "",
1276           "type" : "Boolean",
1277           "desc" : "True if the event is being listened for, else false"
1278         }
1279       ]
1280     },
1281     {
1282       "name" : "capture",
1283       "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.",
1284       "isStatic" : true,
1285       "isConstructor" : false,
1286       "isPrivate" : false,
1287       "memberOf" : "Roo.util.Observable",
1288       "example" : "",
1289       "deprecated" : "",
1290       "since" : "",
1291       "see" : "",
1292       "params" : [
1293         {
1294           "name" : "o",
1295           "type" : "Observable",
1296           "desc" : "The Observable to capture",
1297           "isOptional" : false
1298         },
1299         {
1300           "name" : "fn",
1301           "type" : "Function",
1302           "desc" : "The function to call",
1303           "isOptional" : false
1304         },
1305         {
1306           "name" : "scope",
1307           "type" : "Object",
1308           "desc" : "(optional) The scope (this object) for the fn",
1309           "isOptional" : false
1310         }
1311       ],
1312       "returns" : [
1313       ]
1314     },
1315     {
1316       "name" : "addListener",
1317       "desc" : "Appends an event handler to this component",
1318       "isStatic" : false,
1319       "isConstructor" : false,
1320       "isPrivate" : false,
1321       "memberOf" : "Roo.util.Observable",
1322       "example" : "",
1323       "deprecated" : "",
1324       "since" : "",
1325       "see" : "",
1326       "params" : [
1327         {
1328           "name" : "eventName",
1329           "type" : "String",
1330           "desc" : "The type of event to listen for",
1331           "isOptional" : false
1332         },
1333         {
1334           "name" : "handler",
1335           "type" : "Function",
1336           "desc" : "The method the event invokes",
1337           "isOptional" : false
1338         },
1339         {
1340           "name" : "scope",
1341           "type" : "Object",
1342           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1343           "isOptional" : false
1344         },
1345         {
1346           "name" : "options",
1347           "type" : "Object",
1348           "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>",
1349           "isOptional" : false
1350         }
1351       ],
1352       "returns" : [
1353       ]
1354     }
1355   ],
1356   "events" : [
1357     {
1358       "name" : "rendered",
1359       "desc" : "Fires when the form is rendered",
1360       "memberOf" : "Roo.form.Form",
1361       "example" : "",
1362       "deprecated" : "",
1363       "since" : "",
1364       "see" : "",
1365       "params" : [
1366         {
1367           "name" : "form",
1368           "type" : "Roo.form.Form",
1369           "desc" : "",
1370           "isOptional" : false
1371         }
1372       ],
1373       "returns" : [
1374       ]
1375     },
1376     {
1377       "name" : "clientvalidation",
1378       "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
1379       "memberOf" : "Roo.form.Form",
1380       "example" : "",
1381       "deprecated" : "",
1382       "since" : "",
1383       "see" : "",
1384       "params" : [
1385         {
1386           "name" : "this",
1387           "type" : "Form",
1388           "desc" : "",
1389           "isOptional" : false
1390         },
1391         {
1392           "name" : "valid",
1393           "type" : "Boolean",
1394           "desc" : "true if the form has passed client-side validation",
1395           "isOptional" : false
1396         }
1397       ],
1398       "returns" : [
1399       ]
1400     },
1401     {
1402       "name" : "beforeaction",
1403       "desc" : "Fires before any action is performed. Return false to cancel the action.",
1404       "memberOf" : "Roo.form.BasicForm",
1405       "example" : "",
1406       "deprecated" : "",
1407       "since" : "",
1408       "see" : "",
1409       "params" : [
1410         {
1411           "name" : "this",
1412           "type" : "Form",
1413           "desc" : "",
1414           "isOptional" : false
1415         },
1416         {
1417           "name" : "action",
1418           "type" : "Action",
1419           "desc" : "The action to be performed",
1420           "isOptional" : false
1421         }
1422       ],
1423       "returns" : [
1424       ]
1425     },
1426     {
1427       "name" : "actioncomplete",
1428       "desc" : "Fires when an action is completed.",
1429       "memberOf" : "Roo.form.BasicForm",
1430       "example" : "",
1431       "deprecated" : "",
1432       "since" : "",
1433       "see" : "",
1434       "params" : [
1435         {
1436           "name" : "this",
1437           "type" : "Form",
1438           "desc" : "",
1439           "isOptional" : false
1440         },
1441         {
1442           "name" : "action",
1443           "type" : "Action",
1444           "desc" : "The action that completed",
1445           "isOptional" : false
1446         }
1447       ],
1448       "returns" : [
1449       ]
1450     },
1451     {
1452       "name" : "actionfailed",
1453       "desc" : "Fires when an action fails.",
1454       "memberOf" : "Roo.form.BasicForm",
1455       "example" : "",
1456       "deprecated" : "",
1457       "since" : "",
1458       "see" : "",
1459       "params" : [
1460         {
1461           "name" : "this",
1462           "type" : "Form",
1463           "desc" : "",
1464           "isOptional" : false
1465         },
1466         {
1467           "name" : "action",
1468           "type" : "Action",
1469           "desc" : "The action that failed",
1470           "isOptional" : false
1471         }
1472       ],
1473       "returns" : [
1474       ]
1475     }
1476   ]
1477 }