/**
 * Ajax.js
 *
 * Collection of Scripts to allow in page communication from browser to (struts) server
 * ie can reload part instead of full page
 *
 * How to use
 * ==========
 * 1) Call retrieveURL from the relevant event on the HTML page (e.g. onclick)
 * 2) Pass the url to contact (e.g. Struts Action) and the name of the HTML form to post
 * 3) When the server responds ...
 *		 - the script loops through the response , looking for <span id="name">newContent</span>
 * 		 - each <span> tag in the *existing* document will be replaced with newContent
 *
 * NOTE: <span id="name"> is case sensitive. Name *must* follow the first quote mark and end in a quote
 *		 Everything after the first '>' mark until </span> is considered content.
 *		 Empty Sections should be in the format <span id="name"></span>
 */

//global variables
  var req;
  var which;


  /**
   * Get the contents of the URL via an Ajax call
   * url - to get content from (e.g. /struts-ajax/sampleajax.do?ask=COMMAND_NAME_1) 
   * nodeToOverWrite - when callback is made
   * nameOfFormToPost - which form values will be posted up to the server as part 
   *					of the request (can be null)
   */
  function retrieveURL(url,nameOfFormToPost,customCallback) {
    
    //get the (form based) params to push up as part of the get request
    if (nameOfFormToPost != null)
	    url=url+getFormAsString(nameOfFormToPost);
    
    //Do the Ajax call
    if (window.XMLHttpRequest) { // Non-IE browsers
      var req = new XMLHttpRequest();
      req.onreadystatechange = createStateChange(req,customCallback);
      try {
      	req.open("GET", url, true); //was get
      } catch (e) {
        alert("Problem Communicating with Server\n"+e);
      }
      req.send(null);
    } else if (window.ActiveXObject) { // IE
      
      var req = new ActiveXObject("Microsoft.XMLHTTP");
      if (req) {
        req.onreadystatechange = createStateChange(req,customCallback);
        req.open("GET", url, true);
        req.send();
      }
    }
  }

/*
   * Set as the callback method for when XmlHttpRequest State Changes 
   * used by retrieveUrl
  */
function createStateChange(req,customCallback) {
  return function () {
  
  	  if (req.readyState == 4) { // Complete
      if (req.status == 200) { // OK response
        
        //alert("Ajax response:"+req.responseText);
        
        //Split the text response into Span elements
        //spanElements = splitTextIntoSpan(req.responseText);
        
        //Use these span elements to update the page
        replaceExistingWithNewHtml(req.responseText);
        
        if (customCallback != null)
          customCallback();
      } else {
        alert("Problem with server response:\n " + req.statusText);
      }
    }
  }
}
 
 /**
  * gets the contents of the form as a URL encoded String
  * suitable for appending to a url
  * @param formName to encode
  * @return string with encoded form values , beings with &
  */ 
 function getFormAsString(formName){
 	
 	//Setup the return String
 	returnString ="";
 	
  	//Get the form values
 	formElements=document.forms[formName].elements;
 	
 	//loop through the array , building up the url
 	//in the form /strutsaction.do&name=value
 	
 	for ( var i=formElements.length-1; i>=0; --i ){
 		//we escape (encode) each value
 		var value = "";
 		if (formElements[i].type == "radio" || formElements[i].type == "checkbox")
 			value = formElements[i].checked;
 		else
 			value = formElements[i].value;
 		returnString=returnString+"&"+escape(formElements[i].name)+"="+escape(value);
 	}
 	
 	//return the values
 	return returnString; 
 }
 
 /**
 * Splits the text into <span> elements
 * @param the text to be parsed
 * @return array of <span> elements - this array can contain nulls
 */
 function splitTextIntoSpan(textToSplit){
 
  	//Split the document
 	returnElements=textToSplit.split("</span>")
 	
 	//Process each of the elements 	
 	for ( var i=returnElements.length-1; i>=0; --i ){
 		
 		//Remove everything before the 1st span
 		spanPos = returnElements[i].indexOf("<span");		
 		
 		//if we find a match , take out everything before the span
 		if(spanPos>0){
 			subString=returnElements[i].substring(spanPos);
 			returnElements[i]=subString;
 		
 		} 
 	}
 	
 	return returnElements;
 }
 
 /*
  * Replace html elements in the existing (ie viewable document)
  * with new elements (from the ajax requested document)
  * WHERE they have the same name AND are <span> elements
  * @param newTextElements (output of splitTextIntoSpan)
  *					in the format <span id=name>texttoupdate
  */
 function replaceExistingWithNewHtml(newTextElements){
 	//Insert new html into scratch DIV first
	var scratchDiv = document.getElementById("scratchDiv");
	scratchDiv.innerHTML = newTextElements;
	
	//Scan scratch DIV for named elements with children
 	for (var i = 0; i < scratchDiv.childNodes.length; i++) {
 		var node = scratchDiv.childNodes.item(i);
 		
 		if (!node.hasChildNodes()) continue;
 		
 		var name = node.getAttribute("name");
 		dest = document.getElementById(name);
 		
 		//Clear destination
		while (dest.hasChildNodes()) {
		        dest.removeChild(dest.firstChild);
		}
		//Insert into destination
		while (node.hasChildNodes()) {
		        dest.appendChild(node.removeChild(node.firstChild));
		}
 	}
 }