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             // we have a scenario where updates need confirming.
 285             // eg. if a locking scenario exists..
 286             // we look for { errors : { needs_confirm : true }} in the response.
 287             if (typeof(action.result.errors.needs_confirm) != 'undefined') {
 288                 var _t = this;
 289                 Roo.MessageBox.confirm(
 290                     "Change requires confirmation",
 291                     action.result.errorMsg,
 292                     function(r) {
 293                         _t.doAction('submit', { params :  { _submit_confirmed : 1 } }  );
 294                     }
 295
 296                 );
 297
 298
 299
 300                 return;
 301             }
 302
 303             Roo.callback(o.failure, o.scope, [this, action]);
 304             // show an error message if no failed handler is set..
 305             if (!this.hasListener('actionfailed')) {
 306                 Roo.MessageBox.alert("Error",
 307                     (typeof(action.result) != 'undefined' && typeof(action.result.errorMsg) != 'undefined') ?
 308                         action.result.errorMsg :
 309                         "Saving Failed, please check your entries"
 310                 );
 311             }
 312
 313             this.fireEvent('actionfailed', this, action);
 314         }
 315
 316     },
 317
 318     /**
 319      * Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName
 320      * @param {String} id The value to search for
 321      * @return Field
 322      */
 323     findField : function(id){
 324         var field = this.items.get(id);
 325         if(!field){
 326             this.items.each(function(f){
 327                 if(f.isFormField && (f.dataIndex == id || f.id == id || f.getName() == id)){
 328                     field = f;
 329                     return false;
 330                 }
 331             });
 332         }
 333         return field || null;
 334     },
 335
 336     /**
 337      * Add a secondary form to this one,
 338      * Used to provide tabbed forms. One form is primary, with hidden values
 339      * which mirror the elements from the other forms.
 340      *
 341      * @param {Roo.form.Form} form to add.
 342      *
 343      */
 344     addForm : function(form)
 345     {
 346
 347         if (this.childForms.indexOf(form) > -1) {
 348             // already added..
 349             return;
 350         }
 351         this.childForms.push(form);
 352         var n = '';
 353         Roo.each(form.allItems, function (fe) {
 354
 355             n = typeof(fe.getName) == 'undefined' ? fe.name : fe.getName();
 356             if (this.findField(n)) { // already added..
 357                 return;
 358             }
 359             var add = new Roo.form.Hidden({
 360                 name : n
 361             });
 362             add.render(this.el);
 363
 364             this.add( add );
 365         }, this);
 366
 367     },
 368     /**
 369      * Mark fields in this form invalid in bulk.
 370      * @param {Array/Object} errors Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}
 371      * @return {BasicForm} this
 372      */
 373     markInvalid : function(errors){
 374         if(errors instanceof Array){
 375             for(var i = 0, len = errors.length; i < len; i++){
 376                 var fieldError = errors[i];
 377                 var f = this.findField(fieldError.id);
 378                 if(f){
 379                     f.markInvalid(fieldError.msg);
 380                 }
 381             }
 382         }else{
 383             var field, id;
 384             for(id in errors){
 385                 if(typeof errors[id] != 'function' && (field = this.findField(id))){
 386                     field.markInvalid(errors[id]);
 387                 }
 388             }
 389         }
 390         Roo.each(this.childForms || [], function (f) {
 391             f.markInvalid(errors);
 392         });
 393
 394         return this;
 395     },
 396
 397     /**
 398      * Set values for fields in this form in bulk.
 399      * @param {Array/Object} values Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}
 400      * @return {BasicForm} this
 401      */
 402     setValues : function(values){
 403         if(values instanceof Array){ // array of objects
 404             for(var i = 0, len = values.length; i < len; i++){
 405                 var v = values[i];
 406                 var f = this.findField(v.id);
 407                 if(f){
 408                     f.setValue(v.value);
 409                     if(this.trackResetOnLoad){
 410                         f.originalValue = f.getValue();
 411                     }
 412                 }
 413             }
 414         }else{ // object hash
 415             var field, id;
 416             for(id in values){
 417                 if(typeof values[id] != 'function' && (field = this.findField(id))){
 418
 419                     if (field.setFromData &&
 420                         field.valueField &&
 421                         field.displayField &&
 422                         // combos' with local stores can
 423                         // be queried via setValue()
 424                         // to set their value..
 425                         (field.store && !field.store.isLocal)
 426                         ) {
 427                         // it's a combo
 428                         var sd = { };
 429                         sd[field.valueField] = typeof(values[field.hiddenName]) == 'undefined' ? '' : values[field.hiddenName];
 430                         sd[field.displayField] = typeof(values[field.name]) == 'undefined' ? '' : values[field.name];
 431                         field.setFromData(sd);
 432
 433                     } else {
 434                         field.setValue(values[id]);
 435                     }
 436
 437
 438                     if(this.trackResetOnLoad){
 439                         field.originalValue = field.getValue();
 440                     }
 441                 }
 442             }
 443         }
 444
 445         Roo.each(this.childForms || [], function (f) {
 446             f.setValues(values);
 447         });
 448
 449         return this;
 450     },
 451
 452     /**
 453      * Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name
 454      * they are returned as an array.
 455      * @param {Boolean} asString
 456      * @return {Object}
 457      */
 458     getValues : function(asString){
 459         if (this.childForms) {
 460             // copy values from the child forms
 461             Roo.each(this.childForms, function (f) {
 462                 this.setValues(f.getValues());
 463             }, this);
 464         }
 465
 466
 467
 468         var fs = Roo.lib.Ajax.serializeForm(this.el.dom);
 469         if(asString === true){
 470             return fs;
 471         }
 472         return Roo.urlDecode(fs);
 473     },
 474
 475     /**
 476      * Returns the fields in this form as an object with key/value pairs.
 477      * This differs from getValues as it calls getValue on each child item, rather than using dom data.
 478      * @return {Object}
 479      */
 480     getFieldValues : function(with_hidden)
 481     {
 482         if (this.childForms) {
 483             // copy values from the child forms
 484             // should this call getFieldValues - probably not as we do not currently copy
 485             // hidden fields when we generate..
 486             Roo.each(this.childForms, function (f) {
 487                 this.setValues(f.getValues());
 488             }, this);
 489         }
 490
 491         var ret = {};
 492         this.items.each(function(f){
 493             if (!f.getName()) {
 494                 return;
 495             }
 496             var v = f.getValue();
 497             // not sure if this supported any more..
 498             if ((typeof(v) == 'object') && f.getRawValue) {
 499                 v = f.getRawValue() ; // dates..
 500             }
 501             // combo boxes where name != hiddenName...
 502             if (f.name != f.getName()) {
 503                 ret[f.name] = f.getRawValue();
 504             }
 505             ret[f.getName()] = v;
 506         });
 507
 508         return ret;
 509     },
 510
 511     /**
 512      * Clears all invalid messages in this form.
 513      * @return {BasicForm} this
 514      */
 515     clearInvalid : function(){
 516         this.items.each(function(f){
 517            f.clearInvalid();
 518         });
 519
 520         Roo.each(this.childForms || [], function (f) {
 521             f.clearInvalid();
 522         });
 523
 524
 525         return this;
 526     },
 527
 528     /**
 529      * Resets this form.
 530      * @return {BasicForm} this
 531      */
 532     reset : function(){
 533         this.items.each(function(f){
 534             f.reset();
 535         });
 536
 537         Roo.each(this.childForms || [], function (f) {
 538             f.reset();
 539         });
 540
 541
 542         return this;
 543     },
 544
 545     /**
 546      * Add Roo.form components to this form.
 547      * @param {Field} field1
 548      * @param {Field} field2 (optional)
 549      * @param {Field} etc (optional)
 550      * @return {BasicForm} this
 551      */
 552     add : function(){
 553         this.items.addAll(Array.prototype.slice.call(arguments, 0));
 554         return this;
 555     },
 556
 557
 558     /**
 559      * Removes a field from the items collection (does NOT remove its markup).
 560      * @param {Field} field
 561      * @return {BasicForm} this
 562      */
 563     remove : function(field){
 564         this.items.remove(field);
 565         return this;
 566     },
 567
 568     /**
 569      * Looks at the fields in this form, checks them for an id attribute,
 570      * and calls applyTo on the existing dom element with that id.
 571      * @return {BasicForm} this
 572      */
 573     render : function(){
 574         this.items.each(function(f){
 575             if(f.isFormField && !f.rendered && document.getElementById(f.id)){ // if the element exists
 576                 f.applyTo(f.id);
 577             }
 578         });
 579         return this;
 580     },
 581
 582     /**
 583      * Calls {@link Ext#apply} for all fields in this form with the passed object.
 584      * @param {Object} values
 585      * @return {BasicForm} this
 586      */
 587     applyToFields : function(o){
 588         this.items.each(function(f){
 589            Roo.apply(f, o);
 590         });
 591         return this;
 592     },
 593
 594     /**
 595      * Calls {@link Ext#applyIf} for all field in this form with the passed object.
 596      * @param {Object} values
 597      * @return {BasicForm} this
 598      */
 599     applyIfToFields : function(o){
 600         this.items.each(function(f){
 601            Roo.applyIf(f, o);
 602         });
 603         return this;
 604     }
 605 });
 606
 607 // back compat
 608 Roo.BasicForm = Roo.form.BasicForm;