Class AjaxRequest

Object
   |
   +--AjaxRequest

class AjaxRequest

The AjaxRequest object wraps an instance of XMLHttpRequest and provides facilities for setting functions that are called before a request is made and after a request returns. By default, AjaxRequest handles the server response by simply calling eval(), passing to it the responseText from the XMLHttpRequestObject, of course assuming that the response was generated by Taconite on the server side and that running eval() will update the web page.

Example Usage:

var ajaxRequest = new AjaxRequest("YOUR_URL");
ajaxRequest.addFormElements("form_element_id_attribute_value-or-form_dom_element");
ajaxRequest.sendRequest();
Defined in taconite-client.js

Constructor Detail

AjaxRequest

AjaxRequest(url)

Constructor for the AjaxRequest class.

Example:

var ajaxRequest = new AjaxRequest("YOUR_URL");

Parameters:
a - String repesenting the URL to which the Ajax request will be sent.

addFormElements

void addFormElements(form)

Add all of the form elements under the specified form to the query string to be sent to the server as part of the Ajax request. The values are automatically encoded.

Parameters:
form - , A form DOM element, or the id attribute of the form element from which you wish to accumulate the form values.

addFormElementsById

void addFormElementsById()

Add the values of the id'd form elements to the query string to be sent to the server as part of the Ajax request. This method takes any number of Strings representing the ids of the form elements for wish you wish to accumulate the values. The Strings must be the value of the element's name attribute.

For example, these are all valid uses:

ajaxRequest.addFormElementsById("element-id-1");
ajaxRequest.addFormElementsById("element-id-1", "element-id-2", "element-id-3");

addNamedFormElements

void addNamedFormElements()

Add the values of the named form elements to the query string to be sent to the server as part of the Ajax request. This method takes any number of Strings representing the form elements for wish you wish to accumulate the values. The Strings must be the value of the element's name attribute.

For example, these are all valid uses:

ajaxRequest.addNamedFormElements("element-name-1");
ajaxRequest.addNamedFormElements("element-name-1", "element-name-2", "element-name-3");

addNamedFormElementsByFormID

void addNamedFormElementsByFormID()

Same as addNamedFormElements, except it will filter form elements by form's id. For example, these are all valid uses:

ajaxRequest.addNamedFormElements("form-id""element-name-1");
ajaxRequest.addNamedFormElements("form-id","element-name-1", "element-name-2", "element-name-3");

addNameValuePair

void addNameValuePair(<String> name, <String> value)

Add the name/value pair to the query string.

Parameters:
name -
value -

addPostRequest

void addPostRequest(func)

Add a function to the list of post request functions. The post request functions are called in the order in which they were added. This method is similar to setPostRequest, except that method overwrites any previous post request method. This one adds to the list of functions that are called after the response has been received.

Parameters:
A - function to be called after receiving the Ajax response. The function is passed a reference of this AjaxRequest object.

addPreRequest

void addPreRequest(func)

Add a function to the list of pre request functions that will be called before the request is sent to the server. The pre request function has passed to it this AjaxRequest object. This method is similar to setPreRequest, except that method overwrites the previously existing pre request method, while this one adds a function to the list of functions. Pre request functions are called in the order in which they were added.

Parameters:
A - function to be called prior to sending the Ajax request. The function has passed to it this AjaxRequest object.

getParser

Object getParser()

Return the parser that wil be used to parse the reponse to this request.

getPostRequest

Object getPostRequest()

Return the post request function.

getQueryString

Object getQueryString()

Return the query string.

Returns:
The query string.

getXMLHttpRequestObject

Object getXMLHttpRequestObject()

Return the instance of the XMLHttpRequest object wrapped by this object.

Returns:
XMLHttpRequest

isEchoDebugInfo

Object isEchoDebugInfo()

Indicate if debugging is enabled.

Returns:
boolean

sendRequest

void sendRequest()

Send the Ajax request.

setAsync

void setAsync(<Boolean> asyncBoolean)

Parameters:
asyncBoolean - , set to true if asynchronous request, false synchronous request.

setEchoDebugInfo

void setEchoDebugInfo()

Enable client-side debugging. The server's response will be written to a text area appended to the bottom of the page. If parsing is performed on the client side, then the results of the parsing operations are shown in their own text areas.

setErrorHandler

void setErrorHandler(func)

Parameters:
Set - the error handler function that is called if the server's HTTP response code is something other than 200.

setParser

void setParser(newParser)

Parameters:
Set - the parser that's used to parse the server's XML response, Deaults to the standard TaconiteParser class.

setPostRequest

void setPostRequest(func)

Set the post-request function. This function will be called after the response has been received and after the response XML has been parsed. The post request function is passed a reference to this AjaxRequest object.

Parameters:
The - function to be called after receiving the Ajax response. The function is passed a reference of this AjaxRequest object.

setPreRequest

void setPreRequest(func)

Set the pre-request function. This function will be called prior to sending the Ajax request. The pre-request function is passed a reference to this AjaxRequest object.

Parameters:
The - function to be called prior to sending the Ajax request. The function has passed to it this AjaxRequest object.

setQueryString

void setQueryString(qs)

Set the query string that will be sent to the server. For GET requests, the query string is appended to the URL. For POST requests, the query string is sent in the request body. This method is useful, for example, if you want to send an XML string or JSON string to the server.

Parameters:
qa - , the new query string value.

setUseGET

void setUseGET()

Send the Ajax request using the GET method, where parameters are sent as a query string appended to the URL. This is the default behavior.

setUsePOST

void setUsePOST()

Send the Ajax request using the POST method. Use with caution -- some browsers do not support the POST method with the XMLHttpRequest object.