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         this.childForms.push(form);
 311         Roo.each(form.allItems, function (fe) {
 312
 313             if (this.findField(fe.name)) { // already added..
 314                 return;
 315             }
 316             var add = new Roo.form.Hidden({
 317                 name : fe.name
 318             });
 319             add.render(this.el);
 320
 321             this.add( new Roo.form.Hidden({
 322                 name : fe.name
 323             }));
 324         }, this);
 325
 326     },
 327     /**
 328      * Mark fields in this form invalid in bulk.
 329      * @param {Array/Object} errors Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}
 330      * @return {BasicForm} this
 331      */
 332     markInvalid : function(errors){
 333         if(errors instanceof Array){
 334             for(var i = 0, len = errors.length; i < len; i++){
 335                 var fieldError = errors[i];
 336                 var f = this.findField(fieldError.id);
 337                 if(f){
 338                     f.markInvalid(fieldError.msg);
 339                 }
 340             }
 341         }else{
 342             var field, id;
 343             for(id in errors){
 344                 if(typeof errors[id] != 'function' && (field = this.findField(id))){
 345                     field.markInvalid(errors[id]);
 346                 }
 347             }
 348         }
 349         Roo.each(this.childForms || [], function (f) {
 350             f.markInvalid(errors);
 351         });
 352
 353         return this;
 354     },
 355
 356     /**
 357      * Set values for fields in this form in bulk.
 358      * @param {Array/Object} values Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}
 359      * @return {BasicForm} this
 360      */
 361     setValues : function(values){
 362         if(values instanceof Array){ // array of objects
 363             for(var i = 0, len = values.length; i < len; i++){
 364                 var v = values[i];
 365                 var f = this.findField(v.id);
 366                 if(f){
 367                     f.setValue(v.value);
 368                     if(this.trackResetOnLoad){
 369                         f.originalValue = f.getValue();
 370                     }
 371                 }
 372             }
 373         }else{ // object hash
 374             var field, id;
 375             for(id in values){
 376                 if(typeof values[id] != 'function' && (field = this.findField(id))){
 377
 378                     if (field.setFromData &&
 379                         field.valueField &&
 380                         field.displayField &&
 381                         // combos' with local stores can
 382                         // be queried via setValue()
 383                         // to set their value..
 384                         (field.store && !field.store.isLocal)
 385                         ) {
 386                         // it's a combo
 387                         var sd = { };
 388                         sd[field.valueField] = typeof(values[field.hiddenName]) == 'undefined' ? '' : values[field.hiddenName];
 389                         sd[field.displayField] = typeof(values[field.name]) == 'undefined' ? '' : values[field.name];
 390                         field.setFromData(sd);
 391
 392                     } else {
 393                         field.setValue(values[id]);
 394                     }
 395
 396
 397                     if(this.trackResetOnLoad){
 398                         field.originalValue = field.getValue();
 399                     }
 400                 }
 401             }
 402         }
 403
 404         Roo.each(this.childForms || [], function (f) {
 405             f.setValues(values);
 406         });
 407
 408         return this;
 409     },
 410
 411     /**
 412      * Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name
 413      * they are returned as an array.
 414      * @param {Boolean} asString
 415      * @return {Object}
 416      */
 417     getValues : function(asString){
 418         if (this.childForms) {
 419             // copy values from the child forms
 420             Roo.each(this.childForms, function (f) {
 421                 if (f.allFields) {
 422                     Roo.each(f.allFields, function (e) {
 423                         if (e.name && e.getValue && this.findField(e.name)) {
 424                             this.findField(e.name).setValue(e.getValue());
 425                         }
 426                     });
 427                 }
 428             }, this);
 429         }
 430
 431
 432
 433         var fs = Roo.lib.Ajax.serializeForm(this.el.dom);
 434         if(asString === true){
 435             return fs;
 436         }
 437         return Roo.urlDecode(fs);
 438     },
 439
 440     /**
 441      * Clears all invalid messages in this form.
 442      * @return {BasicForm} this
 443      */
 444     clearInvalid : function(){
 445         this.items.each(function(f){
 446            f.clearInvalid();
 447         });
 448
 449         Roo.each(this.childForms || [], function (f) {
 450             f.clearInvalid();
 451         });
 452
 453
 454         return this;
 455     },
 456
 457     /**
 458      * Resets this form.
 459      * @return {BasicForm} this
 460      */
 461     reset : function(){
 462         this.items.each(function(f){
 463             f.reset();
 464         });
 465
 466         Roo.each(this.childForms || [], function (f) {
 467             f.reset();
 468         });
 469
 470
 471         return this;
 472     },
 473
 474     /**
 475      * Add Roo.form components to this form.
 476      * @param {Field} field1
 477      * @param {Field} field2 (optional)
 478      * @param {Field} etc (optional)
 479      * @return {BasicForm} this
 480      */
 481     add : function(){
 482         this.items.addAll(Array.prototype.slice.call(arguments, 0));
 483         return this;
 484     },
 485
 486
 487     /**
 488      * Removes a field from the items collection (does NOT remove its markup).
 489      * @param {Field} field
 490      * @return {BasicForm} this
 491      */
 492     remove : function(field){
 493         this.items.remove(field);
 494         return this;
 495     },
 496
 497     /**
 498      * Looks at the fields in this form, checks them for an id attribute,
 499      * and calls applyTo on the existing dom element with that id.
 500      * @return {BasicForm} this
 501      */
 502     render : function(){
 503         this.items.each(function(f){
 504             if(f.isFormField && !f.rendered && document.getElementById(f.id)){ // if the element exists
 505                 f.applyTo(f.id);
 506             }
 507         });
 508         return this;
 509     },
 510
 511     /**
 512      * Calls {@link Ext#apply} for all fields in this form with the passed object.
 513      * @param {Object} values
 514      * @return {BasicForm} this
 515      */
 516     applyToFields : function(o){
 517         this.items.each(function(f){
 518            Roo.apply(f, o);
 519         });
 520         return this;
 521     },
 522
 523     /**
 524      * Calls {@link Ext#applyIf} for all field in this form with the passed object.
 525      * @param {Object} values
 526      * @return {BasicForm} this
 527      */
 528     applyIfToFields : function(o){
 529         this.items.each(function(f){
 530            Roo.applyIf(f, o);
 531         });
 532         return this;
 533     }
 534 });
 535
 536 // back compat
 537 Roo.BasicForm = Roo.form.BasicForm;