Form.js
上传用户:dawnssy
上传日期:2022-08-06
资源大小:9345k
文件大小:12k
源码类别:

JavaScript

开发平台:

JavaScript

  1. /*!
  2.  * Ext JS Library 3.1.0
  3.  * Copyright(c) 2006-2009 Ext JS, LLC
  4.  * licensing@extjs.com
  5.  * http://www.extjs.com/license
  6.  */
  7. /**
  8.  * @class Ext.form.FormPanel
  9.  * @extends Ext.Panel
  10.  * <p>Standard form container.</p>
  11.  *
  12.  * <p><b><u>Layout</u></b></p>
  13.  * <p>By default, FormPanel is configured with <tt>layout:'form'</tt> to use an {@link Ext.layout.FormLayout}
  14.  * layout manager, which styles and renders fields and labels correctly. When nesting additional Containers
  15.  * within a FormPanel, you should ensure that any descendant Containers which host input Fields use the
  16.  * {@link Ext.layout.FormLayout} layout manager.</p>
  17.  *
  18.  * <p><b><u>BasicForm</u></b></p>
  19.  * <p>Although <b>not listed</b> as configuration options of FormPanel, the FormPanel class accepts all
  20.  * of the config options required to configure its internal {@link Ext.form.BasicForm} for:
  21.  * <div class="mdetail-params"><ul>
  22.  * <li>{@link Ext.form.BasicForm#fileUpload file uploads}</li>
  23.  * <li>functionality for {@link Ext.form.BasicForm#doAction loading, validating and submitting} the form</li>
  24.  * </ul></div>
  25.  *
  26.  * <p><b>Note</b>: If subclassing FormPanel, any configuration options for the BasicForm must be applied to
  27.  * the <tt><b>initialConfig</b></tt> property of the FormPanel. Applying {@link Ext.form.BasicForm BasicForm}
  28.  * configuration settings to <b><tt>this</tt></b> will <b>not</b> affect the BasicForm's configuration.</p>
  29.  *
  30.  * <p><b><u>Form Validation</u></b></p>
  31.  * <p>For information on form validation see the following:</p>
  32.  * <div class="mdetail-params"><ul>
  33.  * <li>{@link Ext.form.TextField}</li>
  34.  * <li>{@link Ext.form.VTypes}</li>
  35.  * <li>{@link Ext.form.BasicForm#doAction BasicForm.doAction <b>clientValidation</b> notes}</li>
  36.  * <li><tt>{@link Ext.form.FormPanel#monitorValid monitorValid}</tt></li>
  37.  * </ul></div>
  38.  *
  39.  * <p><b><u>Form Submission</u></b></p>
  40.  * <p>By default, Ext Forms are submitted through Ajax, using {@link Ext.form.Action}. To enable normal browser
  41.  * submission of the {@link Ext.form.BasicForm BasicForm} contained in this FormPanel, see the
  42.  * <tt><b>{@link Ext.form.BasicForm#standardSubmit standardSubmit}</b></tt> option.</p>
  43.  *
  44.  * @constructor
  45.  * @param {Object} config Configuration options
  46.  * @xtype form
  47.  */
  48. Ext.FormPanel = Ext.extend(Ext.Panel, {
  49.     /**
  50.      * @cfg {String} formId (optional) The id of the FORM tag (defaults to an auto-generated id).
  51.      */
  52.     /**
  53.      * @cfg {Boolean} hideLabels
  54.      * <p><tt>true</tt> to hide field labels by default (sets <tt>display:none</tt>). Defaults to
  55.      * <tt>false</tt>.</p>
  56.      * <p>Also see {@link Ext.Component}.<tt>{@link Ext.Component#hideLabel hideLabel}</tt>.
  57.      */
  58.     /**
  59.      * @cfg {Number} labelPad
  60.      * The default padding in pixels for field labels (defaults to <tt>5</tt>). <tt>labelPad</tt> only
  61.      * applies if <tt>{@link #labelWidth}</tt> is also specified, otherwise it will be ignored.
  62.      */
  63.     /**
  64.      * @cfg {String} labelSeparator
  65.      * See {@link Ext.Component}.<tt>{@link Ext.Component#labelSeparator labelSeparator}</tt>
  66.      */
  67.     /**
  68.      * @cfg {Number} labelWidth The width of labels in pixels. This property cascades to child containers
  69.      * and can be overridden on any child container (e.g., a fieldset can specify a different <tt>labelWidth</tt>
  70.      * for its fields) (defaults to <tt>100</tt>).
  71.      */
  72.     /**
  73.      * @cfg {String} itemCls A css class to apply to the x-form-item of fields. This property cascades to child containers.
  74.      */
  75.     /**
  76.      * @cfg {Array} buttons
  77.      * An array of {@link Ext.Button}s or {@link Ext.Button} configs used to add buttons to the footer of this FormPanel.<br>
  78.      * <p>Buttons in the footer of a FormPanel may be configured with the option <tt>formBind: true</tt>. This causes
  79.      * the form's {@link #monitorValid valid state monitor task} to enable/disable those Buttons depending on
  80.      * the form's valid/invalid state.</p>
  81.      */
  82.     /**
  83.      * @cfg {Number} minButtonWidth Minimum width of all buttons in pixels (defaults to <tt>75</tt>).
  84.      */
  85.     minButtonWidth : 75,
  86.     /**
  87.      * @cfg {String} labelAlign The label alignment value used for the <tt>text-align</tt> specification
  88.      * for the <b>container</b>. Valid values are <tt>"left</tt>", <tt>"top"</tt> or <tt>"right"</tt>
  89.      * (defaults to <tt>"left"</tt>). This property cascades to child <b>containers</b> and can be
  90.      * overridden on any child <b>container</b> (e.g., a fieldset can specify a different <tt>labelAlign</tt>
  91.      * for its fields).
  92.      */
  93.     labelAlign : 'left',
  94.     /**
  95.      * @cfg {Boolean} monitorValid If <tt>true</tt>, the form monitors its valid state <b>client-side</b> and
  96.      * regularly fires the {@link #clientvalidation} event passing that state.<br>
  97.      * <p>When monitoring valid state, the FormPanel enables/disables any of its configured
  98.      * {@link #buttons} which have been configured with <code>formBind: true</code> depending
  99.      * on whether the {@link Ext.form.BasicForm#isValid form is valid} or not. Defaults to <tt>false</tt></p>
  100.      */
  101.     monitorValid : false,
  102.     /**
  103.      * @cfg {Number} monitorPoll The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)
  104.      */
  105.     monitorPoll : 200,
  106.     /**
  107.      * @cfg {String} layout Defaults to <tt>'form'</tt>.  Normally this configuration property should not be altered.
  108.      * For additional details see {@link Ext.layout.FormLayout} and {@link Ext.Container#layout Ext.Container.layout}.
  109.      */
  110.     layout : 'form',
  111.     // private
  112.     initComponent : function(){
  113.         this.form = this.createForm();
  114.         Ext.FormPanel.superclass.initComponent.call(this);
  115.         this.bodyCfg = {
  116.             tag: 'form',
  117.             cls: this.baseCls + '-body',
  118.             method : this.method || 'POST',
  119.             id : this.formId || Ext.id()
  120.         };
  121.         if(this.fileUpload) {
  122.             this.bodyCfg.enctype = 'multipart/form-data';
  123.         }
  124.         this.initItems();
  125.         this.addEvents(
  126.             /**
  127.              * @event clientvalidation
  128.              * If the monitorValid config option is true, this event fires repetitively to notify of valid state
  129.              * @param {Ext.form.FormPanel} this
  130.              * @param {Boolean} valid true if the form has passed client-side validation
  131.              */
  132.             'clientvalidation'
  133.         );
  134.         this.relayEvents(this.form, ['beforeaction', 'actionfailed', 'actioncomplete']);
  135.     },
  136.     // private
  137.     createForm : function(){
  138.         var config = Ext.applyIf({listeners: {}}, this.initialConfig);
  139.         return new Ext.form.BasicForm(null, config);
  140.     },
  141.     // private
  142.     initFields : function(){
  143.         var f = this.form;
  144.         var formPanel = this;
  145.         var fn = function(c){
  146.             if(formPanel.isField(c)){
  147.                 f.add(c);
  148.             }else if(c.findBy && c != formPanel){
  149.                 formPanel.applySettings(c);
  150.                 //each check required for check/radio groups.
  151.                 if(c.items && c.items.each){
  152.                     c.items.each(fn, this);
  153.                 }
  154.             }
  155.         };
  156.         this.items.each(fn, this);
  157.     },
  158.     // private
  159.     applySettings: function(c){
  160.         var ct = c.ownerCt;
  161.         Ext.applyIf(c, {
  162.             labelAlign: ct.labelAlign,
  163.             labelWidth: ct.labelWidth,
  164.             itemCls: ct.itemCls
  165.         });
  166.     },
  167.     // private
  168.     getLayoutTarget : function(){
  169.         return this.form.el;
  170.     },
  171.     /**
  172.      * Provides access to the {@link Ext.form.BasicForm Form} which this Panel contains.
  173.      * @return {Ext.form.BasicForm} The {@link Ext.form.BasicForm Form} which this Panel contains.
  174.      */
  175.     getForm : function(){
  176.         return this.form;
  177.     },
  178.     // private
  179.     onRender : function(ct, position){
  180.         this.initFields();
  181.         Ext.FormPanel.superclass.onRender.call(this, ct, position);
  182.         this.form.initEl(this.body);
  183.     },
  184.     // private
  185.     beforeDestroy : function(){
  186.         this.stopMonitoring();
  187.         /*
  188.          * Don't move this behaviour to BasicForm because it can be used
  189.          * on it's own.
  190.          */
  191.         Ext.destroy(this.form);
  192.         this.form.items.clear();
  193.         Ext.FormPanel.superclass.beforeDestroy.call(this);
  194.     },
  195.     // Determine if a Component is usable as a form Field.
  196.     isField : function(c) {
  197.         return !!c.setValue && !!c.getValue && !!c.markInvalid && !!c.clearInvalid;
  198.     },
  199.     // private
  200.     initEvents : function(){
  201.         Ext.FormPanel.superclass.initEvents.call(this);
  202.         // Listeners are required here to catch bubbling events from children.
  203.         this.on({
  204.             scope: this,
  205.             add: this.onAddEvent,
  206.             remove: this.onRemoveEvent
  207.         });
  208.         if(this.monitorValid){ // initialize after render
  209.             this.startMonitoring();
  210.         }
  211.     },
  212.     // private
  213.     onAdd: function(c){
  214.         Ext.FormPanel.superclass.onAdd.call(this, c);
  215.         this.processAdd(c);
  216.     },
  217.     // private
  218.     onAddEvent: function(ct, c){
  219.         if(ct !== this){
  220.             this.processAdd(c);
  221.         }
  222.     },
  223.     // private
  224.     processAdd : function(c){
  225.         // If a single form Field, add it
  226.         if(this.isField(c)){
  227.             this.form.add(c);
  228.         // If a Container, add any Fields it might contain
  229.         }else if(c.findBy){
  230.             this.applySettings(c);
  231.             this.form.add.apply(this.form, c.findBy(this.isField));
  232.         }
  233.     },
  234.     // private
  235.     onRemove: function(c){
  236.         Ext.FormPanel.superclass.onRemove.call(this, c);
  237.         this.processRemove(c);
  238.     },
  239.     onRemoveEvent: function(ct, c){
  240.         if(ct !== this){
  241.             this.processRemove(c);
  242.         }
  243.     },
  244.     // private
  245.     processRemove : function(c){
  246.         // If a single form Field, remove it
  247.         if(this.isField(c)){
  248.             this.form.remove(c);
  249.         // If a Container, its already destroyed by the time it gets here.  Remove any references to destroyed fields.
  250.         }else if(c.findBy){
  251.             var isDestroyed = function(o) {
  252.                 return !!o.isDestroyed;
  253.             }
  254.             this.form.items.filterBy(isDestroyed, this.form).each(this.form.remove, this.form);
  255.         }
  256.     },
  257.     /**
  258.      * Starts monitoring of the valid state of this form. Usually this is done by passing the config
  259.      * option "monitorValid"
  260.      */
  261.     startMonitoring : function(){
  262.         if(!this.validTask){
  263.             this.validTask = new Ext.util.TaskRunner();
  264.             this.validTask.start({
  265.                 run : this.bindHandler,
  266.                 interval : this.monitorPoll || 200,
  267.                 scope: this
  268.             });
  269.         }
  270.     },
  271.     /**
  272.      * Stops monitoring of the valid state of this form
  273.      */
  274.     stopMonitoring : function(){
  275.         if(this.validTask){
  276.             this.validTask.stopAll();
  277.             this.validTask = null;
  278.         }
  279.     },
  280.     /**
  281.      * This is a proxy for the underlying BasicForm's {@link Ext.form.BasicForm#load} call.
  282.      * @param {Object} options The options to pass to the action (see {@link Ext.form.BasicForm#doAction} for details)
  283.      */
  284.     load : function(){
  285.         this.form.load.apply(this.form, arguments);
  286.     },
  287.     // private
  288.     onDisable : function(){
  289.         Ext.FormPanel.superclass.onDisable.call(this);
  290.         if(this.form){
  291.             this.form.items.each(function(){
  292.                  this.disable();
  293.             });
  294.         }
  295.     },
  296.     // private
  297.     onEnable : function(){
  298.         Ext.FormPanel.superclass.onEnable.call(this);
  299.         if(this.form){
  300.             this.form.items.each(function(){
  301.                  this.enable();
  302.             });
  303.         }
  304.     },
  305.     // private
  306.     bindHandler : function(){
  307.         var valid = true;
  308.         this.form.items.each(function(f){
  309.             if(!f.isValid(true)){
  310.                 valid = false;
  311.                 return false;
  312.             }
  313.         });
  314.         if(this.fbar){
  315.             var fitems = this.fbar.items.items;
  316.             for(var i = 0, len = fitems.length; i < len; i++){
  317.                 var btn = fitems[i];
  318.                 if(btn.formBind === true && btn.disabled === valid){
  319.                     btn.setDisabled(!valid);
  320.                 }
  321.             }
  322.         }
  323.         this.fireEvent('clientvalidation', this, valid);
  324.     }
  325. });
  326. Ext.reg('form', Ext.FormPanel);
  327. Ext.form.FormPanel = Ext.FormPanel;