git.roojs.org Git - roojs1/blob - Roo/form/Form.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.Form
  14  * @extends Roo.form.BasicForm
  15  * Adds the ability to dynamically render forms with JavaScript to {@link Roo.form.BasicForm}.
  16  * @constructor
  17  * @param {Object} config Configuration options
  18  */
  19 Roo.form.Form = function(config){
  20     var xitems =  [];
  21     if (config.items) {
  22         xitems = config.items;
  23         delete config.items;
  24     }
  25
  26
  27     Roo.form.Form.superclass.constructor.call(this, null, config);
  28     this.url = this.url || this.action;
  29     if(!this.root){
  30         this.root = new Roo.form.Layout(Roo.applyIf({
  31             id: Roo.id()
  32         }, config));
  33     }
  34     this.active = this.root;
  35     /**
  36      * Array of all the buttons that have been added to this form via {@link addButton}
  37      * @type Array
  38      */
  39     this.buttons = [];
  40     this.allItems = [];
  41     this.addEvents({
  42         /**
  43          * @event clientvalidation
  44          * If the monitorValid config option is true, this event fires repetitively to notify of valid state
  45          * @param {Form} this
  46          * @param {Boolean} valid true if the form has passed client-side validation
  47          */
  48         clientvalidation: true,
  49         /**
  50          * @event rendered
  51          * Fires when the form is rendered
  52          * @param {Roo.form.Form} form
  53          */
  54         rendered : true
  55     });
  56
  57     Roo.each(xitems, this.addxtype, this);
  58
  59
  60
  61 };
  62
  63 Roo.extend(Roo.form.Form, Roo.form.BasicForm, {
  64     /**
  65      * @cfg {Number} labelWidth The width of labels. This property cascades to child containers.
  66      */
  67     /**
  68      * @cfg {String} itemCls A css class to apply to the x-form-item of fields. This property cascades to child containers.
  69      */
  70     /**
  71      * @cfg {String} buttonAlign Valid values are "left," "center" and "right" (defaults to "center")
  72      */
  73     buttonAlign:'center',
  74
  75     /**
  76      * @cfg {Number} minButtonWidth Minimum width of all buttons in pixels (defaults to 75)
  77      */
  78     minButtonWidth:75,
  79
  80     /**
  81      * @cfg {String} labelAlign Valid values are "left," "top" and "right" (defaults to "left").
  82      * This property cascades to child containers if not set.
  83      */
  84     labelAlign:'left',
  85
  86     /**
  87      * @cfg {Boolean} monitorValid If true the form monitors its valid state <b>client-side</b> and
  88      * fires a looping event with that state. This is required to bind buttons to the valid
  89      * state using the config value formBind:true on the button.
  90      */
  91     monitorValid : false,
  92
  93     /**
  94      * @cfg {Number} monitorPoll The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)
  95      */
  96     monitorPoll : 200,
  97
  98     /**
  99      * @cfg {String} progressUrl - Url to return progress data
 100      */
 101
 102     progressUrl : false,
 103
 104     /**
 105      * Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the
 106      * fields are added and the column is closed. If no fields are passed the column remains open
 107      * until end() is called.
 108      * @param {Object} config The config to pass to the column
 109      * @param {Field} field1 (optional)
 110      * @param {Field} field2 (optional)
 111      * @param {Field} etc (optional)
 112      * @return Column The column container object
 113      */
 114     column : function(c){
 115         var col = new Roo.form.Column(c);
 116         this.start(col);
 117         if(arguments.length > 1){ // duplicate code required because of Opera
 118             this.add.apply(this, Array.prototype.slice.call(arguments, 1));
 119             this.end();
 120         }
 121         return col;
 122     },
 123
 124     /**
 125      * Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the
 126      * fields are added and the fieldset is closed. If no fields are passed the fieldset remains open
 127      * until end() is called.
 128      * @param {Object} config The config to pass to the fieldset
 129      * @param {Field} field1 (optional)
 130      * @param {Field} field2 (optional)
 131      * @param {Field} etc (optional)
 132      * @return FieldSet The fieldset container object
 133      */
 134     fieldset : function(c){
 135         var fs = new Roo.form.FieldSet(c);
 136         this.start(fs);
 137         if(arguments.length > 1){ // duplicate code required because of Opera
 138             this.add.apply(this, Array.prototype.slice.call(arguments, 1));
 139             this.end();
 140         }
 141         return fs;
 142     },
 143
 144     /**
 145      * Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the
 146      * fields are added and the container is closed. If no fields are passed the container remains open
 147      * until end() is called.
 148      * @param {Object} config The config to pass to the Layout
 149      * @param {Field} field1 (optional)
 150      * @param {Field} field2 (optional)
 151      * @param {Field} etc (optional)
 152      * @return Layout The container object
 153      */
 154     container : function(c){
 155         var l = new Roo.form.Layout(c);
 156         this.start(l);
 157         if(arguments.length > 1){ // duplicate code required because of Opera
 158             this.add.apply(this, Array.prototype.slice.call(arguments, 1));
 159             this.end();
 160         }
 161         return l;
 162     },
 163
 164     /**
 165      * Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.
 166      * @param {Object} container A Roo.form.Layout or subclass of Layout
 167      * @return {Form} this
 168      */
 169     start : function(c){
 170         // cascade label info
 171         Roo.applyIf(c, {'labelAlign': this.active.labelAlign, 'labelWidth': this.active.labelWidth, 'itemCls': this.active.itemCls});
 172         this.active.stack.push(c);
 173         c.ownerCt = this.active;
 174         this.active = c;
 175         return this;
 176     },
 177
 178     /**
 179      * Closes the current open container
 180      * @return {Form} this
 181      */
 182     end : function(){
 183         if(this.active == this.root){
 184             return this;
 185         }
 186         this.active = this.active.ownerCt;
 187         return this;
 188     },
 189
 190     /**
 191      * Add Roo.form components to the current open container (e.g. column, fieldset, etc.).  Fields added via this method
 192      * can also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display
 193      * as the label of the field.
 194      * @param {Field} field1
 195      * @param {Field} field2 (optional)
 196      * @param {Field} etc. (optional)
 197      * @return {Form} this
 198      */
 199     add : function(){
 200         this.active.stack.push.apply(this.active.stack, arguments);
 201         this.allItems.push.apply(this.allItems,arguments);
 202         var r = [];
 203         for(var i = 0, a = arguments, len = a.length; i < len; i++) {
 204             if(a[i].isFormField){
 205                 r.push(a[i]);
 206             }
 207         }
 208         if(r.length > 0){
 209             Roo.form.Form.superclass.add.apply(this, r);
 210         }
 211         return this;
 212     },
 213
 214
 215
 216
 217
 218      /**
 219      * Find any element that has been added to a form, using it's ID or name
 220      * This can include framesets, columns etc. along with regular fields..
 221      * @param {String} id - id or name to find.
 222
 223      * @return {Element} e - or false if nothing found.
 224      */
 225     findbyId : function(id)
 226     {
 227         var ret = false;
 228         if (!id) {
 229             return ret;
 230         }
 231         Ext.each(this.allItems, function(f){
 232             if (f.id == id || f.name == id ){
 233                 ret = f;
 234                 return false;
 235             }
 236         });
 237         return ret;
 238     },
 239
 240
 241
 242     /**
 243      * Render this form into the passed container. This should only be called once!
 244      * @param {String/HTMLElement/Element} container The element this component should be rendered into
 245      * @return {Form} this
 246      */
 247     render : function(ct){
 248         ct = Roo.get(ct);
 249         var o = this.autoCreate || {
 250             tag: 'form',
 251             method : this.method || 'POST',
 252             id : this.id || Roo.id()
 253         };
 254         this.initEl(ct.createChild(o));
 255
 256         this.root.render(this.el);
 257
 258         if (this.progressUrl && !this.findField( 'UPLOAD_IDENTIFIER')) {
 259             // push a hidden field onto the list of fields..
 260             this.items.unshift(0, Roo.factory( {
 261                     xns: Roo.form,
 262                     xtype : 'Hidden',
 263                     name : 'UPLOAD_IDENTIFIER'
 264             }));
 265         }
 266
 267         this.items.each(function(f){
 268             f.render('x-form-el-'+f.id);
 269         });
 270
 271         if(this.buttons.length > 0){
 272             // tables are required to maintain order and for correct IE layout
 273             var tb = this.el.createChild({cls:'x-form-btns-ct', cn: {
 274                 cls:"x-form-btns x-form-btns-"+this.buttonAlign,
 275                 html:'<table cellspacing="0"><tbody><tr></tr></tbody></table><div class="x-clear"></div>'
 276             }}, null, true);
 277             var tr = tb.getElementsByTagName('tr')[0];
 278             for(var i = 0, len = this.buttons.length; i < len; i++) {
 279                 var b = this.buttons[i];
 280                 var td = document.createElement('td');
 281                 td.className = 'x-form-btn-td';
 282                 b.render(tr.appendChild(td));
 283             }
 284         }
 285         if(this.monitorValid){ // initialize after render
 286             this.startMonitoring();
 287         }
 288         this.fireEvent('rendered', this);
 289         return this;
 290     },
 291
 292     /**
 293      * Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.
 294      * @param {String/Object} config A string becomes the button text, an object can either be a Button config
 295      * object or a valid Roo.DomHelper element config
 296      * @param {Function} handler The function called when the button is clicked
 297      * @param {Object} scope (optional) The scope of the handler function
 298      * @return {Roo.Button}
 299      */
 300     addButton : function(config, handler, scope){
 301         var bc = {
 302             handler: handler,
 303             scope: scope,
 304             minWidth: this.minButtonWidth,
 305             hideParent:true
 306         };
 307         if(typeof config == "string"){
 308             bc.text = config;
 309         }else{
 310             Roo.apply(bc, config);
 311         }
 312         var btn = new Roo.Button(null, bc);
 313         this.buttons.push(btn);
 314         return btn;
 315     },
 316
 317      /**
 318      * Adds a series of form elements (using the xtype property as the factory method.
 319      * Valid xtypes are:  TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)
 320      * @param {Object} config
 321      */
 322
 323     addxtype : function()
 324     {
 325         var ar = Array.prototype.slice.call(arguments, 0);
 326         var ret = false;
 327         for(var i = 0; i < ar.length; i++) {
 328             if (!ar[i]) {
 329                 continue; // skip -- if this happends something invalid got sent, we
 330                 // should ignore it, as basically that interface element will not show up
 331                 // and that should be pretty obvious!!
 332             }
 333
 334             if (Roo.form[ar[i].xtype]) {
 335                 ar[i].form = this;
 336                 var fe = Roo.factory(ar[i], Roo.form);
 337                 if (!ret) {
 338                     ret = fe;
 339                 }
 340                 fe.form = this;
 341                 if (fe.store) {
 342                     fe.store.form = this;
 343                 }
 344                 if (fe.isLayout) {
 345
 346                     this.start(fe);
 347                     this.allItems.push(fe);
 348                     if (fe.items && fe.addxtype) {
 349                         fe.addxtype.apply(fe, fe.items);
 350                         delete fe.items;
 351                     }
 352                      this.end();
 353                     continue;
 354                 }
 355
 356
 357
 358                 this.add(fe);
 359               //  console.log('adding ' + ar[i].xtype);
 360             }
 361             if (ar[i].xtype == 'Button') {
 362                 //console.log('adding button');
 363                 //console.log(ar[i]);
 364                 this.addButton(ar[i]);
 365                 this.allItems.push(fe);
 366                 continue;
 367             }
 368
 369             if (ar[i].xtype == 'end') { // so we can add fieldsets... / layout etc.
 370                 alert('end is not supported on xtype any more, use items');
 371             //    this.end();
 372             //    //console.log('adding end');
 373             }
 374
 375         }
 376         return ret;
 377     },
 378
 379     /**
 380      * Starts monitoring of the valid state of this form. Usually this is done by passing the config
 381      * option "monitorValid"
 382      */
 383     startMonitoring : function(){
 384         if(!this.bound){
 385             this.bound = true;
 386             Roo.TaskMgr.start({
 387                 run : this.bindHandler,
 388                 interval : this.monitorPoll || 200,
 389                 scope: this
 390             });
 391         }
 392     },
 393
 394     /**
 395      * Stops monitoring of the valid state of this form
 396      */
 397     stopMonitoring : function(){
 398         this.bound = false;
 399     },
 400
 401     // private
 402     bindHandler : function(){
 403         if(!this.bound){
 404             return false; // stops binding
 405         }
 406         var valid = true;
 407         this.items.each(function(f){
 408             if(!f.isValid(true)){
 409                 valid = false;
 410                 return false;
 411             }
 412         });
 413         for(var i = 0, len = this.buttons.length; i < len; i++){
 414             var btn = this.buttons[i];
 415             if(btn.formBind === true && btn.disabled === valid){
 416                 btn.setDisabled(!valid);
 417             }
 418         }
 419         this.fireEvent('clientvalidation', this, valid);
 420     }
 421
 422
 423
 424
 425
 426
 427
 428
 429 });
 430
 431
 432 // back compat
 433 Roo.Form = Roo.form.Form;