Skip to content
Permalink
Browse files
Did a lot of work on the form plugin. Re-worked the function names, d…
…ocumentation, fixed some bugs - generally made things much more explicit and easier to understand.
  • Loading branch information
jeresig committed Jun 22, 2006
1 parent 5f8576d commit ce6af8e8894b14c7b2c41b64a097bc49acc73b19
Showing 1 changed file with 144 additions and 121 deletions.
@@ -1,189 +1,212 @@
/**
* Initial frontend function to submit form variables. This function
* is for registering coordinates, in the case of an image being used
* as the submit element, and sets up an event to listen and wait for
* a form submit click. It then calls any following chained functions
* to actually gather the variables and submit them.
* A method for submitting an HTML form using AJAX, as opposed to the
* standard page-load way.
*
* Usage examples, when used with getForm().putForm():
* This method attempts to mimic the functionality of the original form
* as best as possible (duplicating the method, action, and exact contents
* of the form).
*
* There are three different resulting operations that can occur, after
* your form has been submitted.
*
* 1. The form is submitted and a callback is fired, letting you know
* when it's done:
* $("form").ajaxSubmit(function(){
* alert("all done!");
* });
*
* 2. The form is submitted and the resulting HTML contents are injected
* into the page, at your specified location.
* $("form").ajaxSubmit("#destination");
*
* 3. The form is submitted and the results returned from the server are
* automatically executed (useful for having the server return more
* Javascript commands to execute).
* $("form").ajaxSubmit();
*
* Additionally, an optional pre-submit callback can be provided. If it,
* when called with the contents of the form, returns false, the form will
* not be submitted.
*
* Finally, both the URL and method of the form submission can be
* overidden using the 'url' and 'mth' arguments.
*
* @param target arg for the target id element to render
* @param post_cb callback after any results are returned
* @param pre_cb callback function before submission
* @param url form action override
* @param mth form method override
* @return "this" object
* @see ajaxForm(), serialize(), load(), $.xml()
* @author Mark Constable (markc@renta.net)
* @author G. vd Hoven, Mike Alsup, Sam Collett, John Resig
*/
$.fn.ajaxSubmit = function(target, post_cb, pre_cb, url, mth) {
if ( !this.vars ) this.serialize();

if (pre_cb && pre_cb.constructor == Function)
if (pre_cb(this.vars) === false) return;

var f = this.get(0);
var url = url || f.action || '';
var mth = mth || f.method || 'POST';

if (target && target.constructor == Function) {
$.xml(mth, url, $.param(this.vars), target);
} else if (target && target.constructor == String) {
$(target).load(url, this.vars, post_cb);
} else {
this.vars.push({name: 'evaljs', value: 1});
$.xml(mth, url, $.param(this.vars), function(r) {
eval(r.responseText);
});
}

return this;
};

/**
* This function can be used to turn any HTML form into a form
* that submits using AJAX only.
*
* The purpose of using this method, instead of the ajaxSubmit()
* and submit() methods, is to make absolutely sure that the
* coordinates of <input type="image"/> elements are transmitted
* correctly OR figuring out exactly which <input type="submit"/>
* element was clicked to submit the form.
*
* If neither of the above points are important to you, then you'll
* probably just want to stick with the simpler ajaxSubmit() function.
*
* Usage examples, similar to ajaxSubmit():
*
* 1. Just eval the results returned from the backend.
* $('#form-id').form();
* $('#form-id').ajaxForm();
*
* 2. Render backend results directly to target ID (expects (x)HTML).
* $('#form-id').form('#target-id');
* $('#form-id').ajaxForm('#target-id');
*
* 3. Submit to backend URL (form action) then call this function.
* $('#form-id').form(post_callback);
* $('#form-id').ajaxForm(post_callback);
*
* 4. Load target ID with backend results then call a function.
* $('#form-id').form('#target-id', null, post_callback);
* $('#form-id').ajaxForm('#target-id', post_callback);
*
* 5. Call a browser function (for validation) and then (optionally)
* load server results to target ID.
* $('#form-id').form('#target-id', pre_callback);
* $('#form-id').ajaxForm('#target-id', null, pre_callback);
*
* 6. Call validation function first then load server results to
* target ID and then also call a browser function.
* $('#form-id').form('#target-id', pre_callback, post_callback);
* $('#form-id').ajaxForm('#target-id', post_callback, pre_callback);
*
* @param target arg for the target id element to render
* @param pre_cb callback function before submission
* @param post_cb callback after any results are returned
* @return "this" object
* @see getForm(), putForm()
* @param pre_cb callback function before submission
* @return the jQuery Object
* @see serialize(), ajaxSubmit()
* @author Mark Constable (markc@renta.net)
* @author G. vd Hoven, Mike Alsup, Sam Collett
* @version 20060606
* @author G. vd Hoven, Mike Alsup, Sam Collett, John Resig
*/
$.fn.form = function(target, pre_cb, post_cb) {
$('input[@type="submit"],input[@type="image"]', this).click(function(ev){
this.form.clicked = this;
if (ev.offsetX != undefined) {
this.form.clicked_x = ev.offsetX;
this.form.clicked_y = ev.offsetY;
} else {
this.form.clicked_x = ev.pageX - this.offsetLeft;
this.form.clicked_y = ev.pageY - this.offsetTop;
}
});
this.submit(function(e){
$.fn.ajaxForm = function(target, post_cb, pre_cb) {
return this.each(function(){
$('input[@type="submit"],input[@type="image"]', this).click(function(ev){
this.form.clicked = this;
if (ev.offsetX != undefined) {
this.form.clicked_x = ev.offsetX;
this.form.clicked_y = ev.offsetY;
} else {
this.form.clicked_x = ev.pageX - this.offsetLeft;
this.form.clicked_y = ev.pageY - this.offsetTop;
}
});
}).submit(function(e){
e.preventDefault();
$(this).getForm().putForm(target, pre_cb, post_cb);
return this;
$(this).ajaxSubmit(target, post_cb, pre_cb);
return false;
});
};

/**
* A simple wrapper function that sits around the .serialize()
* method, allowing you to easily extract the data stored within
* a form.
*
* Usage examples:
*
* 1. Serialize the contents of a form to a & and = delmited string:
* $.param( $("form").formdata() );
*
* @return An array of name/value pairs representing the form
* @see serialize()
# @author John Resig
*/
$.fn.formdata = function(){
this.serialize();
return this.vars;
};

/**
* This function gathers form element variables into an array that
* is embedded into the current "this" variable as "this.vars". It
* is normally used in conjunction with form() and putForm() but can
* be used standalone as long as an image is not used for submission.
* is normally used in conjunction with formdata() or ajaxSubmit() but can
* be used standalone as long as you don't need the x and y coordinates
* associated with an <input type="image"/> element..
*
* Standalone usage examples:
*
* 1. Gather form vars and return array to LHS variable.
* var myform = $('#form-id').getForm();
* var myform = $('#form-id').serialize();
*
* 2. Provide a serialized URL-ready string (after 1. above).
* var mystring = $.param(myform.vars);
*
* 3. Gather form vars and send to RHS plugin via "this.vars".
* $('#form-id').getForm().some_other_plugin();
* $('#form-id').serialize().some_other_plugin();
*
* @return "this" object
* @see form(), putForm()
* @return the jQuery Object
* @see ajaxForm(), ajaxSubmit()
* @author Mark Constable (markc@renta.net)
* @author G. vd Hoven, Mike Alsup, Sam Collett
* @version 20060606
* @author G. vd Hoven, Mike Alsup, Sam Collett, John Resig
*/
$.fn.getForm = function() {
$.fn.serialize = function() {
var a = [];
var ok = {INPUT:true, TEXTAREA:true, OPTION:true};

$('*', this).each(function() {
if (this.disabled || this.type == 'reset' || (this.type == 'checkbox' && !this.checked) || (this.type == 'radio' && !this.checked))
return;
if (this.disabled || this.type == 'reset' ||
(this.type == 'checkbox' && !this.checked) ||
(this.type == 'radio' && !this.checked)) return;

if (this.type == 'submit' || this.type == 'image') {
if (this.form.clicked != this)
return;
if (this.form.clicked != this) return;

if (this.type == 'image') {
if (this.form.clicked_x) {
a.push({name: this.name+'_x', value: this.form.clicked_x});
a.push({name: this.name+'_y', value: this.form.clicked_y});
return;
}
a.push({name: this.name+'_x', value: this.form.clicked_x});
a.push({name: this.name+'_y', value: this.form.clicked_y});
return;
}
}
}

if (!ok[this.nodeName.toUpperCase()])
return;

var par = this.parentNode;
var p = par.nodeName.toUpperCase();
if ((p == 'SELECT' || p == 'OPTGROUP') && !this.selected)
return;
if ((p == 'SELECT' || p == 'OPTGROUP') && !this.selected) return;

var n = this.name || par.name;
if (!n && p == 'OPTGROUP' && (par = par.parentNode))
n = par.name;

if (n == undefined)
return;
if (n == undefined) return;

a.push({name: n, value: this.value});
});

this.vars = a;

return this;
}

/**
* Final form submission plugin usually used in conjunction with
* form() and getForm(). If a second argument is a valid function
* then it will be called before the form vars are sent to the
* backend. If this pre-submit function returns exactly "false"
* then it will abort further processing otherwise the process
* will continue according to the first and third arguments.
*
* If the first argument is a function, and it exists, then the form
* values will be submitted and that callback function called. If
* the first argument is a string value then the "load()" plugin
* will be called which will populate the innerHTML of the indicated
* element and a callback will be called if there is third argument.
* If there are no arguments then the form values are submitted with
* an additional variable (evaljs=1) which indicates to the backend
* to to prepare the returned results for evaluation, ie; the result
* needs to be valid javascript all on a single line.
*
* Usage example:
*
* $.fn.myvars = function() {
* this.vars = [];
* for (var i in this) {
* if (this[i] instanceof Function || this[i] == null) continue;
* this.vars.push({name: i, value: this[i].length});
* }
* return this;
* }
*
* precb = function(vars) {
* return confirm('Submit these values?\n\n'+$.param(vars));
* }
*
* $('*').myvars().putForm('#mytarget',precb,null,'myhandler.php');
*
* @param target arg for the target id element to render
* @param pre_cb callback function before submission
* @param post_cb callback after any results are returned
* @param url form action override
* @param mth form method override
* @return "this" object
* @see form(), getForm(), load(), xml()
* @author Mark Constable (markc@renta.net)
* @author G. vd Hoven, Mike Alsup, Sam Collett
* @version 20060606
*/
$.fn.putForm = function(target, pre_cb, post_cb, url, mth) {
if (pre_cb && pre_cb.constructor == Function)
if (pre_cb(this.vars) === false)
return;

var f = this.get(0);
var url = url || f.action || '';
var mth = mth || f.method || 'POST';

if (target && target.constructor == Function) {
$.xml(mth, url, $.param(this.vars), target);
} else if (target && target.constructor == String) {
$(target).load(url, this.vars, post_cb);
} else {
this.vars.push({name: 'evaljs', value: 1});
$.xml(mth, url, $.param(this.vars), function(r) { eval(r.responseText); });
}

return this;
}
};

0 comments on commit ce6af8e

Please sign in to comment.