git.roojs.org Git - roojs1/blob - Roo/form/BasicForm.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11
  12 /**
  13  * @class Roo.form.BasicForm
  14  * @extends Roo.util.Observable
  15  * Supplies the functionality to do "actions" on forms and initialize Roo.form.Field types on existing markup.
  16  * @constructor
  17  * @param {String/HTMLElement/Roo.Element} el The form element or its id
  18  * @param {Object} config Configuration options
  19  */
  20 Roo.form.BasicForm = function(el, config){
  21     this.allItems = [];
  22     this.childForms = [];
  23     Roo.apply(this, config);
  24     /*
  25      * The Roo.form.Field items in this form.
  26      * @type MixedCollection
  27      */
  28
  29
  30     this.items = new Roo.util.MixedCollection(false, function(o){
  31         return o.id || (o.id = Roo.id());
  32     });
  33     this.addEvents({
  34         /**
  35          * @event beforeaction
  36          * Fires before any action is performed. Return false to cancel the action.
  37          * @param {Form} this
  38          * @param {Action} action The action to be performed
  39          */
  40         beforeaction: true,
  41         /**
  42          * @event actionfailed
  43          * Fires when an action fails.
  44          * @param {Form} this
  45          * @param {Action} action The action that failed
  46          */
  47         actionfailed : true,
  48         /**
  49          * @event actioncomplete
  50          * Fires when an action is completed.
  51          * @param {Form} this
  52          * @param {Action} action The action that completed
  53          */
  54         actioncomplete : true
  55     });
  56     if(el){
  57         this.initEl(el);
  58     }
  59     Roo.form.BasicForm.superclass.constructor.call(this);
  60 };
  61
  62 Roo.extend(Roo.form.BasicForm, Roo.util.Observable, {
  63     /**
  64      * @cfg {String} method
  65      * The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
  66      */
  67     /**
  68      * @cfg {DataReader} reader
  69      * An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing "load" actions.
  70      * This is optional as there is built-in support for processing JSON.
  71      */
  72     /**
  73      * @cfg {DataReader} errorReader
  74      * An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on "submit" actions.
  75      * This is completely optional as there is built-in support for processing JSON.
  76      */
  77     /**
  78      * @cfg {String} url
  79      * The URL to use for form actions if one isn't supplied in the action options.
  80      */
  81     /**
  82      * @cfg {Boolean} fileUpload
  83      * Set to true if this form is a file upload.
  84      */
  85     /**
  86      * @cfg {Object} baseParams
  87      * Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
  88      */
  89     /**
  90      * @cfg {Number} timeout Timeout for form actions in seconds (default is 30 seconds).
  91      */
  92     timeout: 30,
  93
  94     // private
  95     activeAction : null,
  96
  97     /**
  98      * @cfg {Boolean} trackResetOnLoad If set to true, form.reset() resets to the last loaded
  99      * or setValues() data instead of when the form was first created.
 100      */
 101     trackResetOnLoad : false,
 102
 103
 104     /**
 105      * childForms - used for multi-tab forms
 106      * @type {Array}
 107      */
 108     childForms : false,
 109
 110     /**
 111      * allItems - full list of fields.
 112      * @type {Array}
 113      */
 114     allItems : false,
 115
 116     /**
 117      * By default wait messages are displayed with Roo.MessageBox.wait. You can target a specific
 118      * element by passing it or its id or mask the form itself by passing in true.
 119      * @type Mixed
 120      */
 121     waitMsgTarget : undefined,
 122
 123     // private
 124     initEl : function(el){
 125         this.el = Roo.get(el);
 126         this.id = this.el.id || Roo.id();
 127         this.el.on('submit', this.onSubmit, this);
 128         this.el.addClass('x-form');
 129     },
 130
 131     // private
 132     onSubmit : function(e){
 133         e.stopEvent();
 134     },
 135
 136     /**
 137      * Returns true if client-side validation on the form is successful.
 138      * @return Boolean
 139      */
 140     isValid : function(){
 141         var valid = true;
 142         this.items.each(function(f){
 143            if(!f.validate()){
 144                valid = false;
 145            }
 146         });
 147         return valid;
 148     },
 149
 150     /**
 151      * Returns true if any fields in this form have changed since their original load.
 152      * @return Boolean
 153      */
 154     isDirty : function(){
 155         var dirty = false;
 156         this.items.each(function(f){
 157            if(f.isDirty()){
 158                dirty = true;
 159                return false;
 160            }
 161         });
 162         return dirty;
 163     },
 164
 165     /**
 166      * Performs a predefined action (submit or load) or custom actions you define on this form.
 167      * @param {String} actionName The name of the action type
 168      * @param {Object} options (optional) The options to pass to the action.  All of the config options listed
 169      * below are supported by both the submit and load actions unless otherwise noted (custom actions could also
 170      * accept other config options):
 171      * <pre>
 172 Property          Type             Description
 173 ----------------  ---------------  ----------------------------------------------------------------------------------
 174 url               String           The url for the action (defaults to the form's url)
 175 method            String           The form method to use (defaults to the form's method, or POST if not defined)
 176 params            String/Object    The params to pass (defaults to the form's baseParams, or none if not defined)
 177 clientValidation  Boolean          Applies to submit only.  Pass true to call form.isValid() prior to posting to
 178                                    validate the form on the client (defaults to false)
 179      * </pre>
 180      * @return {BasicForm} this
 181      */
 182     doAction : function(action, options){
 183         if(typeof action == 'string'){
 184             action = new Roo.form.Action.ACTION_TYPES[action](this, options);
 185         }
 186         if(this.fireEvent('beforeaction', this, action) !== false){
 187             this.beforeAction(action);
 188             action.run.defer(100, action);
 189         }
 190         return this;
 191     },
 192
 193     /**
 194      * Shortcut to do a submit action.
 195      * @param {Object} options The options to pass to the action (see {@link #doAction} for details)
 196      * @return {BasicForm} this
 197      */
 198     submit : function(options){
 199         this.doAction('submit', options);
 200         return this;
 201     },
 202
 203     /**
 204      * Shortcut to do a load action.
 205      * @param {Object} options The options to pass to the action (see {@link #doAction} for details)
 206      * @return {BasicForm} this
 207      */
 208     load : function(options){
 209         this.doAction('load', options);
 210         return this;
 211     },
 212
 213     /**
 214      * Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.
 215      * @param {Record} record The record to edit
 216      * @return {BasicForm} this
 217      */
 218     updateRecord : function(record){
 219         record.beginEdit();
 220         var fs = record.fields;
 221         fs.each(function(f){
 222             var field = this.findField(f.name);
 223             if(field){
 224                 record.set(f.name, field.getValue());
 225             }
 226         }, this);
 227         record.endEdit();
 228         return this;
 229     },
 230
 231     /**
 232      * Loads an Roo.data.Record into this form.
 233      * @param {Record} record The record to load
 234      * @return {BasicForm} this
 235      */
 236     loadRecord : function(record){
 237         this.setValues(record.data);
 238         return this;
 239     },
 240
 241     // private
 242     beforeAction : function(action){
 243         var o = action.options;
 244         if(o.waitMsg){
 245             if(this.waitMsgTarget === true){
 246                 this.el.mask(o.waitMsg, 'x-mask-loading');
 247             }else if(this.waitMsgTarget){
 248                 this.waitMsgTarget = Roo.get(this.waitMsgTarget);
 249                 this.waitMsgTarget.mask(o.waitMsg, 'x-mask-loading');
 250             }else{
 251                 Roo.MessageBox.wait(o.waitMsg, o.waitTitle || this.waitTitle || 'Please Wait...');
 252             }
 253         }
 254     },
 255
 256     // private
 257     afterAction : function(action, success){
 258         this.activeAction = null;
 259         var o = action.options;
 260         if(o.waitMsg){
 261             if(this.waitMsgTarget === true){
 262                 this.el.unmask();
 263             }else if(this.waitMsgTarget){
 264                 this.waitMsgTarget.unmask();
 265             }else{
 266                 Roo.MessageBox.updateProgress(1);
 267                 Roo.MessageBox.hide();
 268             }
 269         }
 270         if(success){
 271             if(o.reset){
 272                 this.reset();
 273             }
 274             Roo.callback(o.success, o.scope, [this, action]);
 275             this.fireEvent('actioncomplete', this, action);
 276         }else{
 277             Roo.callback(o.failure, o.scope, [this, action]);
 278             this.fireEvent('actionfailed', this, action);
 279         }
 280     },
 281
 282     /**
 283      * Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName
 284      * @param {String} id The value to search for
 285      * @return Field
 286      */
 287     findField : function(id){
 288         var field = this.items.get(id);
 289         if(!field){
 290             this.items.each(function(f){
 291                 if(f.isFormField && (f.dataIndex == id || f.id == id || f.getName() == id)){
 292                     field = f;
 293                     return false;
 294                 }
 295             });
 296         }
 297         return field || null;
 298     },
 299
 300     /**
 301      * Add a secondary form to this one,
 302      * Used to provide tabbed forms. One form is primary, with hidden values
 303      * which mirror the elements from the other forms.
 304      *
 305      * @param {Roo.form.Form} form to add.
 306      *
 307      */
 308     addForm : function(form)
 309     {
 310
 311         if (this.childForms.indexOf(form) > -1) {
 312             // already added..
 313             return;
 314         }
 315         this.childForms.push(form);
 316         Roo.each(form.allItems, function (fe) {
 317
 318             if (this.findField(fe.name)) { // already added..
 319                 return;
 320             }
 321             var add = new Roo.form.Hidden({
 322                 name : fe.name
 323             });
 324             add.render(this.el);
 325
 326             this.add( add );
 327         }, this);
 328
 329     },
 330     /**
 331      * Mark fields in this form invalid in bulk.
 332      * @param {Array/Object} errors Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}
 333      * @return {BasicForm} this
 334      */
 335     markInvalid : function(errors){
 336         if(errors instanceof Array){
 337             for(var i = 0, len = errors.length; i < len; i++){
 338                 var fieldError = errors[i];
 339                 var f = this.findField(fieldError.id);
 340                 if(f){
 341                     f.markInvalid(fieldError.msg);
 342                 }
 343             }
 344         }else{
 345             var field, id;
 346             for(id in errors){
 347                 if(typeof errors[id] != 'function' && (field = this.findField(id))){
 348                     field.markInvalid(errors[id]);
 349                 }
 350             }
 351         }
 352         Roo.each(this.childForms || [], function (f) {
 353             f.markInvalid(errors);
 354         });
 355
 356         return this;
 357     },
 358
 359     /**
 360      * Set values for fields in this form in bulk.
 361      * @param {Array/Object} values Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}
 362      * @return {BasicForm} this
 363      */
 364     setValues : function(values){
 365         if(values instanceof Array){ // array of objects
 366             for(var i = 0, len = values.length; i < len; i++){
 367                 var v = values[i];
 368                 var f = this.findField(v.id);
 369                 if(f){
 370                     f.setValue(v.value);
 371                     if(this.trackResetOnLoad){
 372                         f.originalValue = f.getValue();
 373                     }
 374                 }
 375             }
 376         }else{ // object hash
 377             var field, id;
 378             for(id in values){
 379                 if(typeof values[id] != 'function' && (field = this.findField(id))){
 380
 381                     if (field.setFromData &&
 382                         field.valueField &&
 383                         field.displayField &&
 384                         // combos' with local stores can
 385                         // be queried via setValue()
 386                         // to set their value..
 387                         (field.store && !field.store.isLocal)
 388                         ) {
 389                         // it's a combo
 390                         var sd = { };
 391                         sd[field.valueField] = typeof(values[field.hiddenName]) == 'undefined' ? '' : values[field.hiddenName];
 392                         sd[field.displayField] = typeof(values[field.name]) == 'undefined' ? '' : values[field.name];
 393                         field.setFromData(sd);
 394
 395                     } else {
 396                         field.setValue(values[id]);
 397                     }
 398
 399
 400                     if(this.trackResetOnLoad){
 401                         field.originalValue = field.getValue();
 402                     }
 403                 }
 404             }
 405         }
 406
 407         Roo.each(this.childForms || [], function (f) {
 408             f.setValues(values);
 409         });
 410
 411         return this;
 412     },
 413
 414     /**
 415      * Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name
 416      * they are returned as an array.
 417      * @param {Boolean} asString
 418      * @return {Object}
 419      */
 420     getValues : function(asString){
 421         if (this.childForms) {
 422             // copy values from the child forms
 423             Roo.each(this.childForms, function (f) {
 424                 this.setValues(f.getValues());
 425             }, this);
 426         }
 427
 428
 429
 430         var fs = Roo.lib.Ajax.serializeForm(this.el.dom);
 431         if(asString === true){
 432             return fs;
 433         }
 434         return Roo.urlDecode(fs);
 435     },
 436
 437     /**
 438      * Clears all invalid messages in this form.
 439      * @return {BasicForm} this
 440      */
 441     clearInvalid : function(){
 442         this.items.each(function(f){
 443            f.clearInvalid();
 444         });
 445
 446         Roo.each(this.childForms || [], function (f) {
 447             f.clearInvalid();
 448         });
 449
 450
 451         return this;
 452     },
 453
 454     /**
 455      * Resets this form.
 456      * @return {BasicForm} this
 457      */
 458     reset : function(){
 459         this.items.each(function(f){
 460             f.reset();
 461         });
 462
 463         Roo.each(this.childForms || [], function (f) {
 464             f.reset();
 465         });
 466
 467
 468         return this;
 469     },
 470
 471     /**
 472      * Add Roo.form components to this form.
 473      * @param {Field} field1
 474      * @param {Field} field2 (optional)
 475      * @param {Field} etc (optional)
 476      * @return {BasicForm} this
 477      */
 478     add : function(){
 479         this.items.addAll(Array.prototype.slice.call(arguments, 0));
 480         return this;
 481     },
 482
 483
 484     /**
 485      * Removes a field from the items collection (does NOT remove its markup).
 486      * @param {Field} field
 487      * @return {BasicForm} this
 488      */
 489     remove : function(field){
 490         this.items.remove(field);
 491         return this;
 492     },
 493
 494     /**
 495      * Looks at the fields in this form, checks them for an id attribute,
 496      * and calls applyTo on the existing dom element with that id.
 497      * @return {BasicForm} this
 498      */
 499     render : function(){
 500         this.items.each(function(f){
 501             if(f.isFormField && !f.rendered && document.getElementById(f.id)){ // if the element exists
 502                 f.applyTo(f.id);
 503             }
 504         });
 505         return this;
 506     },
 507
 508     /**
 509      * Calls {@link Ext#apply} for all fields in this form with the passed object.
 510      * @param {Object} values
 511      * @return {BasicForm} this
 512      */
 513     applyToFields : function(o){
 514         this.items.each(function(f){
 515            Roo.apply(f, o);
 516         });
 517         return this;
 518     },
 519
 520     /**
 521      * Calls {@link Ext#applyIf} for all field in this form with the passed object.
 522      * @param {Object} values
 523      * @return {BasicForm} this
 524      */
 525     applyIfToFields : function(o){
 526         this.items.each(function(f){
 527            Roo.applyIf(f, o);
 528         });
 529         return this;
 530     }
 531 });
 532
 533 // back compat
 534 Roo.BasicForm = Roo.form.BasicForm;