docs/source/BasicForm.html

   1 <html>
   2 <head>
   3   <title>The source code</title>
   4     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   5     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   6 </head>
   7 <body  onload="prettyPrint();">
   8     <pre class="prettyprint lang-js">/*!
   9  * Ext JS Library 3.0.3
  10  * Copyright(c) 2006-2009 Ext JS, LLC
  11  * licensing@extjs.com
  12  * http://www.extjs.com/license
  13  */
  14 <div id="cls-Ext.form.BasicForm"></div>/**
  15  * @class Ext.form.BasicForm
  16  * @extends Ext.util.Observable
  17  * <p>Encapsulates the DOM &lt;form> element at the heart of the {@link Ext.form.FormPanel FormPanel} class, and provides
  18  * input field management, validation, submission, and form loading services.</p>
  19  * <p>By default, Ext Forms are submitted through Ajax, using an instance of {@link Ext.form.Action.Submit}.
  20  * To enable normal browser submission of an Ext Form, use the {@link #standardSubmit} config option.</p>
  21  * <p><b><u>File Uploads</u></b></p>
  22  * <p>{@link #fileUpload File uploads} are not performed using Ajax submission, that
  23  * is they are <b>not</b> performed using XMLHttpRequests. Instead the form is submitted in the standard
  24  * manner with the DOM <tt>&lt;form></tt> element temporarily modified to have its
  25  * <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
  26  * to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document
  27  * but removed after the return data has been gathered.</p>
  28  * <p>The server response is parsed by the browser to create the document for the IFRAME. If the
  29  * server is using JSON to send the return object, then the
  30  * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
  31  * must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
  32  * <p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode
  33  * "&lt;" as "&amp;lt;", "&amp;" as "&amp;amp;" etc.</p>
  34  * <p>The response text is retrieved from the document, and a fake XMLHttpRequest object
  35  * is created containing a <tt>responseText</tt> property in order to conform to the
  36  * requirements of event handlers and callbacks.</p>
  37  * <p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>
  38  * and some server technologies (notably JEE) may require some custom processing in order to
  39  * retrieve parameter names and parameter values from the packet content.</p>
  40  * @constructor
  41  * @param {Mixed} el The form element or its id
  42  * @param {Object} config Configuration options
  43  */
  44 Ext.form.BasicForm = function(el, config){
  45     Ext.apply(this, config);
  46     if(Ext.isString(this.paramOrder)){
  47         this.paramOrder = this.paramOrder.split(/[\s,|]/);
  48     }
  49     <div id="prop-Ext.form.BasicForm-items"></div>/**
  50      * @property items
  51      * A {@link Ext.util.MixedCollection MixedCollection) containing all the Ext.form.Fields in this form.
  52      * @type MixedCollection
  53      */
  54     this.items = new Ext.util.MixedCollection(false, function(o){
  55         return o.getItemId();
  56     });
  57     this.addEvents(
  58         <div id="event-Ext.form.BasicForm-beforeaction"></div>/**
  59          * @event beforeaction
  60          * Fires before any action is performed. Return false to cancel the action.
  61          * @param {Form} this
  62          * @param {Action} action The {@link Ext.form.Action} to be performed
  63          */
  64         'beforeaction',
  65         <div id="event-Ext.form.BasicForm-actionfailed"></div>/**
  66          * @event actionfailed
  67          * Fires when an action fails.
  68          * @param {Form} this
  69          * @param {Action} action The {@link Ext.form.Action} that failed
  70          */
  71         'actionfailed',
  72         <div id="event-Ext.form.BasicForm-actioncomplete"></div>/**
  73          * @event actioncomplete
  74          * Fires when an action is completed.
  75          * @param {Form} this
  76          * @param {Action} action The {@link Ext.form.Action} that completed
  77          */
  78         'actioncomplete'
  79     );
  80
  81     if(el){
  82         this.initEl(el);
  83     }
  84     Ext.form.BasicForm.superclass.constructor.call(this);
  85 };
  86
  87 Ext.extend(Ext.form.BasicForm, Ext.util.Observable, {
  88     <div id="cfg-Ext.form.BasicForm-method"></div>/**
  89      * @cfg {String} method
  90      * The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
  91      */
  92     <div id="cfg-Ext.form.BasicForm-reader"></div>/**
  93      * @cfg {DataReader} reader
  94      * An Ext.data.DataReader (e.g. {@link Ext.data.XmlReader}) to be used to read
  95      * data when executing 'load' actions. This is optional as there is built-in
  96      * support for processing JSON.  For additional information on using an XMLReader
  97      * see the example provided in examples/form/xml-form.html.
  98      */
  99     <div id="cfg-Ext.form.BasicForm-errorReader"></div>/**
 100      * @cfg {DataReader} errorReader
 101      * <p>An Ext.data.DataReader (e.g. {@link Ext.data.XmlReader}) to be used to
 102      * read field error messages returned from 'submit' actions. This is optional
 103      * as there is built-in support for processing JSON.</p>
 104      * <p>The Records which provide messages for the invalid Fields must use the
 105      * Field name (or id) as the Record ID, and must contain a field called 'msg'
 106      * which contains the error message.</p>
 107      * <p>The errorReader does not have to be a full-blown implementation of a
 108      * DataReader. It simply needs to implement a <tt>read(xhr)</tt> function
 109      * which returns an Array of Records in an object with the following
 110      * structure:</p><pre><code>
 111 {
 112     records: recordArray
 113 }
 114 </code></pre>
 115      */
 116     <div id="cfg-Ext.form.BasicForm-url"></div>/**
 117      * @cfg {String} url
 118      * The URL to use for form actions if one isn't supplied in the
 119      * <code>{@link #doAction doAction} options</code>.
 120      */
 121     <div id="cfg-Ext.form.BasicForm-fileUpload"></div>/**
 122      * @cfg {Boolean} fileUpload
 123      * Set to true if this form is a file upload.
 124      * <p>File uploads are not performed using normal 'Ajax' techniques, that is they are <b>not</b>
 125      * performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the
 126      * DOM <tt>&lt;form></tt> element temporarily modified to have its
 127      * <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
 128      * to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document
 129      * but removed after the return data has been gathered.</p>
 130      * <p>The server response is parsed by the browser to create the document for the IFRAME. If the
 131      * server is using JSON to send the return object, then the
 132      * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
 133      * must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
 134      * <p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode
 135      * "&lt;" as "&amp;lt;", "&amp;" as "&amp;amp;" etc.</p>
 136      * <p>The response text is retrieved from the document, and a fake XMLHttpRequest object
 137      * is created containing a <tt>responseText</tt> property in order to conform to the
 138      * requirements of event handlers and callbacks.</p>
 139      * <p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>
 140      * and some server technologies (notably JEE) may require some custom processing in order to
 141      * retrieve parameter names and parameter values from the packet content.</p>
 142      */
 143     <div id="cfg-Ext.form.BasicForm-baseParams"></div>/**
 144      * @cfg {Object} baseParams
 145      * <p>Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.</p>
 146      * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p>
 147      */
 148     <div id="cfg-Ext.form.BasicForm-timeout"></div>/**
 149      * @cfg {Number} timeout Timeout for form actions in seconds (default is 30 seconds).
 150      */
 151     timeout: 30,
 152
 153     <div id="cfg-Ext.form.BasicForm-api"></div>/**
 154      * @cfg {Object} api (Optional) If specified load and submit actions will be handled
 155      * with {@link Ext.form.Action.DirectLoad} and {@link Ext.form.Action.DirectSubmit}.
 156      * Methods which have been imported by Ext.Direct can be specified here to load and submit
 157      * forms.
 158      * Such as the following:<pre><code>
 159 api: {
 160     load: App.ss.MyProfile.load,
 161     submit: App.ss.MyProfile.submit
 162 }
 163 </code></pre>
 164      * <p>Load actions can use <code>{@link #paramOrder}</code> or <code>{@link #paramsAsHash}</code>
 165      * to customize how the load method is invoked.
 166      * Submit actions will always use a standard form submit. The formHandler configuration must
 167      * be set on the associated server-side method which has been imported by Ext.Direct</p>
 168      */
 169
 170     <div id="cfg-Ext.form.BasicForm-paramOrder"></div>/**
 171      * @cfg {Array/String} paramOrder <p>A list of params to be executed server side.
 172      * Defaults to <tt>undefined</tt>. Only used for the <code>{@link #api}</code>
 173      * <code>load</code> configuration.</p>
 174      * <br><p>Specify the params in the order in which they must be executed on the
 175      * server-side as either (1) an Array of String values, or (2) a String of params
 176      * delimited by either whitespace, comma, or pipe. For example,
 177      * any of the following would be acceptable:</p><pre><code>
 178 paramOrder: ['param1','param2','param3']
 179 paramOrder: 'param1 param2 param3'
 180 paramOrder: 'param1,param2,param3'
 181 paramOrder: 'param1|param2|param'
 182      </code></pre>
 183      */
 184     paramOrder: undefined,
 185
 186     <div id="cfg-Ext.form.BasicForm-paramsAsHash"></div>/**
 187      * @cfg {Boolean} paramsAsHash Only used for the <code>{@link #api}</code>
 188      * <code>load</code> configuration. Send parameters as a collection of named
 189      * arguments (defaults to <tt>false</tt>). Providing a
 190      * <tt>{@link #paramOrder}</tt> nullifies this configuration.
 191      */
 192     paramsAsHash: false,
 193
 194     <div id="cfg-Ext.form.BasicForm-waitTitle"></div>/**
 195      * @cfg {String} waitTitle
 196      * The default title to show for the waiting message box (defaults to <tt>'Please Wait...'</tt>)
 197      */
 198     waitTitle: 'Please Wait...',
 199
 200     // private
 201     activeAction : null,
 202
 203     <div id="cfg-Ext.form.BasicForm-trackResetOnLoad"></div>/**
 204      * @cfg {Boolean} trackResetOnLoad If set to <tt>true</tt>, {@link #reset}() resets to the last loaded
 205      * or {@link #setValues}() data instead of when the form was first created.  Defaults to <tt>false</tt>.
 206      */
 207     trackResetOnLoad : false,
 208
 209     <div id="cfg-Ext.form.BasicForm-standardSubmit"></div>/**
 210      * @cfg {Boolean} standardSubmit
 211      * <p>If set to <tt>true</tt>, standard HTML form submits are used instead
 212      * of XHR (Ajax) style form submissions. Defaults to <tt>false</tt>.</p>
 213      * <br><p><b>Note:</b> When using <code>standardSubmit</code>, the
 214      * <code>options</code> to <code>{@link #submit}</code> are ignored because
 215      * Ext's Ajax infrastracture is bypassed. To pass extra parameters (e.g.
 216      * <code>baseParams</code> and <code>params</code>), utilize hidden fields
 217      * to submit extra data, for example:</p>
 218      * <pre><code>
 219 new Ext.FormPanel({
 220     standardSubmit: true,
 221     baseParams: {
 222         foo: 'bar'
 223     },
 224     {@link url}: 'myProcess.php',
 225     items: [{
 226         xtype: 'textfield',
 227         name: 'userName'
 228     }],
 229     buttons: [{
 230         text: 'Save',
 231         handler: function(){
 232             var fp = this.ownerCt.ownerCt,
 233                 form = fp.getForm();
 234             if (form.isValid()) {
 235                 // check if there are baseParams and if
 236                 // hiddent items have been added already
 237                 if (fp.baseParams && !fp.paramsAdded) {
 238                     // add hidden items for all baseParams
 239                     for (i in fp.baseParams) {
 240                         fp.add({
 241                             xtype: 'hidden',
 242                             name: i,
 243                             value: fp.baseParams[i]
 244                         });
 245                     }
 246                     fp.doLayout();
 247                     // set a custom flag to prevent re-adding
 248                     fp.paramsAdded = true;
 249                 }
 250                 form.{@link #submit}();
 251             }
 252         }
 253     }]
 254 });
 255      * </code></pre>
 256      */
 257     <div id="prop-Ext.form.BasicForm-waitMsgTarget"></div>/**
 258      * By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
 259      * element by passing it or its id or mask the form itself by passing in true.
 260      * @type Mixed
 261      * @property waitMsgTarget
 262      */
 263
 264     // private
 265     initEl : function(el){
 266         this.el = Ext.get(el);
 267         this.id = this.el.id || Ext.id();
 268         if(!this.standardSubmit){
 269             this.el.on('submit', this.onSubmit, this);
 270         }
 271         this.el.addClass('x-form');
 272     },
 273
 274     <div id="method-Ext.form.BasicForm-getEl"></div>/**
 275      * Get the HTML form Element
 276      * @return Ext.Element
 277      */
 278     getEl: function(){
 279         return this.el;
 280     },
 281
 282     // private
 283     onSubmit : function(e){
 284         e.stopEvent();
 285     },
 286
 287     // private
 288     destroy: function() {
 289         this.items.each(function(f){
 290             Ext.destroy(f);
 291         });
 292         if(this.el){
 293             this.el.removeAllListeners();
 294             this.el.remove();
 295         }
 296         this.purgeListeners();
 297     },
 298
 299     <div id="method-Ext.form.BasicForm-isValid"></div>/**
 300      * Returns true if client-side validation on the form is successful.
 301      * @return Boolean
 302      */
 303     isValid : function(){
 304         var valid = true;
 305         this.items.each(function(f){
 306            if(!f.validate()){
 307                valid = false;
 308            }
 309         });
 310         return valid;
 311     },
 312
 313     <div id="method-Ext.form.BasicForm-isDirty"></div>/**
 314      * <p>Returns true if any fields in this form have changed from their original values.</p>
 315      * <p>Note that if this BasicForm was configured with {@link #trackResetOnLoad} then the
 316      * Fields' <i>original values</i> are updated when the values are loaded by {@link #setValues}
 317      * or {@link #loadRecord}.</p>
 318      * @return Boolean
 319      */
 320     isDirty : function(){
 321         var dirty = false;
 322         this.items.each(function(f){
 323            if(f.isDirty()){
 324                dirty = true;
 325                return false;
 326            }
 327         });
 328         return dirty;
 329     },
 330
 331     <div id="method-Ext.form.BasicForm-doAction"></div>/**
 332      * Performs a predefined action ({@link Ext.form.Action.Submit} or
 333      * {@link Ext.form.Action.Load}) or a custom extension of {@link Ext.form.Action}
 334      * to perform application-specific processing.
 335      * @param {String/Object} actionName The name of the predefined action type,
 336      * or instance of {@link Ext.form.Action} to perform.
 337      * @param {Object} options (optional) The options to pass to the {@link Ext.form.Action}.
 338      * All of the config options listed below are supported by both the
 339      * {@link Ext.form.Action.Submit submit} and {@link Ext.form.Action.Load load}
 340      * actions unless otherwise noted (custom actions could also accept
 341      * other config options):<ul>
 342      *
 343      * <li><b>url</b> : String<div class="sub-desc">The url for the action (defaults
 344      * to the form's {@link #url}.)</div></li>
 345      *
 346      * <li><b>method</b> : String<div class="sub-desc">The form method to use (defaults
 347      * to the form's method, or POST if not defined)</div></li>
 348      *
 349      * <li><b>params</b> : String/Object<div class="sub-desc"><p>The params to pass
 350      * (defaults to the form's baseParams, or none if not defined)</p>
 351      * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p></div></li>
 352      *
 353      * <li><b>headers</b> : Object<div class="sub-desc">Request headers to set for the action
 354      * (defaults to the form's default headers)</div></li>
 355      *
 356      * <li><b>success</b> : Function<div class="sub-desc">The callback that will
 357      * be invoked after a successful response (see top of
 358      * {@link Ext.form.Action.Submit submit} and {@link Ext.form.Action.Load load}
 359      * for a description of what constitutes a successful response).
 360      * The function is passed the following parameters:<ul>
 361      * <li><tt>form</tt> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
 362      * <li><tt>action</tt> : The {@link Ext.form.Action Action} object which performed the operation.
 363      * <div class="sub-desc">The action object contains these properties of interest:<ul>
 364      * <li><tt>{@link Ext.form.Action#response response}</tt></li>
 365      * <li><tt>{@link Ext.form.Action#result result}</tt> : interrogate for custom postprocessing</li>
 366      * <li><tt>{@link Ext.form.Action#type type}</tt></li>
 367      * </ul></div></li></ul></div></li>
 368      *
 369      * <li><b>failure</b> : Function<div class="sub-desc">The callback that will be invoked after a
 370      * failed transaction attempt. The function is passed the following parameters:<ul>
 371      * <li><tt>form</tt> : The {@link Ext.form.BasicForm} that requested the action.</li>
 372      * <li><tt>action</tt> : The {@link Ext.form.Action Action} object which performed the operation.
 373      * <div class="sub-desc">The action object contains these properties of interest:<ul>
 374      * <li><tt>{@link Ext.form.Action#failureType failureType}</tt></li>
 375      * <li><tt>{@link Ext.form.Action#response response}</tt></li>
 376      * <li><tt>{@link Ext.form.Action#result result}</tt> : interrogate for custom postprocessing</li>
 377      * <li><tt>{@link Ext.form.Action#type type}</tt></li>
 378      * </ul></div></li></ul></div></li>
 379      *
 380      * <li><b>scope</b> : Object<div class="sub-desc">The scope in which to call the
 381      * callback functions (The <tt>this</tt> reference for the callback functions).</div></li>
 382      *
 383      * <li><b>clientValidation</b> : Boolean<div class="sub-desc">Submit Action only.
 384      * Determines whether a Form's fields are validated in a final call to
 385      * {@link Ext.form.BasicForm#isValid isValid} prior to submission. Set to <tt>false</tt>
 386      * to prevent this. If undefined, pre-submission field validation is performed.</div></li></ul>
 387      *
 388      * @return {BasicForm} this
 389      */
 390     doAction : function(action, options){
 391         if(Ext.isString(action)){
 392             action = new Ext.form.Action.ACTION_TYPES[action](this, options);
 393         }
 394         if(this.fireEvent('beforeaction', this, action) !== false){
 395             this.beforeAction(action);
 396             action.run.defer(100, action);
 397         }
 398         return this;
 399     },
 400
 401     <div id="method-Ext.form.BasicForm-submit"></div>/**
 402      * Shortcut to {@link #doAction do} a {@link Ext.form.Action.Submit submit action}.
 403      * @param {Object} options The options to pass to the action (see {@link #doAction} for details).<br>
 404      * <p><b>Note:</b> this is ignored when using the {@link #standardSubmit} option.</p>
 405      * <p>The following code:</p><pre><code>
 406 myFormPanel.getForm().submit({
 407     clientValidation: true,
 408     url: 'updateConsignment.php',
 409     params: {
 410         newStatus: 'delivered'
 411     },
 412     success: function(form, action) {
 413        Ext.Msg.alert('Success', action.result.msg);
 414     },
 415     failure: function(form, action) {
 416         switch (action.failureType) {
 417             case Ext.form.Action.CLIENT_INVALID:
 418                 Ext.Msg.alert('Failure', 'Form fields may not be submitted with invalid values');
 419                 break;
 420             case Ext.form.Action.CONNECT_FAILURE:
 421                 Ext.Msg.alert('Failure', 'Ajax communication failed');
 422                 break;
 423             case Ext.form.Action.SERVER_INVALID:
 424                Ext.Msg.alert('Failure', action.result.msg);
 425        }
 426     }
 427 });
 428 </code></pre>
 429      * would process the following server response for a successful submission:<pre><code>
 430 {
 431     "success":true, // note this is Boolean, not string
 432     "msg":"Consignment updated"
 433 }
 434 </code></pre>
 435      * and the following server response for a failed submission:<pre><code>
 436 {
 437     "success":false, // note this is Boolean, not string
 438     "msg":"You do not have permission to perform this operation"
 439 }
 440 </code></pre>
 441      * @return {BasicForm} this
 442      */
 443     submit : function(options){
 444         if(this.standardSubmit){
 445             var v = this.isValid();
 446             if(v){
 447                 var el = this.el.dom;
 448                 if(this.url && Ext.isEmpty(el.action)){
 449                     el.action = this.url;
 450                 }
 451                 el.submit();
 452             }
 453             return v;
 454         }
 455         var submitAction = String.format('{0}submit', this.api ? 'direct' : '');
 456         this.doAction(submitAction, options);
 457         return this;
 458     },
 459
 460     <div id="method-Ext.form.BasicForm-load"></div>/**
 461      * Shortcut to {@link #doAction do} a {@link Ext.form.Action.Load load action}.
 462      * @param {Object} options The options to pass to the action (see {@link #doAction} for details)
 463      * @return {BasicForm} this
 464      */
 465     load : function(options){
 466         var loadAction = String.format('{0}load', this.api ? 'direct' : '');
 467         this.doAction(loadAction, options);
 468         return this;
 469     },
 470
 471     <div id="method-Ext.form.BasicForm-updateRecord"></div>/**
 472      * Persists the values in this form into the passed {@link Ext.data.Record} object in a beginEdit/endEdit block.
 473      * @param {Record} record The record to edit
 474      * @return {BasicForm} this
 475      */
 476     updateRecord : function(record){
 477         record.beginEdit();
 478         var fs = record.fields;
 479         fs.each(function(f){
 480             var field = this.findField(f.name);
 481             if(field){
 482                 record.set(f.name, field.getValue());
 483             }
 484         }, this);
 485         record.endEdit();
 486         return this;
 487     },
 488
 489     <div id="method-Ext.form.BasicForm-loadRecord"></div>/**
 490      * Loads an {@link Ext.data.Record} into this form by calling {@link #setValues} with the
 491      * {@link Ext.data.Record#data record data}.
 492      * See also {@link #trackResetOnLoad}.
 493      * @param {Record} record The record to load
 494      * @return {BasicForm} this
 495      */
 496     loadRecord : function(record){
 497         this.setValues(record.data);
 498         return this;
 499     },
 500
 501     // private
 502     beforeAction : function(action){
 503         var o = action.options;
 504         if(o.waitMsg){
 505             if(this.waitMsgTarget === true){
 506                 this.el.mask(o.waitMsg, 'x-mask-loading');
 507             }else if(this.waitMsgTarget){
 508                 this.waitMsgTarget = Ext.get(this.waitMsgTarget);
 509                 this.waitMsgTarget.mask(o.waitMsg, 'x-mask-loading');
 510             }else{
 511                 Ext.MessageBox.wait(o.waitMsg, o.waitTitle || this.waitTitle);
 512             }
 513         }
 514     },
 515
 516     // private
 517     afterAction : function(action, success){
 518         this.activeAction = null;
 519         var o = action.options;
 520         if(o.waitMsg){
 521             if(this.waitMsgTarget === true){
 522                 this.el.unmask();
 523             }else if(this.waitMsgTarget){
 524                 this.waitMsgTarget.unmask();
 525             }else{
 526                 Ext.MessageBox.updateProgress(1);
 527                 Ext.MessageBox.hide();
 528             }
 529         }
 530         if(success){
 531             if(o.reset){
 532                 this.reset();
 533             }
 534             Ext.callback(o.success, o.scope, [this, action]);
 535             this.fireEvent('actioncomplete', this, action);
 536         }else{
 537             Ext.callback(o.failure, o.scope, [this, action]);
 538             this.fireEvent('actionfailed', this, action);
 539         }
 540     },
 541
 542     <div id="method-Ext.form.BasicForm-findField"></div>/**
 543      * Find a {@link Ext.form.Field} in this form.
 544      * @param {String} id The value to search for (specify either a {@link Ext.Component#id id},
 545      * {@link Ext.grid.Column#dataIndex dataIndex}, {@link Ext.form.Field#getName name or hiddenName}).
 546      * @return Field
 547      */
 548     findField : function(id){
 549         var field = this.items.get(id);
 550         if(!Ext.isObject(field)){
 551             this.items.each(function(f){
 552                 if(f.isFormField && (f.dataIndex == id || f.id == id || f.getName() == id)){
 553                     field = f;
 554                     return false;
 555                 }
 556             });
 557         }
 558         return field || null;
 559     },
 560
 561
 562     <div id="method-Ext.form.BasicForm-markInvalid"></div>/**
 563      * Mark fields in this form invalid in bulk.
 564      * @param {Array/Object} errors Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}
 565      * @return {BasicForm} this
 566      */
 567     markInvalid : function(errors){
 568         if(Ext.isArray(errors)){
 569             for(var i = 0, len = errors.length; i < len; i++){
 570                 var fieldError = errors[i];
 571                 var f = this.findField(fieldError.id);
 572                 if(f){
 573                     f.markInvalid(fieldError.msg);
 574                 }
 575             }
 576         }else{
 577             var field, id;
 578             for(id in errors){
 579                 if(!Ext.isFunction(errors[id]) && (field = this.findField(id))){
 580                     field.markInvalid(errors[id]);
 581                 }
 582             }
 583         }
 584         return this;
 585     },
 586
 587     <div id="method-Ext.form.BasicForm-setValues"></div>/**
 588      * Set values for fields in this form in bulk.
 589      * @param {Array/Object} values Either an array in the form:<pre><code>
 590 [{id:'clientName', value:'Fred. Olsen Lines'},
 591  {id:'portOfLoading', value:'FXT'},
 592  {id:'portOfDischarge', value:'OSL'} ]</code></pre>
 593      * or an object hash of the form:<pre><code>
 594 {
 595     clientName: 'Fred. Olsen Lines',
 596     portOfLoading: 'FXT',
 597     portOfDischarge: 'OSL'
 598 }</code></pre>
 599      * @return {BasicForm} this
 600      */
 601     setValues : function(values){
 602         if(Ext.isArray(values)){ // array of objects
 603             for(var i = 0, len = values.length; i < len; i++){
 604                 var v = values[i];
 605                 var f = this.findField(v.id);
 606                 if(f){
 607                     f.setValue(v.value);
 608                     if(this.trackResetOnLoad){
 609                         f.originalValue = f.getValue();
 610                     }
 611                 }
 612             }
 613         }else{ // object hash
 614             var field, id;
 615             for(id in values){
 616                 if(!Ext.isFunction(values[id]) && (field = this.findField(id))){
 617                     field.setValue(values[id]);
 618                     if(this.trackResetOnLoad){
 619                         field.originalValue = field.getValue();
 620                     }
 621                 }
 622             }
 623         }
 624         return this;
 625     },
 626
 627     <div id="method-Ext.form.BasicForm-getValues"></div>/**
 628      * <p>Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form submit.
 629      * If multiple fields exist with the same name they are returned as an array.</p>
 630      * <p><b>Note:</b> The values are collected from all enabled HTML input elements within the form, <u>not</u> from
 631      * the Ext Field objects. This means that all returned values are Strings (or Arrays of Strings) and that the
 632      * value can potentially be the emptyText of a field.</p>
 633      * @param {Boolean} asString (optional) Pass true to return the values as a string. (defaults to false, returning an Object)
 634      * @return {String/Object}
 635      */
 636     getValues : function(asString){
 637         var fs = Ext.lib.Ajax.serializeForm(this.el.dom);
 638         if(asString === true){
 639             return fs;
 640         }
 641         return Ext.urlDecode(fs);
 642     },
 643
 644     getFieldValues : function(){
 645         var o = {};
 646         this.items.each(function(f){
 647            o[f.getName()] = f.getValue();
 648         });
 649         return o;
 650     },
 651
 652     <div id="method-Ext.form.BasicForm-clearInvalid"></div>/**
 653      * Clears all invalid messages in this form.
 654      * @return {BasicForm} this
 655      */
 656     clearInvalid : function(){
 657         this.items.each(function(f){
 658            f.clearInvalid();
 659         });
 660         return this;
 661     },
 662
 663     <div id="method-Ext.form.BasicForm-reset"></div>/**
 664      * Resets this form.
 665      * @return {BasicForm} this
 666      */
 667     reset : function(){
 668         this.items.each(function(f){
 669             f.reset();
 670         });
 671         return this;
 672     },
 673
 674     <div id="method-Ext.form.BasicForm-add"></div>/**
 675      * Add Ext.form Components to this form's Collection. This does not result in rendering of
 676      * the passed Component, it just enables the form to validate Fields, and distribute values to
 677      * Fields.
 678      * <p><b>You will not usually call this function. In order to be rendered, a Field must be added
 679      * to a {@link Ext.Container Container}, usually an {@link Ext.form.FormPanel FormPanel}.
 680      * The FormPanel to which the field is added takes care of adding the Field to the BasicForm's
 681      * collection.</b></p>
 682      * @param {Field} field1
 683      * @param {Field} field2 (optional)
 684      * @param {Field} etc (optional)
 685      * @return {BasicForm} this
 686      */
 687     add : function(){
 688         this.items.addAll(Array.prototype.slice.call(arguments, 0));
 689         return this;
 690     },
 691
 692
 693     <div id="method-Ext.form.BasicForm-remove"></div>/**
 694      * Removes a field from the items collection (does NOT remove its markup).
 695      * @param {Field} field
 696      * @return {BasicForm} this
 697      */
 698     remove : function(field){
 699         this.items.remove(field);
 700         return this;
 701     },
 702
 703     <div id="method-Ext.form.BasicForm-render"></div>/**
 704      * Iterates through the {@link Ext.form.Field Field}s which have been {@link #add add}ed to this BasicForm,
 705      * checks them for an id attribute, and calls {@link Ext.form.Field#applyToMarkup} on the existing dom element with that id.
 706      * @return {BasicForm} this
 707      */
 708     render : function(){
 709         this.items.each(function(f){
 710             if(f.isFormField && !f.rendered && document.getElementById(f.id)){ // if the element exists
 711                 f.applyToMarkup(f.id);
 712             }
 713         });
 714         return this;
 715     },
 716
 717     <div id="method-Ext.form.BasicForm-applyToFields"></div>/**
 718      * Calls {@link Ext#apply} for all fields in this form with the passed object.
 719      * @param {Object} values
 720      * @return {BasicForm} this
 721      */
 722     applyToFields : function(o){
 723         this.items.each(function(f){
 724            Ext.apply(f, o);
 725         });
 726         return this;
 727     },
 728
 729     <div id="method-Ext.form.BasicForm-applyIfToFields"></div>/**
 730      * Calls {@link Ext#applyIf} for all field in this form with the passed object.
 731      * @param {Object} values
 732      * @return {BasicForm} this
 733      */
 734     applyIfToFields : function(o){
 735         this.items.each(function(f){
 736            Ext.applyIf(f, o);
 737         });
 738         return this;
 739     },
 740
 741     callFieldMethod : function(fnName, args){
 742         args = args || [];
 743         this.items.each(function(f){
 744             if(Ext.isFunction(f[fnName])){
 745                 f[fnName].apply(f, args);
 746             }
 747         });
 748         return this;
 749     }
 750 });
 751
 752 // back compat
 753 Ext.BasicForm = Ext.form.BasicForm;</pre>
 754 </body>
 755 </html>