Function Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
$#!
 $
 __get, xajaxResponse
 __sleep, xajax
 __wakeup, xajax
 _detectURI, xajax
 _encodeArray, xajaxResponse
 _escape, xajax. tools
 _getFormValue, xajax. tools
 _getFormValues, xajax. tools
 _getScriptFilename, xajaxIncludeClientScript
 _insertIntoArray, xajaxPluginManager
 _internalSend
 _nodeToObject, xajax. tools
 _objectToXML
 _printArray_XML, xajaxResponse
 _printCommand_XML, xajaxResponse
 _printEscapedString_XML, xajaxResponse
 _printHeader_XML, xajaxResponse
 _printResponse_XML, xajaxResponse
 _sendHeaders, xajaxResponse
A
 abortRequest, xajax
 add, xajax.css
 addChild, xajaxControlContainer
 addCommand
 addFormValuesParameter, xajaxCall
 addHandler
 addOnPrefix, xajax. tools
 addOption
 addOptions
 addParameter
 addPluginCommand, xajaxResponse
 alert, xajaxResponse
 append
 assign
 autoCompressJavascript, xajax
C
 call
 canProcessRequest
 clear
 clearAttributes, xajaxControl
 clearChildren, xajaxControlContainer
 clearEvents, xajaxControl
 clearParameters
 clearTimer, xajax. callback
 clearVariables, xajaxCustomRequest
 clsOption, clsOption
 clsPage, clsPage
 clsSelect, clsSelect
 clsTable, clsTable
 clsTableUpdater
 clsTbody, clsTbody
 clsTd, clsTd
 clsTfoot, clsTfoot
 clsTh, clsTh
 clsThead, clsThead
 clsTr, clsTr
 completeRequest, xajax. debug
 completeResponse, xajax
 configure
 configureMany, xajax
 confirmCommands
 contextAppend
 contextAssign
 contextClear, xajaxResponse
 contextPrepend
 create
 createInput
Shortcut to xajax.tools.$.
xajax.debug.$ = xajax.tools.$; xajax.tools.$ = function(sId)
Catch any exceptions thrown while attempting to locate an HTML element by it’s unique name.
xajax.tools.$ = function(sId)
Shorthand for finding a uniquely named element within the document.
Shortcut to xajax.tools.$.
function &__get($sPluginName)
Magic function for PHP 5.
function __sleep()
function __wakeup()
function _detectURI()
Returns the current requests URL based upon the SERVER vars.
function _encodeArray(&$mData)
Recursively serializes a data structure in an array so that it can be sent to the browser.
xajax.tools._escape = function(data)
Determine if the specified value contains special characters and create a CDATA section so the value can be safely transmitted.
xajax.tools._getFormValue = function(aFormValues,
child,
submitDisabledElements,
prefix)
Used internally by xajax.tools._getFormValues to extract a single form value.
xajax.tools._getFormValues = function(aFormValues,
children,
submitDisabledElements,
prefix)
Used internally by xajax.tools.getFormValues to recursively get the value of form elements.
function _getScriptFilename($sFilename)
Returns the name of the script file, based on the current settings.
function _insertIntoArray(&$aPlugins,
&$objPlugin,
$nPriority)
Inserts an entry into an array given the specified priority number.
xajax._internalSend = function(oRequest)
This function is used internally by xajax to initiate a request to the server.
xajax.debug._internalSend = xajax._internalSend; xajax._internalSend = function(
   oRequest
)
Generate a message indicating that the xajax request is about the be sent to the server.
xajax.tools._nodeToObject = function(node)
Deserialize a javascript object from an XML node.
xajax.debug._objectToXML = xajax.tools._objectToXML; xajax.tools._objectToXML = function(
   obj,
   guard
)
Generate a message indicating that a javascript object is being converted to xml.
xajax.tools._objectToXML = function(obj,
guard)
Convert a javascript object or array into XML suitable for transmission to the server.
function _printArray_XML(&$mArray)
Prints an XML representation of a php array suitable for inclusion in the response to the browser.
function _printCommand_XML(&$aAttributes)
Prints an XML representation of the command.
function _printEscapedString_XML(&$sData)
Escape the specified data if necessary, so special characters in the command data does not interfere with the structure of the response.
function _printHeader_XML()
Used internally to print XML start tag.
function _printResponse_XML()
Used internally to generate the command output.
function _sendHeaders()
Used internally to generate the response headers.
xajax.abortRequest = function(oRequest)
Abort the request.
xajax.css.add = function(filename)
Add a LINK reference to the specified .css file if it does not already exist in the HEAD of the current document.
function addChild(&$objControl)
Adds a control to the array of child controls.
function addCommand($aAttributes,
$mData)
Add a response command to the array of commands that will be sent to the browser.
function addCommand($aAttributes,
$sData)
Used internally to add a command to the response command list.
function addFormValuesParameter($sFormID)
Add a parameter value that is the result of calling xajax.getFormValues for the specified form.
Add an event handler to the specified element.
function addHandler(&$xuf)
Adds a xajaxUserFunction object to the list of handlers that will be fired when the event is triggered.
function addHandler($sTarget,
$sEvent,
$sHandler)
Response command used to install an event handler on the specified element.
xajax.tools.addOnPrefix = function(sEventName)
Detect, and add if not found, the prefix ‘on’ from the specified string.
function addOption($sValue,
$sText)
Used to add a single option to the options list.
function addOption($sValue,
$sText)
Used to add a single option to the options list.
function addOptions($aOptions,  
$aFields = array())
Used to add a list of options.
function addOptions($aOptions,  
$aFields = array())
Used to add a list of options.
function addParameter($sParameter,  
$bUseQuotes =  true)
Adds a parameter to the list that will be specified for the request generated by this xajaxCall object.
function addParameter()
Adds a parameter value to the parameter list for this request.
function addPluginCommand($objPlugin,
$aAttributes,
$mData)
Adds a response command that is generated by a plugin.
function alert($sMsg)
Response command that is used to display an alert message to the user.
xajax.dom.append = function(element,
property,
data)
Append the specified value to an element’s attribute.
function append($sTarget,
$sAttribute,
$sData)
Response command that indicates the specified data should be appended to the given element’s property.
function append($mResponse)
Used, primarily internally, to append one response object onto the end of another.
if (xajax.dom.assign)
Catch any exceptions thrown during the assignment and display an error message.
xajax.dom.assign = function(element,
property,
data)
Assign an element’s attribute to the specified value.
function assign($sTarget,
$sAttribute,
$sData)
Response command indicating that the specified value should be assigned to the given element’s attribute.
function autoCompressJavascript($sJsFullFilename = NULL,
$bAlways = false)
Creates a new xajax_core, xajax_debug, etc...
xajax.call = function()
Initiates a call to the server.
xajax.debug.call = xajax.call; xajax.call = function()
Validates that a function name was provided, generates a message indicating that a xajax call is starting and sets a flag in the request object indicating that debugging is enabled for this call.
xajax.js.call = function(args)
Call a javascript function with a series of parameters using the current script context.
xajax.legacy.call = xajax.call; xajax.call = function(sFunction,
objParameters)
Convert call parameters from the 0.2.x syntax to the new improved call format.
function call($sMethod,
$aArgs)
Call the specified method of the object being referenced using the specified array of arguments.
function call()
Response command that indicates that the specified javascript function should be called with the given (optional) parameters.
function call($aArgs = array())
Called by the xajaxPlugin that references this function during the request processing phase.
Shortcut to xajax.call.
function canProcessRequest()
Determines if a call is a xajax request or a page load request.
function canProcessRequest()
function canProcessRequest()
function canProcessRequest()
Determines whether or not the current request can be processed by this plugin.
function canProcessRequest()
Calls each of the request plugins and determines if the current request can be processed by one of them.
function canProcessRequest()
Called by the xajaxPluginManager when a request has been received to determine if the request is for a xajax enabled function or for the initial page load.
function canProcessRequest()
Called by the xajaxPluginManager to determine if this plugin can process the current request.
function clear($sTarget,
$sAttribute)
Response command used to clear the specified property of the given element.
function clear()
Clear the current response.
function clearAttributes()
Removes all attributes assigned to this control.
function clearChildren()
Clears the list of child controls associated with this control.
function clearEvents()
Clear the events that have been associated with this object.
function clearParameters()
Clear the list of parameters being accumulated for this call.
function clearParameters()
Clears the parameter list associated with this request.
xajax.callback.clearTimer = function(oCallback,
sFunction)
Clear a callback timer for the specified function.
function clearVariables()
Clears the array of variables that will be used to modify the script before it is printed and sent to the client.
function clsOption($aConfiguration = array())
Constructs and initializes an instance of this class.
function clsPage()
Constructor
function clsSelect($aConfiguration = array())
Construct and initialize an instance of the class.
function clsTable($aConfiguration = array())
Constructs and initializes an instance of the class.
Constructs and initializes an instance of the table updater class.
function clsTableUpdater()
Constructs and initializes an instance of the table updater class.
function clsTbody($aConfiguration = array())
Constructs and initializes an instance of the class.
function clsTd($aConfiguration = array())
Constructs and initializes an instance of the class.
function clsTfoot($aConfiguration = array())
Constructs and initializes an instance of the class.
function clsTh($aConfiguration = array())
Constructs and initializes an instance of the class.
function clsThead($aConfiguration = array())
Constructs and initializes an instance of the class.
function clsTr($aConfiguration = array())
Constructs and initializes an instance of the class.
Generate a message indicating that the request has completed and provide some statistics regarding the request and response.
xajax.completeResponse = function(oRequest)
Called by the response command queue processor when all commands have been processed.
function configure($sName,
$mValue)
Receives configuration settings set by xajax or user script calls to xajax->configure.
function configure($sName,
$mValue)
Receives configuration settings set by xajax or user script calls to xajax->configure.
function configure($sName,
$mValue)
Call this function to set options that will effect the processing of xajax requests.
function configure($sName,
$mValue)
Accepts configuration settings from the main xajax object.
function configure($sMethod,
$sName,
$sValue)
Used to set configuration options / call options for each method.
function configure($sName,
$mValue)
function configure($sName,
$mValue)
Sets/stores configuration options that will be used when generating the client script that is sent to the browser.
function configure($sName,
$mValue)
function configure($sName,
$mValue)
Sets/stores configuration options used by this plugin.
function configure($sName,
$mValue)
function configure($sName,
$mValue)
xajax::configure.
function configure($sName,
$mValue)
Call each of the request plugins passing along the configuration setting specified.
function configure($sName,
$mValue)
Called by the xajaxPluginManager when a configuration setting is changing.
function configure($sName,
$mValue)
Called by the xajax object when configuration options are set in the main script.
function configure($sName,
$mValue)
xajax::configure.
function configure($sName,
$sValue)
Call this to set call options for this instance.
function configureMany($aOptions)
Set an array of configuration options.
xajax.js.confirmCommands = function(msg,
numberOfCommands)
Prompt the user with the specified text, if the user responds by clicking cancel, then skip the specified number of commands in the response command queue.
function confirmCommands($iCmdNumber,
$sMessage)
Response command that prompts user with [ok] [cancel] style message box.
xajax.dom.contextAppend = function(args)
Appends a value to a named member of the current script context object.
function contextAppend($sAttribute,
$sData)
Response command used to append a value onto the specified member of the javascript context object (or element) specified by the context member of the request.
xajax.dom.contextAssign = function(args)
Assign a value to a named member of the current script context object.
function contextAssign($sAttribute,
$sData)
Response command used to assign a value to a member of a javascript object (or element) that is specified by the context member of the request.
function contextClear($sAttribute)
Response command used to clear the value of the property specified in the sAttribute parameter.
xajax.dom.contextPrepend = function(args)
Prepend a value to a named member of the current script context object.
function contextPrepend($sAttribute,
$sData)
Response command used to prepend the speicified data to the given member of the current javascript object specified by context in the current request.
xajax.callback.create = function()
Create a blank callback object.
xajax.dom.create = function(objParent,
sTag,
sId)
Create a new element and append it to the specified parent element.
xajax.tools.queue.create = function(size)
Construct and return a new queue object.
function create($sParent,  
$sTag,  
$sId,  
$sType = null)
Response command used to create a new element on the browser.
xajax.forms.createInput = function(objParent,
sType,
sName,
sId)
Create a new input element under the specified parent.
function createInput($sParent,
$sType,
$sName,
$sId)
Response command used to create an input element on the browser.