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