/**
 * @class Ext.form.Basic
 * @extends Ext.util.Observable
 * 
Provides input field management, validation, submission, and form loading services for the collection
 * of {@link Ext.form.Field Field} instances within a {@link Ext.form.FormPanel}.
 * 
By default, Ext Forms are submitted through Ajax, using an instance of {@link Ext.form.action.Submit}.
 * To enable normal browser submission of an Ext Form, use the {@link #standardSubmit} config option.
 * 
Note: File uploads are not performed using normal 'Ajax' techniques; see the description for
 * {@link #hasUpload} for details.
 * @constructor
 * @param {Ext.container.Container} owner The component that is the container for the form, usually a {@link Ext.form.FormPanel}
 * @param {Object} config Configuration options. These are normally specified in the config to the
 * {@link Ext.form.FormPanel} constructor, which passes them along to the BasicForm automatically.
 */
Ext.define('Ext.form.Basic', {
    extend: 'Ext.util.Observable',
    alternateClassName: 'Ext.form.BasicForm',
    requires: ['Ext.util.MixedCollection', 'Ext.form.action.Load', 'Ext.form.action.Submit', 'Ext.window.MessageBoxWindow'],

    constructor: function(owner, config) {
        
/**
         * @property owner
         * @type Ext.container.Container
         * The container component to which this BasicForm is attached.
         */
        this.owner = owner;

        // Listen for addition/removal of fields in the owner container
        var onItemAddOrRemove = this.onItemAddOrRemove;
        this.mon(owner, {
            add: onItemAddOrRemove,
            remove: onItemAddOrRemove,
            scope: this
        });

        Ext.apply(this, config);

        // Normalize the paramOrder to an Array
        if (Ext.isString(this.paramOrder)) {
            this.paramOrder = this.paramOrder.split(/[\s,|]/);
        }

        this.addEvents(
            
/**
             * @event beforeaction
             * Fires before any action is performed. Return false to cancel the action.
             * @param {Ext.form.Basic} this
             * @param {Ext.form.action.Action} action The {@link Ext.form.action.Action} to be performed
             */
            'beforeaction',
            
/**
             * @event actionfailed
             * Fires when an action fails.
             * @param {Ext.form.Basic} this
             * @param {Ext.form.action.Action} action The {@link Ext.form.action.Action} that failed
             */
            'actionfailed',
            
/**
             * @event actioncomplete
             * Fires when an action is completed.
             * @param {Ext.form.Basic} this
             * @param {Ext.form.action.Action} action The {@link Ext.form.action.Action} that completed
             */
            'actioncomplete',
            
/**
             * @event validitychange
             * Fires when the validity of the entire form changes.
             * @param {Ext.form.Basic} this
             * @param {Boolean} valid true if the form is now valid, false if it is now invalid.
             */
            'validitychange',
            
/**
             * @event dirtychange
             * Fires when the dirty state of the entire form changes.
             * @param {Ext.form.Basic} this
             * @param {Boolean} dirty true if the form is now dirty, false if it is no longer dirty.
             */
            'dirtychange'
        );

        Ext.form.Basic.superclass.constructor.call(this);
    },

    
/**
     * @cfg {String} method
     * The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
     */
    
/**
     * @cfg {Ext.data.Reader} reader
     * An Ext.data.DataReader (e.g. {@link Ext.data.XmlReader}) to be used to read
     * data when executing 'load' actions. This is optional as there is built-in
     * support for processing JSON responses.
     */
    
/**
     * @cfg {Ext.data.Reader} errorReader
     * 
An Ext.data.DataReader (e.g. {@link Ext.data.XmlReader}) to be used to
     * read field error messages returned from 'submit' actions. This is optional
     * as there is built-in support for processing JSON responses.
     * 
The Records which provide messages for the invalid Fields must use the
     * Field name (or id) as the Record ID, and must contain a field called 'msg'
     * which contains the error message.
     * 
The errorReader does not have to be a full-blown implementation of a
     * Reader. It simply needs to implement a read(xhr) function
     * which returns an Array of Records in an object with the following
     * structure:

{
    records: recordArray
}

     */

    
/**
     * @cfg {String} url
     * The URL to use for form actions if one isn't supplied in the
     * {@link #doAction doAction} options.
     */

    
/**
     * @cfg {Object} baseParams
     * 
Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
     * 
Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.
     */

    
/**
     * @cfg {Number} timeout Timeout for form actions in seconds (default is 30 seconds).
     */
    timeout: 30,

    
/**
     * @cfg {Object} api (Optional) If specified, load and submit actions will be handled
     * with {@link Ext.form.DirectLoadAction} and {@link Ext.form.DirectSubmit}.
     * Methods which have been imported by {@link Ext.Direct} can be specified here to load and submit
     * forms.
     * Such as the following:

api: {
    load: App.ss.MyProfile.load,
    submit: App.ss.MyProfile.submit
}

     * 
Load actions can use {@link #paramOrder} or {@link #paramsAsHash}
     * to customize how the load method is invoked.
     * Submit actions will always use a standard form submit. The formHandler configuration must
     * be set on the associated server-side method which has been imported by {@link Ext.Direct}.
     */

    
/**
     * @cfg {Array/String} paramOrder 
A list of params to be executed server side.
     * Defaults to undefined. Only used for the {@link #api}
     * load configuration.
     * 
Specify the params in the order in which they must be executed on the
     * server-side as either (1) an Array of String values, or (2) a String of params
     * delimited by either whitespace, comma, or pipe. For example,
     * any of the following would be acceptable:

paramOrder: ['param1','param2','param3']
paramOrder: 'param1 param2 param3'
paramOrder: 'param1,param2,param3'
paramOrder: 'param1|param2|param'
     
     */

    
/**
     * @cfg {Boolean} paramsAsHash Only used for the {@link #api}
     * load configuration. If true, parameters will be sent as a
     * single hash collection of named arguments (defaults to false). Providing a
     * {@link #paramOrder} nullifies this configuration.
     */
    paramsAsHash: false,

    
/**
     * @cfg {String} waitTitle
     * The default title to show for the waiting message box (defaults to 'Please Wait...')
     */
    waitTitle: 'Please Wait...',

    
/**
     * @cfg {Boolean} trackResetOnLoad If set to true, {@link #reset}() resets to the last loaded
     * or {@link #setValues}() data instead of when the form was first created.  Defaults to false.
     */
    trackResetOnLoad: false,

    
/**
     * @cfg {Boolean} standardSubmit
     * 
If set to true, a standard HTML form submit is used instead
     * of a XHR (Ajax) style form submission. Defaults to false. All of
     * the field values, plus any additional params configured via {@link #baseParams}
     * and/or the options to {@link #submit}, will be included in the
     * values submitted in the form.
     */

    
/**
     * @cfg {Mixed} waitMsgTarget
     * By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
     * element by passing it or its id or mask the form itself by passing in true. Defaults to undefined.
     */


    // Private
    wasDirty: false,


    
/**
     * Destroys this object.
     */
    destroy: function() {
        this.clearListeners();
    },

    /**
     * @private
     * Handle addition or removal of descendant items. Invalidates the cached list of fields
     * so that {@link #getFields} will do a fresh query next time it is called. Also adds listeners
     * for state change events on added fields, and tracks components with formBind=true.
     */
    onItemAddOrRemove: function(parent, child) {
        var me = this,
            isAdding = !!child.ownerCt,
            isContainer = child.isContainer;

        function handleField(field) {
            // Listen for state change events on fields
            me[isAdding ? 'mon' : 'mun'](field, {
                validitychange: me.checkValidity,
                dirtychange: me.checkDirty,
                scope: me,
                buffer: 100 //batch up sequential calls to avoid excessive full-form validation
            });
            // Flush the cached list of fields
            delete me._fields;
        }

        if (child.isFormField) {
            handleField(child);
        }
        else if (isContainer) {
            // Walk down
            Ext.each(child.query('[isFormField]'), handleField);
        }

        // Flush the cached list of formBind components
        delete this._boundItems;
    },

    
/**
     * Return all the {@link Ext.form.Field} components in the owner container.
     * @return {Ext.util.MixedCollection} Collection of the Field objects
     */
    getFields: function() {
        var fields = this._fields;
        if (!fields) {
            fields = this._fields = new Ext.util.MixedCollection();
            fields.addAll(this.owner.query('[isFormField]'));
        }
        return fields;
    },

    getBoundItems: function() {
        var boundItems = this._boundItems;
        if (!boundItems) {
            boundItems = this._boundItems = new Ext.util.MixedCollection();
            boundItems.addAll(this.owner.query('[formBind]'));
        }
        return boundItems;
    },

    
/**
     * Returns true if client-side validation on the form is successful.
     * @return Boolean
     */
    isValid: function() {
        return !this.getFields().findBy(function(field) {
            var preventMark = field.preventMark,
                isValid;
            field.preventMark = true;
            isValid = field.isValid();
            field.preventMark = preventMark;
            return !isValid;
        });
    },

    
/**
     * Check whether the validity of the entire form has changed since it was last checked, and
     * if so fire the {@link #validitychange validitychange} event. This is automatically invoked
     * when an individual field's validity changes.
     */
    checkValidity: function() {
        var valid = this.isValid();
        if (valid !== this.wasValid) {
            this.onValidityChange(valid);
            this.fireEvent('validitychange', this, valid);
            this.wasValid = valid;
        }
    },

    /**
     * @private
     * Handle changes in the form's validity. If there are any sub components with
     * formBind=true then they are enabled/disabled based on the new validity.
     * @param {Boolean} valid
     */
    onValidityChange: function(valid) {
        var boundItems = this.getBoundItems();
        if (boundItems) {
            boundItems.each(function(cmp) {
                if (cmp.disabled === valid) {
                    cmp.setDisabled(!valid);
                }
            });
        }
    },

    
/**
     * 
Returns true if any fields in this form have changed from their original values.
     * 
Note that if this BasicForm was configured with {@link #trackResetOnLoad} then the
     * Fields' original values are updated when the values are loaded by {@link #setValues}
     * or {@link #loadRecord}.
     * @return Boolean
     */
    isDirty: function() {
        return !!this.getFields().findBy(function(f) {
            return f.isDirty();
        });
    },

    
/**
     * Check whether the dirty state of the entire form has changed since it was last checked, and
     * if so fire the {@link #dirtychange dirtychange} event. This is automatically invoked
     * when an individual field's dirty state changes.
     */
    checkDirty: function() {
        var dirty = this.isDirty();
        if (dirty !== this.wasDirty) {
            this.fireEvent('dirtychange', this, dirty);
            this.wasDirty = dirty;
        }
    },

    
/**
     * 
Returns true if the form contains a file upload field. This is used to determine the
     * method for submitting the form: File uploads are not performed using normal 'Ajax' techniques,
     * that is they are not performed using XMLHttpRequests. Instead a hidden <form>
     * element containing all the fields is created temporarily and submitted with its
     * target set to refer
     * to a dynamically generated, hidden <iframe> which is inserted into the document
     * but removed after the return data has been gathered.
     * 
The server response is parsed by the browser to create the document for the IFRAME. If the
     * server is using JSON to send the return object, then the
     * Content-Type header
     * must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.
     * 
Characters which are significant to an HTML parser must be sent as HTML entities, so encode
     * "<" as "&lt;", "&" as "&amp;" etc.
     * 
The response text is retrieved from the document, and a fake XMLHttpRequest object
     * is created containing a responseText property in order to conform to the
     * requirements of event handlers and callbacks.
     * 
Be aware that file upload packets are sent with the content type multipart/form
     * and some server technologies (notably JEE) may require some custom processing in order to
     * retrieve parameter names and parameter values from the packet content.
     * @return Boolean
     */
    hasUpload: function() {
        return !!this.getFields().findBy(function(f) {
            return f.inputType === 'file';
        });
    },

    
/**
     * Performs a predefined action (an implementation of {@link Ext.form.action.Action})
     * to perform application-specific processing.
     * @param {String/Ext.form.action.Action} action The name of the predefined action type,
     * or instance of {@link Ext.form.action.Action} to perform.
     * @param {Object} options (optional) The options to pass to the {@link Ext.form.action.Action}
     * that will get created, if the action argument is a String.
     * 
All of the config options listed below are supported by both the
     * {@link Ext.form.action.Submit submit} and {@link Ext.form.action.Load load}
     * actions unless otherwise noted (custom actions could also accept
     * other config options):

     *
     * 
url : String
The url for the action (defaults
     * to the form's {@link #url}.)
     *
     * 
method : String
The form method to use (defaults
     * to the form's method, or POST if not defined)
     *
     * 
params : String/Object
The params to pass
     * (defaults to the form's baseParams, or none if not defined)
     * 
Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.
     *
     * 
headers : Object
Request headers to set for the action.
     *
     * 
success : Function
The callback that will
     * be invoked after a successful response (see top of
     * {@link Ext.form.action.Submit submit} and {@link Ext.form.action.Load load}
     * for a description of what constitutes a successful response).
     * The function is passed the following parameters:

     * 
form : The {@link Ext.form.Basic} that requested the action.
     * 
action : The {@link Ext.form.action.Action Action} object which performed the operation.
     * 
The action object contains these properties of interest:

     * 
{@link Ext.form.action.Action#response response}
     * 
{@link Ext.form.action.Action#result result} : interrogate for custom postprocessing
     * 
{@link Ext.form.action.Action#type type}
     * 
     *
     * 
failure : Function
The callback that will be invoked after a
     * failed transaction attempt. The function is passed the following parameters:

     * 
form : The {@link Ext.form.Basic} that requested the action.
     * 
action : The {@link Ext.form.action.Action Action} object which performed the operation.
     * 
The action object contains these properties of interest:

     * 
{@link Ext.form.action.Action#failureType failureType}
     * 
{@link Ext.form.action.Action#response response}
     * 
{@link Ext.form.action.Action#result result} : interrogate for custom postprocessing
     * 
{@link Ext.form.action.Action#type type}
     * 
     *
     * 
scope : Object
The scope in which to call the
     * callback functions (The this reference for the callback functions).
     *
     * 
clientValidation : Boolean
Submit Action only.
     * Determines whether a Form's fields are validated in a final call to
     * {@link Ext.form.Basic#isValid isValid} prior to submission. Set to false
     * to prevent this. If undefined, pre-submission field validation is performed.
     *
     * @return {Ext.form.Basic} this
     */
    doAction: function(action, options) {
        if (Ext.isString(action)) {
            action = Ext.ClassManager.instantiateByAlias('formaction.' + action, Ext.apply({}, options, {form: this}));
        }
        if (this.fireEvent('beforeaction', this, action) !== false) {
            this.beforeAction(action);
            Ext.defer(action.run, 100, action);
        }
        return this;
    },

    
/**
     * Shortcut to {@link #doAction do} a {@link Ext.form.action.Submit submit action}. This will use the
     * {@link Ext.form.action.Submit AJAX submit action} by default. If the {@link #standardsubmit} config is
     * enabled it will use a standard form element to submit, or if the {@link #api} config is present it will
     * use the {@link Ext.form.DirectSubmit Ext.Direct submit action}.
     * @param {Object} options The options to pass to the action (see {@link #doAction} for details).

     * 
The following code:

myFormPanel.getForm().submit({
    clientValidation: true,
    url: 'updateConsignment.php',
    params: {
        newStatus: 'delivered'
    },
    success: function(form, action) {
       Ext.Msg.alert('Success', action.result.msg);
    },
    failure: function(form, action) {
        switch (action.failureType) {
            case Ext.form.action.Action.CLIENT_INVALID:
                Ext.Msg.alert('Failure', 'Form fields may not be submitted with invalid values');
                break;
            case Ext.form.action.Action.CONNECT_FAILURE:
                Ext.Msg.alert('Failure', 'Ajax communication failed');
                break;
            case Ext.form.action.Action.SERVER_INVALID:
               Ext.Msg.alert('Failure', action.result.msg);
       }
    }
});

     * would process the following server response for a successful submission:

{
    "success":true, // note this is Boolean, not string
    "msg":"Consignment updated"
}

     * and the following server response for a failed submission:

{
    "success":false, // note this is Boolean, not string
    "msg":"You do not have permission to perform this operation"
}

     * @return {Ext.form.Basic} this
     */
    submit: function(options) {
        return this.doAction(this.standardSubmit ? 'standardsubmit' : this.api ? 'directsubmit' : 'submit', options);
    },

    
/**
     * Shortcut to {@link #doAction do} a {@link Ext.form.action.Load load action}.
     * @param {Object} options The options to pass to the action (see {@link #doAction} for details)
     * @return {Ext.form.Basic} this
     */
    load: function(options) {
        return this.doAction(this.api ? 'directload' : 'load', options);
    },

    
/**
     * Persists the values in this form into the passed {@link Ext.data.Record} object in a beginEdit/endEdit block.
     * @param {Ext.data.Record} record The record to edit
     * @return {Ext.form.Basic} this
     */
    updateRecord: function(record) {
        //record.beginEdit();
        var fields = record.fields,
            values = this.getValues(),
            name,
            obj = {};
        fields.each(function(f) {
            name = f.name;
            if (name in values) {
                obj[name] = values[name];
            }
        });
        record.set(obj);
        //record.endEdit();
        return this;
    },

    
/**
     * Loads an {@link Ext.data.Record} into this form by calling {@link #setValues} with the
     * {@link Ext.data.Record#data record data}.
     * See also {@link #trackResetOnLoad}.
     * @param {Ext.data.Record} record The record to load
     * @return {Ext.form.Basic} this
     */
    loadRecord: function(record) {
        return this.setValues(record.data);
    },

    /**
     * @private
     * Called before an action is performed via {@link #doAction}.
     * @param {Ext.form.action.Action} action The Action instance that was invoked
     */
    beforeAction: function(action) {
        var waitMsg = action.waitMsg,
            maskCls = Ext.baseCSSPrefix + 'mask-loading',
            waitMsgTarget;

        // Call HtmlEditor's syncValue before actions
        this.getFields().each(function(f) {
            if (f.isFormField && f.syncValue) {
                f.syncValue();
            }
        });

        if (waitMsg) {
            waitMsgTarget = this.waitMsgTarget;
            if (waitMsgTarget === true) {
                this.owner.el.mask(waitMsg, maskCls);
            } else if (waitMsgTarget) {
                waitMsgTarget = this.waitMsgTarget = Ext.get(waitMsgTarget);
                waitMsgTarget.mask(waitMsg, maskCls);
            } else {
                Ext.MessageBox.wait(waitMsg, action.waitTitle || this.waitTitle);
            }
        }
    },

    /**
     * @private
     * Called after an action is performed via {@link #doAction}.
     * @param {Ext.form.action.Action} action The Action instance that was invoked
     * @param {Boolean} success True if the action completed successfully, false, otherwise.
     */
    afterAction: function(action, success) {
        if (action.waitMsg) {
            var MessageBox = Ext.MessageBox,
                waitMsgTarget = this.waitMsgTarget;
            if (waitMsgTarget === true) {
                this.owner.el.unmask();
            } else if (waitMsgTarget) {
                waitMsgTarget.unmask();
            } else {
                MessageBox.updateProgress(1);
                MessageBox.hide();
            }
        }
        if (success) {
            if (action.reset) {
                this.reset();
            }
            Ext.callback(action.success, action.scope || action, [this, action]);
            this.fireEvent('actioncomplete', this, action);
        } else {
            Ext.callback(action.failure, action.scope || action, [this, action]);
            this.fireEvent('actionfailed', this, action);
        }
    },


    
/**
     * Find a specific {@link Ext.form.Field} in this form by id or name.
     * @param {String} id The value to search for (specify either a {@link Ext.Component#id id} or
     * {@link Ext.form.Field#getName name or hiddenName}).
     * @return Ext.form.Field The first matching field, or null if none was found.
     */
    findField: function(id) {
        return this.getFields().findBy(function(f) {
            return f.id === id || f.getName() === id;
        });
    },


    
/**
     * Mark fields in this form invalid in bulk.
     * @param {Array/Object} errors Either an array in the form [{id:'fieldId', msg:'The message'}, ...]
     * or an object hash of {id: msg, id2: msg2}
     * @return {Ext.form.Basic} this
     */
    markInvalid: function(errors) {
        var me = this;

        function mark(fieldId, msg) {
            var field = me.findField(fieldId);
            if (field) {
                field.markInvalid(msg);
            }
        }

        if (Ext.isArray(errors)) {
            Ext.each(errors, function(err) {
                mark(err.id, err.msg);
            });
        } else {
            Ext.iterate(errors, mark);
        }
        return this;
    },

    
/**
     * Set values for fields in this form in bulk.
     * @param {Array/Object} values Either an array in the form:

[{id:'clientName', value:'Fred. Olsen Lines'},
 {id:'portOfLoading', value:'FXT'},
 {id:'portOfDischarge', value:'OSL'} ]
     * or an object hash of the form:

{
    clientName: 'Fred. Olsen Lines',
    portOfLoading: 'FXT',
    portOfDischarge: 'OSL'
}
     * @return {Ext.form.Basic} this
     */
    setValues: function(values) {
        var me = this;

        function setVal(fieldId, val) {
            var field = me.findField(fieldId);
            if (field) {
                field.setValue(val);
                if (me.trackResetOnLoad) {
                    field.originalValue = val;
                }
            }
        }

        if (Ext.isArray(values)) {
            // array of objects
            Ext.each(values, function(val) {
                setVal(val.id, val.value);
            });
        } else {
            // object hash
            Ext.iterate(values, setVal);
        }
        return this;
    },

    
/**
     * Retrieves the fields in the form as a set of key/value pairs, using their
     * {@link Ext.form.Field#getSubmitValue getSubmitValue()} method.
     * If multiple fields exist with the same name they are returned as an array.
     * @param {Boolean} asString (optional) If true, will return the key/value collection as a single
     * URL-encoded param string. Defaults to false.
     * @param {Boolean} dirtyOnly (optional) If true, only fields that are dirty will be included in the result.
     * Defaults to false.
     * @param {Boolean} includeEmptyText (optional) If true, the configured emptyText of empty fields will be used.
     * Defaults to false.
     * @return {String/Object}
     */
    getValues: function(asString, dirtyOnly, includeEmptyText) {
        var values = {};

        this.getFields().each(function(field) {
            if (!dirtyOnly || field.isDirty()) {
                var name = field.getName(),
                    val = field.getSubmitValue(),
                    bucket;
                if (val !== null) {
                    if (includeEmptyText && val === '') {
                        val = field.emptyText || '';
                    }
                    if (name in values) {
                        bucket = values[name];
                        if (!Ext.isArray(bucket)) {
                            bucket = values[name] = [bucket];
                        }
                        bucket.push(val);
                    } else {
                        values[name] = val;
                    }
                }
            }
        });

        if (asString) {
            values = Ext.urlEncode(values);
        }
        return values;
    },

    
/**
     * Clears all invalid field messages in this form.
     * @return {Ext.form.Basic} this
     */
    clearInvalid: function() {
        this.getFields().each(function(f) {
            f.clearInvalid();
        });
        return this;
    },

    
/**
     * Resets all fields in this form.
     * @return {Ext.form.Basic} this
     */
    reset: function() {
        this.getFields().each(function(f) {
            f.reset();
        });
        return this;
    },

    
/**
     * Calls {@link Ext#apply} for all fields in this form with the passed object.
     * @param {Object} obj The object to be applied
     * @return {Ext.form.Basic} this
     */
    applyToFields: function(obj) {
        this.getFields().each(function(f) {
            Ext.apply(f, obj);
        });
        return this;
    },

    
/**
     * Calls {@link Ext#applyIf} for all field in this form with the passed object.
     * @param {Object} obj The object to be applied
     * @return {Ext.form.Basic} this
     */
    applyIfToFields: function(obj) {
        this.getFields().each(function(f) {
            Ext.applyIf(f, obj);
        });
        return this;
    }
});