Demo: Ajax form submit
/************************************************************************************************************
Ajax form submit
Copyright (C) 2007 DTHMLGoodies.com, Alf Magne Kalleland
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Dhtmlgoodies.com., hereby disclaims all copyright interest in this script
written by Alf Magne Kalleland.
Alf Magne Kalleland, 2007
Owner of DHTMLgoodies.com
************************************************************************************************************/
var DHTMLSuite = new Object();
DHTMLSuite.formUtil = function()
{
}
DHTMLSuite.getEl = function(elRef){
if(typeof elRef=='string'){
if(document.getElementById(elRef))return document.getElementById(elRef);
if(document.forms[elRef])return document.forms[elRef];
if(document[elRef])return document[elRef];
if(window[elRef])return window[elRef];
}
return elRef; // Return original ref.
}
DHTMLSuite.formUtil.prototype =
{
// {{{ getFamily
/**
* Return an array of elements with the same name
* @param Object el - Reference to form element
* @param Object formRef - Reference to form
*
* @public
*/
getFamily : function(el,formRef)
{
var els = formRef.elements;
var retArray = new Array();
for(var no=0;no
}
return retArray;
}
// }}}
,
// {{{ hasFileInputs()
/**
* Does the form has file inputs?
* @param Object formRef - Reference to form
*
* @public
*/
hasFileInputs : function(formRef)
{
var els = formRef.elements;
for(var no=0;no
}
return false;
}
// }}}
,
// {{{ getValuesAsArray()
/**
* Return value of form as associative array
* @param Object formRef - Reference to form
*
* @public
*/
getValuesAsArray : function(formRef)
{
var retArray = new Object();
formRef = DHTMLSuite.getEl(formRef);
var els = formRef.elements;
for(var no=0;no
var tag = els[no].tagName.toLowerCase();
switch(tag){
case "input":
var type = els[no].type.toLowerCase();
if(!type)type='text';
switch(type){
case "text":
case "image":
case "hidden":
case "password":
retArray[els[no].name] = els[no].value;
break;
case "checkbox":
var boxes = this.getFamily(els[no],formRef);
if(boxes.length>1){
retArray[els[no].name] = new Array();
for(var no2=0;no2
var index = retArray[els[no].name].length;
retArray[els[no].name][index] = boxes[no2].value;
}
}
}else{
if(els[no].checked)retArray[els[no].name] = els[no].value;
}
break;
case "radio":
if(els[no].checked)retArray[els[no].name] = els[no].value;
break;
}
break;
case "select":
var string = '';
var mult = els[no].getAttribute('multiple');
if(mult || mult===''){
retArray[els[no].name] = new Array();
for(var no2=0;no2
if(els[no].options[no2].selected)retArray[els[no].name][index] = els[no].options[no2].value;
}
}else{
retArray[els[no].name] = els[no].options[els[no].selectedIndex].value;
}
break;
case "textarea":
retArray[els[no].name] = els[no].value;
break;
}
}
return retArray;
}
// }}}
,
// {{{ getValue()
/**
* Return value of form element
* @param Object formEl - Reference to form element
*
* @public
*/
getValue : function(formEl)
{
switch(formEl.tagName.toLowerCase()){
case "input":
case "textarea": return formEl.value;
case "select": return formEl.options[formEl.selectedIndex].value;
}
}
// }}}
,
// {{{ areEqual()
/**
* Check if two form elements have the same value
* @param Object input1 - Reference to form element
* @param Object input2 - Reference to form element
*
* @public
*/
areEqual : function(input1,input2)
{
input1 = DHTMLSuite.getEl(input1);
input2 = DHTMLSuite.getEl(input2);
if(this.getValue(input1)==this.getValue(input2))return true;
return false;
}
}
/************************************************************************************************************
* Form submission class
*
* Created: March, 6th, 2007
* @class Purpose of class: Ajax form submission class
*
* Css files used by this script: form.css
*
* Demos of this class: demo-form-validator.html
*
* Update log:
*
************************************************************************************************************/
/**
* @constructor
* @class Form submission
* Demo: demo-form-validator.html
*
* @param Associative array of properties, possible keys:
* formRef - Reference to form
* method - How to send the form, "GET" or "POST", default is "POST"
* reponseEl - Where to display response from ajax
* action - Where to send form data
* responseFile - Alternative response file. This will be loaded dynamically once the script receives response from the file specified in "action".
*
* @version 1.0
* @version 1.0
* @author Alf Magne Kalleland(www.dhtmlgoodies.com)
**/
DHTMLSuite.variableStorage = new Object();
DHTMLSuite.variableStorage.arrayDSObjects = new Array();
DHTMLSuite.form = function(propArray)
{
var formRef;
var method;
var responseEl;
var action;
var responseFile;
var formUtil;
var objectIndex;
var sackObj;
var coverDiv;
var layoutCSS;
var iframeName;
this.method = 'POST';
this.sackObj = new Array();
this.formUtil = new DHTMLSuite.formUtil();
this.layoutCSS = 'form.css';
this.objectIndex = DHTMLSuite.variableStorage.arrayDSObjects.length;
DHTMLSuite.variableStorage.arrayDSObjects[this.objectIndex] = this;
if(propArray)this.__setInitProperties(propArray);
}
DHTMLSuite.form.prototype =
{
// {{{ submit()
/**
* Submits the form
*
* @public
*/
submit : function()
{
this.__createCoverDiv();
var index = this.sackObj.length;
if(this.formUtil.hasFileInputs(this.formRef)){
this.__createIframe();
this.formRef.submit();
}else{
this.__createSackObject(index);
this.__populateSack(index);
this.sackObj[index].runAJAX();
}
this.__positionCoverDiv();
return false;
}
// }}}
,
__createIframe : function()
{
if(this.iframeName)return;
var ind = this.objectIndex;
var div = document.createElement('DIV');
document.body.appendChild(div);
this.iframeName = 'DHTMLSuiteForm' + this.getUniqueId();
div.innerHTML = '';
this.formRef.method = this.method;
this.formRef.action = this.action;
this.formRef.target = this.iframeName;
if(!this.formRef.enctype)this.formRef.enctype = 'multipart/form-data';
}
,
// {{{ getUniqueId()
/**
*
* Returns a unique numeric id
*
*
*
* @public
*/
getUniqueId : function()
{
var no = Math.random() + '';
no = no.replace('.','');
var no2 = Math.random() + '';
no2 = no2.replace('.','');
return no + no2;
}
// }}}
,
// {{{ __getIframeResponse()
/**
* Form has been submitted to iframe - move content from iframe
*
* @private
*/
__getIframeResponse : function()
{
if(this.responseEl){
if(this.responseFile){
if(!this.responseEl.id)this.responseEl.id = 'DHTMLSuite_formResponse' + DHTMLSuite.getUniqueId();
var dynContent = new DHTMLSuite.dynamicContent();
dynContent.loadContent(this.responseEl.id,this.responseFile);
}else{
this.responseEl.innerHTML = self.frames[this.iframeName].document.body.innerHTML;
this.__evaluateJs(this.responseEl);
this.__evaluateCss(this.responseEl);
}
}
this.coverDiv.style.display='none';
this.__handleCallback('onComplete');
}
// }}}
,
// {{{ __positionCoverDiv()
/**
* Position cover div
*
* @private
*/
__positionCoverDiv : function()
{
if(!this.responseEl)return;
try{
var st = this.coverDiv.style;
st.left = this.getLeftPos(this.responseEl) + 'px';
st.top = this.getTopPos(this.responseEl) + 'px';
st.width = this.responseEl.offsetWidth + 'px';
st.height = this.responseEl.offsetHeight + 'px';
st.display='block';
}catch(e){
}
}
// }}}
,
// {{{ __createCoverDiv()
/**
* Submits the form
*
* @private
*/
__createCoverDiv : function()
{
if(this.coverDiv)return;
this.coverDiv = document.createElement('DIV');
var el = this.coverDiv;
el.style.overflow='hidden';
el.style.zIndex = 1000;
el.style.position = 'absolute';
document.body.appendChild(el);
var innerDiv = document.createElement('DIV');
innerDiv.style.width='105%';
innerDiv.style.height='105%';
innerDiv.className = 'DHTMLSuite_formCoverDiv';
innerDiv.style.opacity = '0.2';
innerDiv.style.filter = 'alpha(opacity=20)';
el.appendChild(innerDiv);
var ajaxLoad = document.createElement('DIV');
ajaxLoad.className = 'DHTMLSuite_formCoverDiv_ajaxLoader';
el.appendChild(ajaxLoad);
}
// }}}
,
// {{{ __createSackObject()
/**
* Create new sack object
*
* @private
*/
__createSackObject : function(ajaxIndex)
{
var ind = this.objectIndex;
this.sackObj[ajaxIndex] = new sack();
this.sackObj[ajaxIndex].requestFile = this.action;
this.sackObj[ajaxIndex].method = this.method;
this.sackObj[ajaxIndex].onCompletion = function(){ DHTMLSuite.variableStorage.arrayDSObjects[ind].__getResponse(ajaxIndex); }
}
// }}}
,
// {{{ __getResponse()
/**
* Get response from ajax
*
* @private
*/
__getResponse : function(ajaxIndex)
{
if(this.responseEl){
if(this.responseFile){
if(!this.responseEl.id)this.responseEl.id = 'DHTMLSuite_formResponse' + DHTMLSuite.getUniqueId();
var dynContent = new DHTMLSuite.dynamicContent();
dynContent.loadContent(this.responseEl.id,this.responseFile);
}else{
this.responseEl.innerHTML = this.sackObj[ajaxIndex].response;
this.__evaluateJs(this.responseEl);
this.__evaluateCss(this.responseEl);
}
}
this.coverDiv.style.display='none';
this.sackObj[ajaxIndex] = null;
this.__handleCallback('onComplete');
}
,
// {{{ isArray()
/**
* Return true if element is an array
*
* @param Object el = Reference to HTML element
* @public
*/
isArray : function(el)
{
if(el.constructor.toString().indexOf("Array") != -1)return true;
return false;
}
// }}}
,
// {{{ __populateSack()
/**
* Populate sack object with form data
* @param ajaxIndex - index of current sack object
*
* @private
*/
__populateSack : function(ajaxIndex)
{
var els = this.formUtil.getValuesAsArray(this.formRef);
for(var prop in els){
if(this.isArray(els[prop])){
for(var no=0;no
if(prop.indexOf('[')>=0){ // The name of the form field is already indicating an array
name = prop.replace('[','[' + no);
}
this.sackObj[ajaxIndex].setVar(name,els[prop][no]);
}
}else{
this.sackObj[ajaxIndex].setVar(prop,els[prop]);
}
}
}
// }}}
,
// {{{ __setInitProperties()
/**
* Fill object with data sent to the constructor
* @param Array props - Associative Array("Object") of properties
*
* @private
*/
__setInitProperties : function(props)
{
if(props.formRef)this.formRef = DHTMLSuite.getEl(props.formRef);
if(props.method)this.method = props.method;
if(props.responseEl)this.responseEl = DHTMLSuite.getEl(props.responseEl);
if(props.action)this.action = props.action;
if(props.responseFile)this.responseFile = props.responseFile;
if(props.callbackOnComplete)this.callbackOnComplete = props.callbackOnComplete;
if(!this.action)this.action = this.formRef.action;
if(!this.method)this.method = this.formRef.method;
}
// }}}
,
// {{{ __handleCallback()
/**
* Execute callback
* @param String action - Which callback action
*
* @private
*/
__handleCallback : function(action)
{
var callbackString = '';
switch(action){
case "onComplete":
callbackString = this.callbackOnComplete;
break;
}
if(callbackString){
if(callbackString.indexOf('(')==-1)callbackString = callbackString + '("' + this.formRef.name + '")';
eval(callbackString);
}
}
,
// {{{ __evaluateJs()
/**
* Evaluate Javascript in the inserted content
*
* @private
*/
__evaluateJs : function(obj)
{
obj = DHTMLSuite.getEl(obj);
var scriptTags = obj.getElementsByTagName('SCRIPT');
var string = '';
var jsCode = '';
for(var no=0;no
var head = document.getElementsByTagName("head")[0];
var scriptObj = document.createElement("script");
scriptObj.setAttribute("type", "text/javascript");
scriptObj.setAttribute("src", scriptTags[no].src);
}else{
if(DHTMLSuite.clientInfoObj.isOpera){
jsCode = jsCode + scriptTags[no].text + '\n';
}
else
jsCode = jsCode + scriptTags[no].innerHTML;
}
}
if(jsCode)this.__installScript(jsCode);
}
// }}}
,
// {{{ __installScript()
/**
* "Installs" the content of a
/* Simple AJAX Code-Kit (SACK) v1.6.1 */
/* ©2005 Gregory Wild-Smith */
/* www.twilightuniverse.com */
/* Software licenced under a modified X11 licence,
see documentation or authors website for more details */
function sack(file) {
this.xmlhttp = null;
this.resetData = function() {
this.method = "POST";
this.queryStringSeparator = "?";
this.argumentSeparator = "&";
this.URLString = "";
this.encodeURIString = true;
this.execute = false;
this.element = null;
this.elementObj = null;
this.requestFile = file;
this.vars = new Object();
this.responseStatus = new Array(2);
};
this.resetFunctions = function() {
this.onLoading = function() { };
this.onLoaded = function() { };
this.onInteractive = function() { };
this.onCompletion = function() { };
this.onError = function() { };
this.onFail = function() { };
};
this.reset = function() {
this.resetFunctions();
this.resetData();
};
this.createAJAX = function() {
try {
this.xmlhttp = new ActiveXObject("Msxml2.XMLHTTP");
} catch (e1) {
try {
this.xmlhttp = new ActiveXObject("Microsoft.XMLHTTP");
} catch (e2) {
this.xmlhttp = null;
}
}
if (! this.xmlhttp) {
if (typeof XMLHttpRequest != "undefined") {
this.xmlhttp = new XMLHttpRequest();
} else {
this.failed = true;
}
}
};
this.setVar = function(name, value){
this.vars[name] = Array(value, false);
};
this.encVar = function(name, value, returnvars) {
if (true == returnvars) {
return Array(encodeURIComponent(name), encodeURIComponent(value));
} else {
this.vars[encodeURIComponent(name)] = Array(encodeURIComponent(value), true);
}
}
this.processURLString = function(string, encode) {
encoded = encodeURIComponent(this.argumentSeparator);
regexp = new RegExp(this.argumentSeparator + "|" + encoded);
varArray = string.split(regexp);
for (i = 0; i < varArray.length; i++){
urlVars = varArray[i].split("=");
if (true == encode){
this.encVar(urlVars[0], urlVars[1]);
} else {
this.setVar(urlVars[0], urlVars[1]);
}
}
}
this.createURLString = function(urlstring) {
if (this.encodeURIString && this.URLString.length) {
this.processURLString(this.URLString, true);
}
if (urlstring) {
if (this.URLString.length) {
this.URLString += this.argumentSeparator + urlstring;
} else {
this.URLString = urlstring;
}
}
// prevents caching of URLString
this.setVar("rndval", new Date().getTime());
urlstringtemp = new Array();
for (key in this.vars) {
if (false == this.vars[key][1] && true == this.encodeURIString) {
encoded = this.encVar(key, this.vars[key][0], true);
delete this.vars[key];
this.vars[encoded[0]] = Array(encoded[1], true);
key = encoded[0];
}
urlstringtemp[urlstringtemp.length] = key + "=" + this.vars[key][0];
}
if (urlstring){
this.URLString += this.argumentSeparator + urlstringtemp.join(this.argumentSeparator);
} else {
this.URLString += urlstringtemp.join(this.argumentSeparator);
}
}
this.runResponse = function() {
eval(this.response);
}
this.runAJAX = function(urlstring) {
if (this.failed) {
this.onFail();
} else {
this.createURLString(urlstring);
if (this.element) {
this.elementObj = document.getElementById(this.element);
}
if (this.xmlhttp) {
var self = this;
if (this.method == "GET") {
totalurlstring = this.requestFile + this.queryStringSeparator + this.URLString;
this.xmlhttp.open(this.method, totalurlstring, true);
} else {
this.xmlhttp.open(this.method, this.requestFile, true);
try {
this.xmlhttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded")
} catch (e) { }
}
this.xmlhttp.onreadystatechange = function() {
switch (self.xmlhttp.readyState) {
case 1:
self.onLoading();
break;
case 2:
self.onLoaded();
break;
case 3:
self.onInteractive();
break;
case 4:
self.response = self.xmlhttp.responseText;
self.responseXML = self.xmlhttp.responseXML;
self.responseStatus[0] = self.xmlhttp.status;
self.responseStatus[1] = self.xmlhttp.statusText;
if (self.execute) {
self.runResponse();
}
if (self.elementObj) {
elemNodeName = self.elementObj.nodeName;
elemNodeName = elemNodeName.toLowerCase();
if (elemNodeName == "input"
|| elemNodeName == "select"
|| elemNodeName == "option"
|| elemNodeName == "textarea") {
self.elementObj.value = self.response;
} else {
self.elementObj.innerHTML = self.response;
}
}
if (self.responseStatus[0] == "200") {
self.onCompletion();
} else {
self.onError();
}
/* These lines were added by Alf Magne Kalleland ref. info on the sack home page. It prevents memory leakage in IE */
self.URLString = "";
delete self.xmlhttp['onreadystatechange'];
self.xmlhttp=null;
self.responseStatus=null;
self.response=null;
self.responseXML=null;
break;
}
};
this.xmlhttp.send(this.URLString);
}
}
};
this.reset();
this.createAJAX();
}
body{
margin:0px;
font-size:0.8em;
font-family:Trebuchet MS
}
#mainContainer{
width:840px;
margin:5px;
}
table,tr,td{
vertical-align:top;
}
.textInput{
width:300px;
}
html{
margin:0px;
}
.formButton{
width:75px;
}
textarea,input,select{
font-family:Trebuchet MS;
}
i{
font-size:0.9em;
}