Class Index | File Index

Classes


Namespace jsf.ajax

The namespace for Ajax functionality.
Defined in: jsf.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
The namespace for Ajax functionality.
Method Summary
Method Attributes Method Name and Description
<static>  
jsf.ajax.addOnError(callback)
Register a callback for error handling.
<static>  
jsf.ajax.addOnEvent(callback)
Register a callback for event handling.
<static>  
jsf.ajax.request(source, event, options)

Send an asynchronous Ajax request to the server.

<static>  
jsf.ajax.response(request, context)

Receive an Ajax response from the server.

Namespace Detail
jsf.ajax
The namespace for Ajax functionality.
Method Detail
<static> jsf.ajax.addOnError(callback)
Register a callback for error handling.

Usage:


jsf.ajax.addOnError(handleError);
...
var handleError = function handleError(data) {
...
}

Implementation Requirements:

This function must accept a reference to an existing JavaScript function. The JavaScript function reference must be added to a list of callbacks, making it possible to register more than one callback by invoking jsf.ajax.addOnError more than once. This function must throw an error if the callback argument is not a function.
Parameters:
callback
a reference to a function to call on an error

<static> jsf.ajax.addOnEvent(callback)
Register a callback for event handling.

Usage:


jsf.ajax.addOnEvent(statusUpdate);
...
var statusUpdate = function statusUpdate(data) {
...
}

Implementation Requirements:

This function must accept a reference to an existing JavaScript function. The JavaScript function reference must be added to a list of callbacks, making it possible to register more than one callback by invoking jsf.ajax.addOnEvent more than once. This function must throw an error if the callback argument is not a function.
Parameters:
callback
a reference to a function to call on an event

<static> jsf.ajax.request(source, event, options)

Send an asynchronous Ajax request to the server.

Usage:


Example showing all optional arguments:

<commandButton id="button1" value="submit"
    onclick="jsf.ajax.request(this,event,
      {execute:'button1',render:'status',onevent: handleEvent,onerror: handleError});return false;"/>
</commandButton/>

Implementation Requirements:

This function must: Before the request is sent it must be put into a queue to ensure requests are sent in the same order as when they were initiated. The request callback function must examine the queue and determine the next request to be sent. The behavior of the request callback function must be as follows:
  • If the request completed successfully invoke jsf.ajax.response passing the request object.
  • If the request did not complete successfully, notify the client.
  • Regardless of the outcome of the request (success or error) every request in the queue must be handled. Examine the status of each request in the queue starting from the request that has been in the queue the longest. If the status of the request is complete (readyState 4), dequeue the request (remove it from the queue). If the request has not been sent (readyState 0), send the request. Requests that are taken off the queue and sent should not be put back on the queue.

Parameters:
source
The DOM element that triggered this Ajax request, or an id string of the element to use as the triggering element.
event
The DOM event that triggered this Ajax request. The event argument is optional.
options
The set of available options that can be sent as request parameters to control client and/or server side request processing. Acceptable name/value pair options are:
name value
execute space seperated list of client identifiers
render space seperated list of client identifiers
onevent function to callback for event
onerror function to callback for error
params object containing parameters to include in the request
The options argument is optional.
Throws:
ArgNotSet Error if first required argument element is not specified

<static> jsf.ajax.response(request, context)

Receive an Ajax response from the server.

Usage:


jsf.ajax.response(request, context);

Implementation Requirements:

This function must evaluate the markup returned in the request.responseXML object and perform the following action:

    If there is no XML response returned, signal an emptyResponse error. If the XML response does not follow the format as outlined in Appendix A of the spec prose document linked in the overview summary signal a malformedError error. Refer to section "Signaling Errors" in Chapter 13 of the spec prose document linked in the overview summary.

    If the response was successfully processed, send a success event as outlined in Chapter 13 "Sending Events" section of the spec prose document linked in the overview summary.

    Update Element Processing

  • If an update element is found in the response with the identifier javax.faces.ViewRoot:
    <update id="javax.faces.ViewRoot">
       <![CDATA[...]]>
    </update>
    Update the entire DOM replacing the appropriate head and/or body sections with the content from the response.
  • If an update element is found in the response with the identifier javax.faces.ViewState:
    <update id="javax.faces.ViewState">
       <![CDATA[...]]>
    </update>
    locate and update the submitting form's javax.faces.ViewState value with the CDATA contents from the response.
  • If an update element is found in the response with the identifier javax.faces.ViewHead:
    <update id="javax.faces.ViewHead">
       <![CDATA[...]]>
    </update>
    update the document's head section with the CDATA contents from the response.
  • If an update element is found in the response with the identifier javax.faces.ViewBody:
    <update id="javax.faces.ViewBody">
       <![CDATA[...]]>
    </update>
    update the document's body section with the CDATA contents from the response.
  • For any other <update> element:
    <update id="update id">
       <![CDATA[...]]>
    </update>
    Find the DOM element with the identifier that matches the <update> element identifier, and replace its contents with the <update> element's CDATA contents.
  • Insert Element Processing

  • If an <insert> element is found in the response with the attribute before:
    <insert id="insert id" before="before id">
       <![CDATA[...]]>
    </insert>
    • Extract this <insert> element's CDATA contents from the response.
    • Find the DOM element whose identifier matches before id and insert the <insert> element's CDATA content before the DOM element in the document.
  • If an <insert> element is found in the response with the attribute after:
    <insert id="insert id" after="after id">
       <![CDATA[...]]>
    </insert>
    • Extract this <insert> element's CDATA contents from the response.
    • Find the DOM element whose identifier matches after id and insert the <insert> element's CDATA content after the DOM element in the document.
  • Delete Element Processing

  • If a <delete> element is found in the response:
    <delete id="delete id"/>
    Find the DOM element whose identifier matches delete id and remove it from the DOM.
  • Element Attribute Update Processing

  • If an <attributes> element is found in the response:
    <attributes id="id of element with attribute">
       <attribute name="attribute name" value="attribute value">
       ...
    </attributes>
    • Find the DOM element that matches the <attributes> identifier.
    • For each nested <attribute> element in <attribute>, update the DOM element attribute value (whose name matches attribute name), with attribute value.
  • JavaScript Processing

  • If an <eval> element is found in the response:
    <eval>
       <![CDATA[...JavaScript...]]>
    </eval>
    • Extract this <eval> element's CDATA contents from the response and execute it as if it were JavaScript code.
  • Redirect Processing

  • If a <redirect> element is found in the response:
    <redirect url="redirect url"/>
    Cause a redirect to the url redirect url.
  • Error Processing

  • If an <error> element is found in the response:
    <error>
       <error-name>..fully qualified class name string...<error-name>
       <error-message><![CDATA[...]]><error-message>
    </error>
    Extract this <error> element's error-name contents and the error-message contents. Signal a serverError passing the errorName and errorMessage. Refer to section "Signaling Errors" in Chapter 13 of the spec prose document linked in the overview summary.
  • Extensions

  • The <extensions> element provides a way for framework implementations to provide their own information.

Parameters:
request
The XMLHttpRequest instance that contains the status code and response message from the server.
context
An object containing the request context, including the following properties: the source element, per call onerror callback function, and per call onevent callback function.
Throws:
EmptyResponse error if request contains no data

Documentation generated by JsDoc Toolkit 2.0.2 on Fri Jun 26 2009 07:35:50 GMT-0400 (EDT)