bos@574: /*
bos@574:  * jQuery Form Plugin
bos@574:  * @requires jQuery v1.1 or later
bos@574:  *
bos@574:  * Examples at: http://malsup.com/jquery/form/
bos@574:  * Dual licensed under the MIT and GPL licenses:
bos@574:  *   http://www.opensource.org/licenses/mit-license.php
bos@574:  *   http://www.gnu.org/licenses/gpl.html
bos@574:  *
bos@574:  * Revision: $Id$
bos@574:  */
bos@574:  (function($) {
bos@574: /**
bos@574:  * ajaxSubmit() provides a mechanism for submitting an HTML form using AJAX.
bos@574:  *
bos@574:  * ajaxSubmit accepts a single argument which can be either a success callback function
bos@574:  * or an options Object.  If a function is provided it will be invoked upon successful
bos@574:  * completion of the submit and will be passed the response from the server.
bos@574:  * If an options Object is provided, the following attributes are supported:
bos@574:  *
bos@574:  *  target:   Identifies the element(s) in the page to be updated with the server response.
bos@574:  *            This value may be specified as a jQuery selection string, a jQuery object,
bos@574:  *            or a DOM element.
bos@574:  *            default value: null
bos@574:  *
bos@574:  *  url:      URL to which the form data will be submitted.
bos@574:  *            default value: value of form's 'action' attribute
bos@574:  *
bos@574:  *  type:     The method in which the form data should be submitted, 'GET' or 'POST'.
bos@574:  *            default value: value of form's 'method' attribute (or 'GET' if none found)
bos@574:  *
bos@574:  *  data:     Additional data to add to the request, specified as key/value pairs (see $.ajax).
bos@574:  *
bos@574:  *  beforeSubmit:  Callback method to be invoked before the form is submitted.
bos@574:  *            default value: null
bos@574:  *
bos@574:  *  success:  Callback method to be invoked after the form has been successfully submitted
bos@574:  *            and the response has been returned from the server
bos@574:  *            default value: null
bos@574:  *
bos@574:  *  dataType: Expected dataType of the response.  One of: null, 'xml', 'script', or 'json'
bos@574:  *            default value: null
bos@574:  *
bos@574:  *  semantic: Boolean flag indicating whether data must be submitted in semantic order (slower).
bos@574:  *            default value: false
bos@574:  *
bos@574:  *  resetForm: Boolean flag indicating whether the form should be reset if the submit is successful
bos@574:  *
bos@574:  *  clearForm: Boolean flag indicating whether the form should be cleared if the submit is successful
bos@574:  *
bos@574:  *
bos@574:  * The 'beforeSubmit' callback can be provided as a hook for running pre-submit logic or for
bos@574:  * validating the form data.  If the 'beforeSubmit' callback returns false then the form will
bos@574:  * not be submitted. The 'beforeSubmit' callback is invoked with three arguments: the form data
bos@574:  * in array format, the jQuery object, and the options object passed into ajaxSubmit.
bos@574:  * The form data array takes the following form:
bos@574:  *
bos@574:  *     [ { name: 'username', value: 'jresig' }, { name: 'password', value: 'secret' } ]
bos@574:  *
bos@574:  * If a 'success' callback method is provided it is invoked after the response has been returned
bos@574:  * from the server.  It is passed the responseText or responseXML value (depending on dataType).
bos@574:  * See jQuery.ajax for further details.
bos@574:  *
bos@574:  *
bos@574:  * The dataType option provides a means for specifying how the server response should be handled.
bos@574:  * This maps directly to the jQuery.httpData method.  The following values are supported:
bos@574:  *
bos@574:  *      'xml':    if dataType == 'xml' the server response is treated as XML and the 'success'
bos@574:  *                   callback method, if specified, will be passed the responseXML value
bos@574:  *      'json':   if dataType == 'json' the server response will be evaluted and passed to
bos@574:  *                   the 'success' callback, if specified
bos@574:  *      'script': if dataType == 'script' the server response is evaluated in the global context
bos@574:  *
bos@574:  *
bos@574:  * Note that it does not make sense to use both the 'target' and 'dataType' options.  If both
bos@574:  * are provided the target will be ignored.
bos@574:  *
bos@574:  * The semantic argument can be used to force form serialization in semantic order.
bos@574:  * This is normally true anyway, unless the form contains input elements of type='image'.
bos@574:  * If your form must be submitted with name/value pairs in semantic order and your form
bos@574:  * contains an input of type='image" then pass true for this arg, otherwise pass false
bos@574:  * (or nothing) to avoid the overhead for this logic.
bos@574:  *
bos@574:  *
bos@574:  * When used on its own, ajaxSubmit() is typically bound to a form's submit event like this:
bos@574:  *
bos@574:  * $("#form-id").submit(function() {
bos@574:  *     $(this).ajaxSubmit(options);
bos@574:  *     return false; // cancel conventional submit
bos@574:  * });
bos@574:  *
bos@574:  * When using ajaxForm(), however, this is done for you.
bos@574:  *
bos@574:  * @example
bos@574:  * $('#myForm').ajaxSubmit(function(data) {
bos@574:  *     alert('Form submit succeeded! Server returned: ' + data);
bos@574:  * });
bos@574:  * @desc Submit form and alert server response
bos@574:  *
bos@574:  *
bos@574:  * @example
bos@574:  * var options = {
bos@574:  *     target: '#myTargetDiv'
bos@574:  * };
bos@574:  * $('#myForm').ajaxSubmit(options);
bos@574:  * @desc Submit form and update page element with server response
bos@574:  *
bos@574:  *
bos@574:  * @example
bos@574:  * var options = {
bos@574:  *     success: function(responseText) {
bos@574:  *         alert(responseText);
bos@574:  *     }
bos@574:  * };
bos@574:  * $('#myForm').ajaxSubmit(options);
bos@574:  * @desc Submit form and alert the server response
bos@574:  *
bos@574:  *
bos@574:  * @example
bos@574:  * var options = {
bos@574:  *     beforeSubmit: function(formArray, jqForm) {
bos@574:  *         if (formArray.length == 0) {
bos@574:  *             alert('Please enter data.');
bos@574:  *             return false;
bos@574:  *         }
bos@574:  *     }
bos@574:  * };
bos@574:  * $('#myForm').ajaxSubmit(options);
bos@574:  * @desc Pre-submit validation which aborts the submit operation if form data is empty
bos@574:  *
bos@574:  *
bos@574:  * @example
bos@574:  * var options = {
bos@574:  *     url: myJsonUrl.php,
bos@574:  *     dataType: 'json',
bos@574:  *     success: function(data) {
bos@574:  *        // 'data' is an object representing the the evaluated json data
bos@574:  *     }
bos@574:  * };
bos@574:  * $('#myForm').ajaxSubmit(options);
bos@574:  * @desc json data returned and evaluated
bos@574:  *
bos@574:  *
bos@574:  * @example
bos@574:  * var options = {
bos@574:  *     url: myXmlUrl.php,
bos@574:  *     dataType: 'xml',
bos@574:  *     success: function(responseXML) {
bos@574:  *        // responseXML is XML document object
bos@574:  *        var data = $('myElement', responseXML).text();
bos@574:  *     }
bos@574:  * };
bos@574:  * $('#myForm').ajaxSubmit(options);
bos@574:  * @desc XML data returned from server
bos@574:  *
bos@574:  *
bos@574:  * @example
bos@574:  * var options = {
bos@574:  *     resetForm: true
bos@574:  * };
bos@574:  * $('#myForm').ajaxSubmit(options);
bos@574:  * @desc submit form and reset it if successful
bos@574:  *
bos@574:  * @example
bos@574:  * $('#myForm).submit(function() {
bos@574:  *    $(this).ajaxSubmit();
bos@574:  *    return false;
bos@574:  * });
bos@574:  * @desc Bind form's submit event to use ajaxSubmit
bos@574:  *
bos@574:  *
bos@574:  * @name ajaxSubmit
bos@574:  * @type jQuery
bos@574:  * @param options  object literal containing options which control the form submission process
bos@574:  * @cat Plugins/Form
bos@574:  * @return jQuery
bos@574:  */
bos@574: $.fn.ajaxSubmit = function(options) {
bos@574:     if (typeof options == 'function')
bos@574:         options = { success: options };
bos@574: 
bos@574:     options = $.extend({
bos@574:         url:  this.attr('action') || window.location,
bos@574:         type: this.attr('method') || 'GET'
bos@574:     }, options || {});
bos@574: 
bos@574:     // hook for manipulating the form data before it is extracted;
bos@574:     // convenient for use with rich editors like tinyMCE or FCKEditor
bos@574:     var veto = {};
bos@574:     $.event.trigger('form.pre.serialize', [this, options, veto]);
bos@574:     if (veto.veto) return this;
bos@574: 
bos@574:     var a = this.formToArray(options.semantic);
bos@574: 	if (options.data) {
bos@574: 	    for (var n in options.data)
bos@574: 	        a.push( { name: n, value: options.data[n] } );
bos@574: 	}
bos@574: 
bos@574:     // give pre-submit callback an opportunity to abort the submit
bos@574:     if (options.beforeSubmit && options.beforeSubmit(a, this, options) === false) return this;
bos@574: 
bos@574:     // fire vetoable 'validate' event
bos@574:     $.event.trigger('form.submit.validate', [a, this, options, veto]);
bos@574:     if (veto.veto) return this;
bos@574: 
bos@574:     var q = $.param(a);//.replace(/%20/g,'+');
bos@574: 
bos@574:     if (options.type.toUpperCase() == 'GET') {
bos@574:         options.url += (options.url.indexOf('?') >= 0 ? '&' : '?') + q;
bos@574:         options.data = null;  // data is null for 'get'
bos@574:     }
bos@574:     else
bos@574:         options.data = q; // data is the query string for 'post'
bos@574: 
bos@574:     var $form = this, callbacks = [];
bos@574:     if (options.resetForm) callbacks.push(function() { $form.resetForm(); });
bos@574:     if (options.clearForm) callbacks.push(function() { $form.clearForm(); });
bos@574: 
bos@574:     // perform a load on the target only if dataType is not provided
bos@574:     if (!options.dataType && options.target) {
bos@574:         var oldSuccess = options.success || function(){};
bos@574:         callbacks.push(function(data) {
bos@574:             if (this.evalScripts)
bos@574:                 $(options.target).attr("innerHTML", data).evalScripts().each(oldSuccess, arguments);
bos@574:             else // jQuery v1.1.4
bos@574:                 $(options.target).html(data).each(oldSuccess, arguments);
bos@574:         });
bos@574:     }
bos@574:     else if (options.success)
bos@574:         callbacks.push(options.success);
bos@574: 
bos@574:     options.success = function(data, status) {
bos@574:         for (var i=0, max=callbacks.length; i < max; i++)
bos@574:             callbacks[i](data, status, $form);
bos@574:     };
bos@574: 
bos@574:     // are there files to upload?
bos@574:     var files = $('input:file', this).fieldValue();
bos@574:     var found = false;
bos@574:     for (var j=0; j < files.length; j++)
bos@574:         if (files[j])
bos@574:             found = true;
bos@574: 
bos@574:     if (options.iframe || found) // options.iframe allows user to force iframe mode
bos@574:         fileUpload();
bos@574:     else
bos@574:         $.ajax(options);
bos@574: 
bos@574:     // fire 'notify' event
bos@574:     $.event.trigger('form.submit.notify', [this, options]);
bos@574:     return this;
bos@574: 
bos@574: 
bos@574:     // private function for handling file uploads (hat tip to YAHOO!)
bos@574:     function fileUpload() {
bos@574:         var form = $form[0];
bos@574:         var opts = $.extend({}, $.ajaxSettings, options);
bos@574: 
bos@574:         var id = 'jqFormIO' + $.fn.ajaxSubmit.counter++;
bos@574:         var $io = $('<iframe id="' + id + '" name="' + id + '" />');
bos@574:         var io = $io[0];
bos@574:         var op8 = $.browser.opera && window.opera.version() < 9;
bos@574:         if ($.browser.msie || op8) io.src = 'javascript:false;document.write("");';
bos@574:         $io.css({ position: 'absolute', top: '-1000px', left: '-1000px' });
bos@574: 
bos@574:         var xhr = { // mock object
bos@574:             responseText: null,
bos@574:             responseXML: null,
bos@574:             status: 0,
bos@574:             statusText: 'n/a',
bos@574:             getAllResponseHeaders: function() {},
bos@574:             getResponseHeader: function() {},
bos@574:             setRequestHeader: function() {}
bos@574:         };
bos@574: 
bos@574:         var g = opts.global;
bos@574:         // trigger ajax global events so that activity/block indicators work like normal
bos@574:         if (g && ! $.active++) $.event.trigger("ajaxStart");
bos@574:         if (g) $.event.trigger("ajaxSend", [xhr, opts]);
bos@574: 
bos@574:         var cbInvoked = 0;
bos@574:         var timedOut = 0;
bos@574: 
bos@574:         // take a breath so that pending repaints get some cpu time before the upload starts
bos@574:         setTimeout(function() {
bos@574:             $io.appendTo('body');
bos@574:             // jQuery's event binding doesn't work for iframe events in IE
bos@574:             io.attachEvent ? io.attachEvent('onload', cb) : io.addEventListener('load', cb, false);
bos@574: 
bos@574:             // make sure form attrs are set
bos@574:             var encAttr = form.encoding ? 'encoding' : 'enctype';
bos@574:             var t = $form.attr('target');
bos@574:             $form.attr({
bos@574:                 target:   id,
bos@574:                 method:  'POST',
bos@574:                 action:   opts.url
bos@574:             });
bos@574:             form[encAttr] = 'multipart/form-data';
bos@574: 
bos@574:             // support timout
bos@574:             if (opts.timeout)
bos@574:                 setTimeout(function() { timedOut = true; cb(); }, opts.timeout);
bos@574: 
bos@574:             form.submit();
bos@574:             $form.attr('target', t); // reset target
bos@574:         }, 10);
bos@574: 
bos@574:         function cb() {
bos@574:             if (cbInvoked++) return;
bos@574: 
bos@574:             io.detachEvent ? io.detachEvent('onload', cb) : io.removeEventListener('load', cb, false);
bos@574: 
bos@574:             var ok = true;
bos@574:             try {
bos@574:                 if (timedOut) throw 'timeout';
bos@574:                 // extract the server response from the iframe
bos@574:                 var data, doc;
bos@574:                 doc = io.contentWindow ? io.contentWindow.document : io.contentDocument ? io.contentDocument : io.document;
bos@574:                 xhr.responseText = doc.body ? doc.body.innerHTML : null;
bos@574:                 xhr.responseXML = doc.XMLDocument ? doc.XMLDocument : doc;
bos@574: 
bos@574:                 if (opts.dataType == 'json' || opts.dataType == 'script') {
bos@574:                     var ta = doc.getElementsByTagName('textarea')[0];
bos@574:                     data = ta ? ta.value : xhr.responseText;
bos@574:                     if (opts.dataType == 'json')
bos@574:                         eval("data = " + data);
bos@574:                     else
bos@574:                         $.globalEval(data);
bos@574:                 }
bos@574:                 else if (opts.dataType == 'xml') {
bos@574:                     data = xhr.responseXML;
bos@574:                     if (!data && xhr.responseText != null)
bos@574:                         data = toXml(xhr.responseText);
bos@574:                 }
bos@574:                 else {
bos@574:                     data = xhr.responseText;
bos@574:                 }
bos@574:             }
bos@574:             catch(e){
bos@574:                 ok = false;
bos@574:                 $.handleError(opts, xhr, 'error', e);
bos@574:             }
bos@574: 
bos@574:             // ordering of these callbacks/triggers is odd, but that's how $.ajax does it
bos@574:             if (ok) {
bos@574:                 opts.success(data, 'success');
bos@574:                 if (g) $.event.trigger("ajaxSuccess", [xhr, opts]);
bos@574:             }
bos@574:             if (g) $.event.trigger("ajaxComplete", [xhr, opts]);
bos@574:             if (g && ! --$.active) $.event.trigger("ajaxStop");
bos@574:             if (opts.complete) opts.complete(xhr, ok ? 'success' : 'error');
bos@574: 
bos@574:             // clean up
bos@574:             setTimeout(function() {
bos@574:                 $io.remove();
bos@574:                 xhr.responseXML = null;
bos@574:             }, 100);
bos@574:         };
bos@574: 
bos@574:         function toXml(s, doc) {
bos@574:             if (window.ActiveXObject) {
bos@574:                 doc = new ActiveXObject('Microsoft.XMLDOM');
bos@574:                 doc.async = 'false';
bos@574:                 doc.loadXML(s);
bos@574:             }
bos@574:             else
bos@574:                 doc = (new DOMParser()).parseFromString(s, 'text/xml');
bos@574:             return (doc && doc.documentElement && doc.documentElement.tagName != 'parsererror') ? doc : null;
bos@574:         };
bos@574:     };
bos@574: };
bos@574: $.fn.ajaxSubmit.counter = 0; // used to create unique iframe ids
bos@574: 
bos@574: /**
bos@574:  * ajaxForm() provides a mechanism for fully automating form submission.
bos@574:  *
bos@574:  * The advantages of using this method instead of ajaxSubmit() are:
bos@574:  *
bos@574:  * 1: This method will include coordinates for <input type="image" /> elements (if the element
bos@574:  *    is used to submit the form).
bos@574:  * 2. This method will include the submit element's name/value data (for the element that was
bos@574:  *    used to submit the form).
bos@574:  * 3. This method binds the submit() method to the form for you.
bos@574:  *
bos@574:  * Note that for accurate x/y coordinates of image submit elements in all browsers
bos@574:  * you need to also use the "dimensions" plugin (this method will auto-detect its presence).
bos@574:  *
bos@574:  * The options argument for ajaxForm works exactly as it does for ajaxSubmit.  ajaxForm merely
bos@574:  * passes the options argument along after properly binding events for submit elements and
bos@574:  * the form itself.  See ajaxSubmit for a full description of the options argument.
bos@574:  *
bos@574:  *
bos@574:  * @example
bos@574:  * var options = {
bos@574:  *     target: '#myTargetDiv'
bos@574:  * };
bos@574:  * $('#myForm').ajaxSForm(options);
bos@574:  * @desc Bind form's submit event so that 'myTargetDiv' is updated with the server response
bos@574:  *       when the form is submitted.
bos@574:  *
bos@574:  *
bos@574:  * @example
bos@574:  * var options = {
bos@574:  *     success: function(responseText) {
bos@574:  *         alert(responseText);
bos@574:  *     }
bos@574:  * };
bos@574:  * $('#myForm').ajaxSubmit(options);
bos@574:  * @desc Bind form's submit event so that server response is alerted after the form is submitted.
bos@574:  *
bos@574:  *
bos@574:  * @example
bos@574:  * var options = {
bos@574:  *     beforeSubmit: function(formArray, jqForm) {
bos@574:  *         if (formArray.length == 0) {
bos@574:  *             alert('Please enter data.');
bos@574:  *             return false;
bos@574:  *         }
bos@574:  *     }
bos@574:  * };
bos@574:  * $('#myForm').ajaxSubmit(options);
bos@574:  * @desc Bind form's submit event so that pre-submit callback is invoked before the form
bos@574:  *       is submitted.
bos@574:  *
bos@574:  *
bos@574:  * @name   ajaxForm
bos@574:  * @param  options  object literal containing options which control the form submission process
bos@574:  * @return jQuery
bos@574:  * @cat    Plugins/Form
bos@574:  * @type   jQuery
bos@574:  */
bos@574: $.fn.ajaxForm = function(options) {
bos@574:     return this.ajaxFormUnbind().submit(submitHandler).each(function() {
bos@574:         // store options in hash
bos@574:         this.formPluginId = $.fn.ajaxForm.counter++;
bos@574:         $.fn.ajaxForm.optionHash[this.formPluginId] = options;
bos@574:         $(":submit,input:image", this).click(clickHandler);
bos@574:     });
bos@574: };
bos@574: 
bos@574: $.fn.ajaxForm.counter = 1;
bos@574: $.fn.ajaxForm.optionHash = {};
bos@574: 
bos@574: function clickHandler(e) {
bos@574:     var $form = this.form;
bos@574:     $form.clk = this;
bos@574:     if (this.type == 'image') {
bos@574:         if (e.offsetX != undefined) {
bos@574:             $form.clk_x = e.offsetX;
bos@574:             $form.clk_y = e.offsetY;
bos@574:         } else if (typeof $.fn.offset == 'function') { // try to use dimensions plugin
bos@574:             var offset = $(this).offset();
bos@574:             $form.clk_x = e.pageX - offset.left;
bos@574:             $form.clk_y = e.pageY - offset.top;
bos@574:         } else {
bos@574:             $form.clk_x = e.pageX - this.offsetLeft;
bos@574:             $form.clk_y = e.pageY - this.offsetTop;
bos@574:         }
bos@574:     }
bos@574:     // clear form vars
bos@574:     setTimeout(function() { $form.clk = $form.clk_x = $form.clk_y = null; }, 10);
bos@574: };
bos@574: 
bos@574: function submitHandler() {
bos@574:     // retrieve options from hash
bos@574:     var id = this.formPluginId;
bos@574:     var options = $.fn.ajaxForm.optionHash[id];
bos@574:     $(this).ajaxSubmit(options);
bos@574:     return false;
bos@574: };
bos@574: 
bos@574: /**
bos@574:  * ajaxFormUnbind unbinds the event handlers that were bound by ajaxForm
bos@574:  *
bos@574:  * @name   ajaxFormUnbind
bos@574:  * @return jQuery
bos@574:  * @cat    Plugins/Form
bos@574:  * @type   jQuery
bos@574:  */
bos@574: $.fn.ajaxFormUnbind = function() {
bos@574:     this.unbind('submit', submitHandler);
bos@574:     return this.each(function() {
bos@574:         $(":submit,input:image", this).unbind('click', clickHandler);
bos@574:     });
bos@574: 
bos@574: };
bos@574: 
bos@574: /**
bos@574:  * formToArray() gathers form element data into an array of objects that can
bos@574:  * be passed to any of the following ajax functions: $.get, $.post, or load.
bos@574:  * Each object in the array has both a 'name' and 'value' property.  An example of
bos@574:  * an array for a simple login form might be:
bos@574:  *
bos@574:  * [ { name: 'username', value: 'jresig' }, { name: 'password', value: 'secret' } ]
bos@574:  *
bos@574:  * It is this array that is passed to pre-submit callback functions provided to the
bos@574:  * ajaxSubmit() and ajaxForm() methods.
bos@574:  *
bos@574:  * The semantic argument can be used to force form serialization in semantic order.
bos@574:  * This is normally true anyway, unless the form contains input elements of type='image'.
bos@574:  * If your form must be submitted with name/value pairs in semantic order and your form
bos@574:  * contains an input of type='image" then pass true for this arg, otherwise pass false
bos@574:  * (or nothing) to avoid the overhead for this logic.
bos@574:  *
bos@574:  * @example var data = $("#myForm").formToArray();
bos@574:  * $.post( "myscript.cgi", data );
bos@574:  * @desc Collect all the data from a form and submit it to the server.
bos@574:  *
bos@574:  * @name formToArray
bos@574:  * @param semantic true if serialization must maintain strict semantic ordering of elements (slower)
bos@574:  * @type Array<Object>
bos@574:  * @cat Plugins/Form
bos@574:  */
bos@574: $.fn.formToArray = function(semantic) {
bos@574:     var a = [];
bos@574:     if (this.length == 0) return a;
bos@574: 
bos@574:     var form = this[0];
bos@574:     var els = semantic ? form.getElementsByTagName('*') : form.elements;
bos@574:     if (!els) return a;
bos@574:     for(var i=0, max=els.length; i < max; i++) {
bos@574:         var el = els[i];
bos@574:         var n = el.name;
bos@574:         if (!n) continue;
bos@574: 
bos@574:         if (semantic && form.clk && el.type == "image") {
bos@574:             // handle image inputs on the fly when semantic == true
bos@574:             if(!el.disabled && form.clk == el)
bos@574:                 a.push({name: n+'.x', value: form.clk_x}, {name: n+'.y', value: form.clk_y});
bos@574:             continue;
bos@574:         }
bos@574: 
bos@574:         var v = $.fieldValue(el, true);
bos@574:         if (v && v.constructor == Array) {
bos@574:             for(var j=0, jmax=v.length; j < jmax; j++)
bos@574:                 a.push({name: n, value: v[j]});
bos@574:         }
bos@574:         else if (v !== null && typeof v != 'undefined')
bos@574:             a.push({name: n, value: v});
bos@574:     }
bos@574: 
bos@574:     if (!semantic && form.clk) {
bos@574:         // input type=='image' are not found in elements array! handle them here
bos@574:         var inputs = form.getElementsByTagName("input");
bos@574:         for(var i=0, max=inputs.length; i < max; i++) {
bos@574:             var input = inputs[i];
bos@574:             var n = input.name;
bos@574:             if(n && !input.disabled && input.type == "image" && form.clk == input)
bos@574:                 a.push({name: n+'.x', value: form.clk_x}, {name: n+'.y', value: form.clk_y});
bos@574:         }
bos@574:     }
bos@574:     return a;
bos@574: };
bos@574: 
bos@574: 
bos@574: /**
bos@574:  * Serializes form data into a 'submittable' string. This method will return a string
bos@574:  * in the format: name1=value1&amp;name2=value2
bos@574:  *
bos@574:  * The semantic argument can be used to force form serialization in semantic order.
bos@574:  * If your form must be submitted with name/value pairs in semantic order then pass
bos@574:  * true for this arg, otherwise pass false (or nothing) to avoid the overhead for
bos@574:  * this logic (which can be significant for very large forms).
bos@574:  *
bos@574:  * @example var data = $("#myForm").formSerialize();
bos@574:  * $.ajax('POST', "myscript.cgi", data);
bos@574:  * @desc Collect all the data from a form into a single string
bos@574:  *
bos@574:  * @name formSerialize
bos@574:  * @param semantic true if serialization must maintain strict semantic ordering of elements (slower)
bos@574:  * @type String
bos@574:  * @cat Plugins/Form
bos@574:  */
bos@574: $.fn.formSerialize = function(semantic) {
bos@574:     //hand off to jQuery.param for proper encoding
bos@574:     return $.param(this.formToArray(semantic));
bos@574: };
bos@574: 
bos@574: 
bos@574: /**
bos@574:  * Serializes all field elements in the jQuery object into a query string.
bos@574:  * This method will return a string in the format: name1=value1&amp;name2=value2
bos@574:  *
bos@574:  * The successful argument controls whether or not serialization is limited to
bos@574:  * 'successful' controls (per http://www.w3.org/TR/html4/interact/forms.html#successful-controls).
bos@574:  * The default value of the successful argument is true.
bos@574:  *
bos@574:  * @example var data = $("input").formSerialize();
bos@574:  * @desc Collect the data from all successful input elements into a query string
bos@574:  *
bos@574:  * @example var data = $(":radio").formSerialize();
bos@574:  * @desc Collect the data from all successful radio input elements into a query string
bos@574:  *
bos@574:  * @example var data = $("#myForm :checkbox").formSerialize();
bos@574:  * @desc Collect the data from all successful checkbox input elements in myForm into a query string
bos@574:  *
bos@574:  * @example var data = $("#myForm :checkbox").formSerialize(false);
bos@574:  * @desc Collect the data from all checkbox elements in myForm (even the unchecked ones) into a query string
bos@574:  *
bos@574:  * @example var data = $(":input").formSerialize();
bos@574:  * @desc Collect the data from all successful input, select, textarea and button elements into a query string
bos@574:  *
bos@574:  * @name fieldSerialize
bos@574:  * @param successful true if only successful controls should be serialized (default is true)
bos@574:  * @type String
bos@574:  * @cat Plugins/Form
bos@574:  */
bos@574: $.fn.fieldSerialize = function(successful) {
bos@574:     var a = [];
bos@574:     this.each(function() {
bos@574:         var n = this.name;
bos@574:         if (!n) return;
bos@574:         var v = $.fieldValue(this, successful);
bos@574:         if (v && v.constructor == Array) {
bos@574:             for (var i=0,max=v.length; i < max; i++)
bos@574:                 a.push({name: n, value: v[i]});
bos@574:         }
bos@574:         else if (v !== null && typeof v != 'undefined')
bos@574:             a.push({name: this.name, value: v});
bos@574:     });
bos@574:     //hand off to jQuery.param for proper encoding
bos@574:     return $.param(a);
bos@574: };
bos@574: 
bos@574: 
bos@574: /**
bos@574:  * Returns the value(s) of the element in the matched set.  For example, consider the following form:
bos@574:  *
bos@574:  *  <form><fieldset>
bos@574:  *      <input name="A" type="text" />
bos@574:  *      <input name="A" type="text" />
bos@574:  *      <input name="B" type="checkbox" value="B1" />
bos@574:  *      <input name="B" type="checkbox" value="B2"/>
bos@574:  *      <input name="C" type="radio" value="C1" />
bos@574:  *      <input name="C" type="radio" value="C2" />
bos@574:  *  </fieldset></form>
bos@574:  *
bos@574:  *  var v = $(':text').fieldValue();
bos@574:  *  // if no values are entered into the text inputs
bos@574:  *  v == ['','']
bos@574:  *  // if values entered into the text inputs are 'foo' and 'bar'
bos@574:  *  v == ['foo','bar']
bos@574:  *
bos@574:  *  var v = $(':checkbox').fieldValue();
bos@574:  *  // if neither checkbox is checked
bos@574:  *  v === undefined
bos@574:  *  // if both checkboxes are checked
bos@574:  *  v == ['B1', 'B2']
bos@574:  *
bos@574:  *  var v = $(':radio').fieldValue();
bos@574:  *  // if neither radio is checked
bos@574:  *  v === undefined
bos@574:  *  // if first radio is checked
bos@574:  *  v == ['C1']
bos@574:  *
bos@574:  * The successful argument controls whether or not the field element must be 'successful'
bos@574:  * (per http://www.w3.org/TR/html4/interact/forms.html#successful-controls).
bos@574:  * The default value of the successful argument is true.  If this value is false the value(s)
bos@574:  * for each element is returned.
bos@574:  *
bos@574:  * Note: This method *always* returns an array.  If no valid value can be determined the
bos@574:  *       array will be empty, otherwise it will contain one or more values.
bos@574:  *
bos@574:  * @example var data = $("#myPasswordElement").fieldValue();
bos@574:  * alert(data[0]);
bos@574:  * @desc Alerts the current value of the myPasswordElement element
bos@574:  *
bos@574:  * @example var data = $("#myForm :input").fieldValue();
bos@574:  * @desc Get the value(s) of the form elements in myForm
bos@574:  *
bos@574:  * @example var data = $("#myForm :checkbox").fieldValue();
bos@574:  * @desc Get the value(s) for the successful checkbox element(s) in the jQuery object.
bos@574:  *
bos@574:  * @example var data = $("#mySingleSelect").fieldValue();
bos@574:  * @desc Get the value(s) of the select control
bos@574:  *
bos@574:  * @example var data = $(':text').fieldValue();
bos@574:  * @desc Get the value(s) of the text input or textarea elements
bos@574:  *
bos@574:  * @example var data = $("#myMultiSelect").fieldValue();
bos@574:  * @desc Get the values for the select-multiple control
bos@574:  *
bos@574:  * @name fieldValue
bos@574:  * @param Boolean successful true if only the values for successful controls should be returned (default is true)
bos@574:  * @type Array<String>
bos@574:  * @cat Plugins/Form
bos@574:  */
bos@574: $.fn.fieldValue = function(successful) {
bos@574:     for (var val=[], i=0, max=this.length; i < max; i++) {
bos@574:         var el = this[i];
bos@574:         var v = $.fieldValue(el, successful);
bos@574:         if (v === null || typeof v == 'undefined' || (v.constructor == Array && !v.length))
bos@574:             continue;
bos@574:         v.constructor == Array ? $.merge(val, v) : val.push(v);
bos@574:     }
bos@574:     return val;
bos@574: };
bos@574: 
bos@574: /**
bos@574:  * Returns the value of the field element.
bos@574:  *
bos@574:  * The successful argument controls whether or not the field element must be 'successful'
bos@574:  * (per http://www.w3.org/TR/html4/interact/forms.html#successful-controls).
bos@574:  * The default value of the successful argument is true.  If the given element is not
bos@574:  * successful and the successful arg is not false then the returned value will be null.
bos@574:  *
bos@574:  * Note: If the successful flag is true (default) but the element is not successful, the return will be null
bos@574:  * Note: The value returned for a successful select-multiple element will always be an array.
bos@574:  * Note: If the element has no value the return value will be undefined.
bos@574:  *
bos@574:  * @example var data = jQuery.fieldValue($("#myPasswordElement")[0]);
bos@574:  * @desc Gets the current value of the myPasswordElement element
bos@574:  *
bos@574:  * @name fieldValue
bos@574:  * @param Element el The DOM element for which the value will be returned
bos@574:  * @param Boolean successful true if value returned must be for a successful controls (default is true)
bos@574:  * @type String or Array<String> or null or undefined
bos@574:  * @cat Plugins/Form
bos@574:  */
bos@574: $.fieldValue = function(el, successful) {
bos@574:     var n = el.name, t = el.type, tag = el.tagName.toLowerCase();
bos@574:     if (typeof successful == 'undefined') successful = true;
bos@574: 
bos@574:     if (successful && (!n || el.disabled || t == 'reset' || t == 'button' ||
bos@574:         (t == 'checkbox' || t == 'radio') && !el.checked ||
bos@574:         (t == 'submit' || t == 'image') && el.form && el.form.clk != el ||
bos@574:         tag == 'select' && el.selectedIndex == -1))
bos@574:             return null;
bos@574: 
bos@574:     if (tag == 'select') {
bos@574:         var index = el.selectedIndex;
bos@574:         if (index < 0) return null;
bos@574:         var a = [], ops = el.options;
bos@574:         var one = (t == 'select-one');
bos@574:         var max = (one ? index+1 : ops.length);
bos@574:         for(var i=(one ? index : 0); i < max; i++) {
bos@574:             var op = ops[i];
bos@574:             if (op.selected) {
bos@574:                 // extra pain for IE...
bos@574:                 var v = $.browser.msie && !(op.attributes['value'].specified) ? op.text : op.value;
bos@574:                 if (one) return v;
bos@574:                 a.push(v);
bos@574:             }
bos@574:         }
bos@574:         return a;
bos@574:     }
bos@574:     return el.value;
bos@574: };
bos@574: 
bos@574: 
bos@574: /**
bos@574:  * Clears the form data.  Takes the following actions on the form's input fields:
bos@574:  *  - input text fields will have their 'value' property set to the empty string
bos@574:  *  - select elements will have their 'selectedIndex' property set to -1
bos@574:  *  - checkbox and radio inputs will have their 'checked' property set to false
bos@574:  *  - inputs of type submit, button, reset, and hidden will *not* be effected
bos@574:  *  - button elements will *not* be effected
bos@574:  *
bos@574:  * @example $('form').clearForm();
bos@574:  * @desc Clears all forms on the page.
bos@574:  *
bos@574:  * @name clearForm
bos@574:  * @type jQuery
bos@574:  * @cat Plugins/Form
bos@574:  */
bos@574: $.fn.clearForm = function() {
bos@574:     return this.each(function() {
bos@574:         $('input,select,textarea', this).clearFields();
bos@574:     });
bos@574: };
bos@574: 
bos@574: /**
bos@574:  * Clears the selected form elements.  Takes the following actions on the matched elements:
bos@574:  *  - input text fields will have their 'value' property set to the empty string
bos@574:  *  - select elements will have their 'selectedIndex' property set to -1
bos@574:  *  - checkbox and radio inputs will have their 'checked' property set to false
bos@574:  *  - inputs of type submit, button, reset, and hidden will *not* be effected
bos@574:  *  - button elements will *not* be effected
bos@574:  *
bos@574:  * @example $('.myInputs').clearFields();
bos@574:  * @desc Clears all inputs with class myInputs
bos@574:  *
bos@574:  * @name clearFields
bos@574:  * @type jQuery
bos@574:  * @cat Plugins/Form
bos@574:  */
bos@574: $.fn.clearFields = $.fn.clearInputs = function() {
bos@574:     return this.each(function() {
bos@574:         var t = this.type, tag = this.tagName.toLowerCase();
bos@574:         if (t == 'text' || t == 'password' || tag == 'textarea')
bos@574:             this.value = '';
bos@574:         else if (t == 'checkbox' || t == 'radio')
bos@574:             this.checked = false;
bos@574:         else if (tag == 'select')
bos@574:             this.selectedIndex = -1;
bos@574:     });
bos@574: };
bos@574: 
bos@574: 
bos@574: /**
bos@574:  * Resets the form data.  Causes all form elements to be reset to their original value.
bos@574:  *
bos@574:  * @example $('form').resetForm();
bos@574:  * @desc Resets all forms on the page.
bos@574:  *
bos@574:  * @name resetForm
bos@574:  * @type jQuery
bos@574:  * @cat Plugins/Form
bos@574:  */
bos@574: $.fn.resetForm = function() {
bos@574:     return this.each(function() {
bos@574:         // guard against an input with the name of 'reset'
bos@574:         // note that IE reports the reset function as an 'object'
bos@574:         if (typeof this.reset == 'function' || (typeof this.reset == 'object' && !this.reset.nodeType))
bos@574:             this.reset();
bos@574:     });
bos@574: };
bos@574: 
bos@574: })(jQuery);