Class CAF.Ajax

Object
   |
   +--CAF.Ajax

class CAF.Ajax

Utilities for use with the standard f:ajax tag
Defined in core.js

Constructor Detail

CAF.Ajax

CAF.Ajax()

afterCompleted

<static> void afterCompleted(id, refreshedElementIds)

A CAF.Command.actionCompleteListener event is raised to notify any listeners that we have completed the action.

Parameters:
id - the of of the control that triggered the call

afterUpdate

<static> void afterUpdate(id)

Do some extra activities after an element has been updated 1. Raise CAF.Update event 2. Set defaultFocus (if specified) 3. FlashOnComplete animation (if specified)

Parameters:
id - the id of the element that was just updated

beforeRefresh

<static> Object beforeRefresh(data, toRefresh)

Call before a refresh action to calculate all the element that may be replaced by the refresh

Parameters:
data - the data object from the ajax lifecycle
toRefresh - (optional) the ids that the ajax call is refreshing (array or space seperated string)

Returns:
array of potentially affected element ids

beforeSubmit

<static> Object beforeSubmit(event, toExecute)

This function is usually used as the "onclick" handler of the command control. Performs Client-Side validation (when enabled). If any validation fails then this function returns false and blocks the action from continuing. Otherwise, a CAF.Command.actionListener event is raised to notify any listeners that we are about to invoke the action. If any of the action listeners set the cancelBubble flag on the actionEvent, then this function returns false and blocks the action from continuing.

Parameters:
event - the click event that triggered the call
toExecute - (optional) the ids that the ajax call is executing

Returns:
true if the action should continue, false otherwise

clientSideValidate

<static> Object clientSideValidate(event, toValidate)

Performs Client-Side validation (when enabled). If any validation fails then this function returns false.

Parameters:
event - the event that triggered the call
toValidate - (optional) the ids that the ajax call is executing

Returns:
true if the action should continue, false otherwise

handleResponse

<static> Object handleResponse(transport, options)

Parse and handle the response for a partial/ajax request.

Parameters:
transport - the request transport

onError

<static> void onError(data, finishedFn)

This function is usually used as the "onerror" handler of the CAF.Ajax.f = ajax;tag. Callback for errors that happen during the ajax lifecycle Special handling is provided to detect and handle these special cases: 1. Session invalid and login form returned. 2. Action rejected because the server has gone into in maintenance mode. Otherwise, the error message reported from the server is displayed

Parameters:
data - the data object from the ajax lifecycle
finshedFn - (optional) function to call after processing has finished

onEvent

<static> void onEvent(data, eventType, toRefresh, finshedFn)

This function is usually used as the "onevent" handler of the CAF.Ajax.f = ajax;tag. Callback for events that happen during the ajax lifecycle Shows progress indicator while the action is running. When complete, it will raise a CAF.Update event for all the elements whose content was updated.

Parameters:
data - the data object from the ajax lifecycle
eventType - (optional) if the CAF.Ajax.f = ajax;call is not for the 'onclick' event, specify the event type as an argument so it can help resolve what elements were in progress.
toRefresh - (optional) the ids that the ajax call is refreshing
finshedFn - (optional) function to call after processing has finished

raiseActionEvent

<static> Object raiseActionEvent(event)

A CAF.Command.actionListener event is raised to notify any listeners that we are about to invoke the action. If any of the action listeners set the cancelBubble flag on the actionEvent, then this function returns false and blocks the action from continuing.

Parameters:
event - the event that triggered the call

Returns:
true if the action should continue, false otherwise

startProgress

<static> void startProgress(data, toRefresh)

Begin the progress overlay for the elements being refreshed

Parameters:
data - the data object from the ajax lifecycle
toRefresh - (optional) the ids that the ajax call is refreshing (array or space seperated string)

stopProgress

<static> void stopProgress(data, eventType, toRefresh)

End the progress overlay for the elements being refreshed

Parameters:
data - the data object from the ajax lifecycle
eventType - if the CAF.Ajax.f = ajax;call is not for the 'onclick' event, specify the event type as an argument so it can resolve what elements were in progress.
toRefresh - (optional) the ids that the ajax call is refreshing (array or space seperated string)