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     /**
  87      * @cfg {Object} baseParams
  88      * Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
  89      */
  90      /**
  91
  92     /**
  93      * @cfg {Number} timeout Timeout for form actions in seconds (default is 30 seconds).
  94      */
  95     timeout: 30,
  96
  97     // private
  98     activeAction : null,
  99
 100     /**
 101      * @cfg {Boolean} trackResetOnLoad If set to true, form.reset() resets to the last loaded
 102      * or setValues() data instead of when the form was first created.
 103      */
 104     trackResetOnLoad : false,
 105
 106
 107     /**
 108      * childForms - used for multi-tab forms
 109      * @type {Array}
 110      */
 111     childForms : false,
 112
 113     /**
 114      * allItems - full list of fields.
 115      * @type {Array}
 116      */
 117     allItems : false,
 118
 119     /**
 120      * By default wait messages are displayed with Roo.MessageBox.wait. You can target a specific
 121      * element by passing it or its id or mask the form itself by passing in true.
 122      * @type Mixed
 123      */
 124     waitMsgTarget : false,
 125
 126     // private
 127     initEl : function(el){
 128         this.el = Roo.get(el);
 129         this.id = this.el.id || Roo.id();
 130         this.el.on('submit', this.onSubmit, this);
 131         this.el.addClass('x-form');
 132     },
 133
 134     // private
 135     onSubmit : function(e){
 136         e.stopEvent();
 137     },
 138
 139     /**
 140      * Returns true if client-side validation on the form is successful.
 141      * @return Boolean
 142      */
 143     isValid : function(){
 144         var valid = true;
 145         this.items.each(function(f){
 146            if(!f.validate()){
 147                valid = false;
 148            }
 149         });
 150         return valid;
 151     },
 152
 153     /**
 154      * Returns true if any fields in this form have changed since their original load.
 155      * @return Boolean
 156      */
 157     isDirty : function(){
 158         var dirty = false;
 159         this.items.each(function(f){
 160            if(f.isDirty()){
 161                dirty = true;
 162                return false;
 163            }
 164         });
 165         return dirty;
 166     },
 167
 168     /**
 169      * Performs a predefined action (submit or load) or custom actions you define on this form.
 170      * @param {String} actionName The name of the action type
 171      * @param {Object} options (optional) The options to pass to the action.  All of the config options listed
 172      * below are supported by both the submit and load actions unless otherwise noted (custom actions could also
 173      * accept other config options):
 174      * <pre>
 175 Property          Type             Description
 176 ----------------  ---------------  ----------------------------------------------------------------------------------
 177 url               String           The url for the action (defaults to the form's url)
 178 method            String           The form method to use (defaults to the form's method, or POST if not defined)
 179 params            String/Object    The params to pass (defaults to the form's baseParams, or none if not defined)
 180 clientValidation  Boolean          Applies to submit only.  Pass true to call form.isValid() prior to posting to
 181                                    validate the form on the client (defaults to false)
 182      * </pre>
 183      * @return {BasicForm} this
 184      */
 185     doAction : function(action, options){
 186         if(typeof action == 'string'){
 187             action = new Roo.form.Action.ACTION_TYPES[action](this, options);
 188         }
 189         if(this.fireEvent('beforeaction', this, action) !== false){
 190             this.beforeAction(action);
 191             action.run.defer(100, action);
 192         }
 193         return this;
 194     },
 195
 196     /**
 197      * Shortcut to do a submit action.
 198      * @param {Object} options The options to pass to the action (see {@link #doAction} for details)
 199      * @return {BasicForm} this
 200      */
 201     submit : function(options){
 202         this.doAction('submit', options);
 203         return this;
 204     },
 205
 206     /**
 207      * Shortcut to do a load action.
 208      * @param {Object} options The options to pass to the action (see {@link #doAction} for details)
 209      * @return {BasicForm} this
 210      */
 211     load : function(options){
 212         this.doAction('load', options);
 213         return this;
 214     },
 215
 216     /**
 217      * Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.
 218      * @param {Record} record The record to edit
 219      * @return {BasicForm} this
 220      */
 221     updateRecord : function(record){
 222         record.beginEdit();
 223         var fs = record.fields;
 224         fs.each(function(f){
 225             var field = this.findField(f.name);
 226             if(field){
 227                 record.set(f.name, field.getValue());
 228             }
 229         }, this);
 230         record.endEdit();
 231         return this;
 232     },
 233
 234     /**
 235      * Loads an Roo.data.Record into this form.
 236      * @param {Record} record The record to load
 237      * @return {BasicForm} this
 238      */
 239     loadRecord : function(record){
 240         this.setValues(record.data);
 241         return this;
 242     },
 243
 244     // private
 245     beforeAction : function(action){
 246         var o = action.options;
 247
 248
 249         if(this.waitMsgTarget === true){
 250             this.el.mask(o.waitMsg || "Sending", 'x-mask-loading');
 251         }else if(this.waitMsgTarget){
 252             this.waitMsgTarget = Roo.get(this.waitMsgTarget);
 253             this.waitMsgTarget.mask(o.waitMsg || "Sending", 'x-mask-loading');
 254         }else {
 255             Roo.MessageBox.wait(o.waitMsg || "Sending", o.waitTitle || this.waitTitle || 'Please Wait...');
 256         }
 257
 258     },
 259
 260     // private
 261     afterAction : function(action, success){
 262         this.activeAction = null;
 263         var o = action.options;
 264
 265         if(this.waitMsgTarget === true){
 266             this.el.unmask();
 267         }else if(this.waitMsgTarget){
 268             this.waitMsgTarget.unmask();
 269         }else{
 270             Roo.MessageBox.updateProgress(1);
 271             Roo.MessageBox.hide();
 272         }
 273
 274         if(success){
 275             if(o.reset){
 276                 this.reset();
 277             }
 278             Roo.callback(o.success, o.scope, [this, action]);
 279             this.fireEvent('actioncomplete', this, action);
 280
 281         }else{
 282
 283             // failure condition..
 284
 285             Roo.callback(o.failure, o.scope, [this, action]);
 286             // show an error message if no failed handler is set..
 287             if (!this.hasListener('actionfailed')) {
 288                 Roo.MessageBox.alert("Error",
 289                     (typeof(action.result) != 'undefined' && typeof(action.result.errorMsg) != 'undefined') ?
 290                         action.result.errorMsg :
 291                         "Saving Failed, please check your entries"
 292                 );
 293             }
 294
 295             this.fireEvent('actionfailed', this, action);
 296         }
 297
 298     },
 299
 300     /**
 301      * Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName
 302      * @param {String} id The value to search for
 303      * @return Field
 304      */
 305     findField : function(id){
 306         var field = this.items.get(id);
 307         if(!field){
 308             this.items.each(function(f){
 309                 if(f.isFormField && (f.dataIndex == id || f.id == id || f.getName() == id)){
 310                     field = f;
 311                     return false;
 312                 }
 313             });
 314         }
 315         return field || null;
 316     },
 317
 318     /**
 319      * Add a secondary form to this one,
 320      * Used to provide tabbed forms. One form is primary, with hidden values
 321      * which mirror the elements from the other forms.
 322      *
 323      * @param {Roo.form.Form} form to add.
 324      *
 325      */
 326     addForm : function(form)
 327     {
 328
 329         if (this.childForms.indexOf(form) > -1) {
 330             // already added..
 331             return;
 332         }
 333         this.childForms.push(form);
 334         var n = '';
 335         Roo.each(form.allItems, function (fe) {
 336
 337             n = typeof(fe.getName) == 'undefined' ? fe.name : fe.getName();
 338             if (this.findField(n)) { // already added..
 339                 return;
 340             }
 341             var add = new Roo.form.Hidden({
 342                 name : n
 343             });
 344             add.render(this.el);
 345
 346             this.add( add );
 347         }, this);
 348
 349     },
 350     /**
 351      * Mark fields in this form invalid in bulk.
 352      * @param {Array/Object} errors Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}
 353      * @return {BasicForm} this
 354      */
 355     markInvalid : function(errors){
 356         if(errors instanceof Array){
 357             for(var i = 0, len = errors.length; i < len; i++){
 358                 var fieldError = errors[i];
 359                 var f = this.findField(fieldError.id);
 360                 if(f){
 361                     f.markInvalid(fieldError.msg);
 362                 }
 363             }
 364         }else{
 365             var field, id;
 366             for(id in errors){
 367                 if(typeof errors[id] != 'function' && (field = this.findField(id))){
 368                     field.markInvalid(errors[id]);
 369                 }
 370             }
 371         }
 372         Roo.each(this.childForms || [], function (f) {
 373             f.markInvalid(errors);
 374         });
 375
 376         return this;
 377     },
 378
 379     /**
 380      * Set values for fields in this form in bulk.
 381      * @param {Array/Object} values Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}
 382      * @return {BasicForm} this
 383      */
 384     setValues : function(values){
 385         if(values instanceof Array){ // array of objects
 386             for(var i = 0, len = values.length; i < len; i++){
 387                 var v = values[i];
 388                 var f = this.findField(v.id);
 389                 if(f){
 390                     f.setValue(v.value);
 391                     if(this.trackResetOnLoad){
 392                         f.originalValue = f.getValue();
 393                     }
 394                 }
 395             }
 396         }else{ // object hash
 397             var field, id;
 398             for(id in values){
 399                 if(typeof values[id] != 'function' && (field = this.findField(id))){
 400
 401                     if (field.setFromData &&
 402                         field.valueField &&
 403                         field.displayField &&
 404                         // combos' with local stores can
 405                         // be queried via setValue()
 406                         // to set their value..
 407                         (field.store && !field.store.isLocal)
 408                         ) {
 409                         // it's a combo
 410                         var sd = { };
 411                         sd[field.valueField] = typeof(values[field.hiddenName]) == 'undefined' ? '' : values[field.hiddenName];
 412                         sd[field.displayField] = typeof(values[field.name]) == 'undefined' ? '' : values[field.name];
 413                         field.setFromData(sd);
 414
 415                     } else {
 416                         field.setValue(values[id]);
 417                     }
 418
 419
 420                     if(this.trackResetOnLoad){
 421                         field.originalValue = field.getValue();
 422                     }
 423                 }
 424             }
 425         }
 426
 427         Roo.each(this.childForms || [], function (f) {
 428             f.setValues(values);
 429         });
 430
 431         return this;
 432     },
 433
 434     /**
 435      * Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name
 436      * they are returned as an array.
 437      * @param {Boolean} asString
 438      * @return {Object}
 439      */
 440     getValues : function(asString){
 441         if (this.childForms) {
 442             // copy values from the child forms
 443             Roo.each(this.childForms, function (f) {
 444                 this.setValues(f.getValues());
 445             }, this);
 446         }
 447
 448
 449
 450         var fs = Roo.lib.Ajax.serializeForm(this.el.dom);
 451         if(asString === true){
 452             return fs;
 453         }
 454         return Roo.urlDecode(fs);
 455     },
 456
 457     /**
 458      * Returns the fields in this form as an object with key/value pairs.
 459      * This differs from getValues as it calls getValue on each child item, rather than using dom data.
 460      * @return {Object}
 461      */
 462     getFieldValues : function(with_hidden)
 463     {
 464         if (this.childForms) {
 465             // copy values from the child forms
 466             // should this call getFieldValues - probably not as we do not currently copy
 467             // hidden fields when we generate..
 468             Roo.each(this.childForms, function (f) {
 469                 this.setValues(f.getValues());
 470             }, this);
 471         }
 472
 473         var ret = {};
 474         this.items.each(function(f){
 475             if (!f.getName()) {
 476                 return;
 477             }
 478             var v = f.getValue();
 479             // not sure if this supported any more..
 480             if ((typeof(v) == 'object') && f.getRawValue) {
 481                 v = f.getRawValue() ; // dates..
 482             }
 483             // combo boxes where name != hiddenName...
 484             if (f.name != f.getName()) {
 485                 ret[f.name] = f.getRawValue();
 486             }
 487             ret[f.getName()] = v;
 488         });
 489
 490         return ret;
 491     },
 492
 493     /**
 494      * Clears all invalid messages in this form.
 495      * @return {BasicForm} this
 496      */
 497     clearInvalid : function(){
 498         this.items.each(function(f){
 499            f.clearInvalid();
 500         });
 501
 502         Roo.each(this.childForms || [], function (f) {
 503             f.clearInvalid();
 504         });
 505
 506
 507         return this;
 508     },
 509
 510     /**
 511      * Resets this form.
 512      * @return {BasicForm} this
 513      */
 514     reset : function(){
 515         this.items.each(function(f){
 516             f.reset();
 517         });
 518
 519         Roo.each(this.childForms || [], function (f) {
 520             f.reset();
 521         });
 522
 523
 524         return this;
 525     },
 526
 527     /**
 528      * Add Roo.form components to this form.
 529      * @param {Field} field1
 530      * @param {Field} field2 (optional)
 531      * @param {Field} etc (optional)
 532      * @return {BasicForm} this
 533      */
 534     add : function(){
 535         this.items.addAll(Array.prototype.slice.call(arguments, 0));
 536         return this;
 537     },
 538
 539
 540     /**
 541      * Removes a field from the items collection (does NOT remove its markup).
 542      * @param {Field} field
 543      * @return {BasicForm} this
 544      */
 545     remove : function(field){
 546         this.items.remove(field);
 547         return this;
 548     },
 549
 550     /**
 551      * Looks at the fields in this form, checks them for an id attribute,
 552      * and calls applyTo on the existing dom element with that id.
 553      * @return {BasicForm} this
 554      */
 555     render : function(){
 556         this.items.each(function(f){
 557             if(f.isFormField && !f.rendered && document.getElementById(f.id)){ // if the element exists
 558                 f.applyTo(f.id);
 559             }
 560         });
 561         return this;
 562     },
 563
 564     /**
 565      * Calls {@link Ext#apply} for all fields in this form with the passed object.
 566      * @param {Object} values
 567      * @return {BasicForm} this
 568      */
 569     applyToFields : function(o){
 570         this.items.each(function(f){
 571            Roo.apply(f, o);
 572         });
 573         return this;
 574     },
 575
 576     /**
 577      * Calls {@link Ext#applyIf} for all field in this form with the passed object.
 578      * @param {Object} values
 579      * @return {BasicForm} this
 580      */
 581     applyIfToFields : function(o){
 582         this.items.each(function(f){
 583            Roo.applyIf(f, o);
 584         });
 585         return this;
 586     }
 587 });
 588
 589 // back compat
 590 Roo.BasicForm = Roo.form.BasicForm;