Function Index

Functions

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

S
	save, graffiti
	scribble
	script, xajaxResponse
	send, xajaxResponseManager
	sendAlert Global clsPage
	sendConfirmCommands Global clsPage
	setAttribute, xajaxControl
	setCharacterEncoding, xajaxResponse
	setCharEncoding, xajax
	setColor
	setContentType, xajaxCall
	setDefault, xajax. config
	setDefaultMethod, xajax
	setDefaultMode, xajax
	setEvent xajax. events xajaxControl xajaxResponse
	setFlag, xajax
	setFlags, xajax
	setFunction xajax.js xajaxCall xajaxResponse
	setLogFile, xajax
	setMode, xajaxCall
	setOutputEntities, xajaxResponse
	setParameter, xajaxRequest
	setRequestType, xajaxCall
	setRequestURI xajax xajaxCall
	setResponse, xajaxResponsePlugin
	setResponseProcessor, xajaxCall
	setReturnValue xajaxCall xajaxResponse
	setText, clsOption
	setupTimer, xajax. callback
	setValue, clsOption
	setVariable, xajaxCustomRequest
	setWakeup, xajax. tools. queue
	setWrapperPrefix, xajax
	singleQuotes, xajax. tools
	sleep xajax.js xajaxResponse
	stripOnPrefix, xajax. tools
	submitRequest xajax xajax. debug
T
	test
U
	update xajax. config. cursor xajax. config. status
	updateWall
	useDoubleQuote, xajaxRequest
	useSingleQuote, xajaxRequest
W
	waitFor xajax.js xajaxResponse
	waitForCSS xajax.css xajaxResponse
	willChange, xajax. tools
	wrapFunction xajax.js xajaxResponse
	writeMessage, xajax. debug

function save()

Writes the current graffiti->html to the DATA_FILE when graffiti->isValid or returns an error message.

function scribble( $aFormValues )

Processes the users form input and passes the values to an instance of the graffiti class.

function script( $sJS )

Response command that is used to execute a portion of javascript on the browser.

function send()

Prints the response object to the output stream, thus sending the response to the client.

function sendAlert( $sValue )

See clsPage->sendAlert

function sendAlert( $sValue )

Generates a xajaxResponse->alert command that displays a message.

function sendConfirmCommands()

See clsPage->sendAlert

function sendConfirmCommands()

Generates a xajaxResponse->confirmCommands command that will prompt the user if they want to see the alert, then a xajaxResponse->alert command.

function setAttribute( $sName,
$sValue )

Call to set various control specific attributes to be included in the HTML script that is returned when xajaxControl->printHTML or xajaxControl->getHTML is called.

function setCharacterEncoding( $sCharacterEncoding )

Overrides the default character encoding (or the one specified in the constructor) to the specified character encoding.

function setCharEncoding( $sEncoding )

Sets the character encoding that will be used for the HTTP output.

function setColor( $sColor )

Modify the style.color of div1

function setContentType( $sContentType )

Sets the content type that will be used by the generated request.

xajax.config.setDefault = function( option,
defaultValue )

This function will set a default configuration option if it is not already set.

function setDefaultMethod( $sMethod )

function setDefaultMode( $sDefaultMode )

Sets the default mode for requests from the browser.

xajax.events.setEvent = function( element,
sEvent,
code )

Set an event handler.

function setEvent( $sEvent,
& $objRequest,
$aParameters = array(),
$sBeforeRequest = '',
$sAfterRequest = '; return false;' )

Call this function to assign a xajaxRequest object as the handler for the specific DOM event.

function setEvent( $sTarget,
$sEvent,
$sScript )

Response command used to set an event handler on the browser.

function setFlag( $name,
$value )

Sets a single flag (boolean true or false).

function setFlags( $flags )

Sets a series of flags.

xajax.js.setFunction = function( args )

Constructs the specified function using the specified javascript as the body of the function.

function setFunction( $sFunction )

Override the function name set in the constructor.

function setFunction( $sFunction,
$sArgs,
$sScript )

Response command used to construct a javascript function on the browser.

function setLogFile( $sFilename )

Specifies a log file that will be written to by xajax during a request.

function setMode( $sMode )

Sets the mode that will be specified for this xajax.call

function setOutputEntities( $bOutputEntities )

Convert special characters to their HTML equivellent automatically (only works if the mb_string extension is available).

function setParameter()

Sets a specific parameter value.

function setRequestType( $sRequestType )

Sets the request type which will be specified for the generated xajax.call.

Sets the URI to which requests will be sent.

function setRequestURI( $sRequestURI )

Override the default URI with the specified one.

function setResponse( & $objResponse )

Called by the xajaxResponse object that is currently being used to build the response that will be sent to the client browser.

function setResponseProcessor( $sResponseProcessor )

Sets the name of the javascript function that will be used to process this response.

function setReturnValue( $sReturnValue )

Sets the value that will be returned after the generated call.

function setReturnValue( $value )

Stores a value that will be passed back as part of the response.

function setText( $sText )

Sets the text to be shown in the select control when this is the selected option.

xajax.callback.setupTimer = function( iDelay )

Create a timer to fire an event in the future.

function setValue( $sValue )

Used to set the value associated with this option.

function setVariable( $sName,
$sValue )

Sets a value that will be used to modify the script before it is sent to the browser.

xajax.tools.queue.setWakeup = function( theQ,
when )

Set or reset a timeout that is used to restart processing of the queue.

function setWrapperPrefix( $sPrefix )

Sets the prefix that will be prepended to the javascript wrapper functions.

xajax.tools.singleQuotes = function( haystack )

Replace all occurances of the double quote character with a single quote character.

xajax.js.sleep = function( args )

Causes the processing of items in the queue to be delayed for the specified amount of time.

function sleep( $tenths )

Response command which instructs xajax to pause execution of the response commands, returning control to the browser so it can perform other commands asynchronously.

xajax.tools.stripOnPrefix = function( sEventName )

Detect, and if found, remove the prefix ‘on’ from the specified string.

xajax.submitRequest = function( oRequest )

Create a request object and submit the request using the specified request type; all request parameters should be finalized by this point.

xajax.debug.submitRequest = xajax.submitRequest; xajax.submitRequest = function(
oRequest
)

Generate a message indicating that a request is ready to be submitted; providing the URL and the function being invoked.

function test()

alert ‘hallo’, then update the testButton’s label to ‘Success’

update: function()

Constructs and returns a set of event handlers that will be called by the xajax framework to effect the status of the cursor during requests.

update: function()

Constructs and returns a set of event handlers that will be called by the xajax framework to set the status bar messages.

function updateWall()

Processes the data previously written to the DATA_FILE by graffiti->save.

function useDoubleQuote()

Call this to instruct the request to use double quotes while generating the javascript.

function useSingleQuote()

Call this to instruct the request to use single quotes when generating the javascript.

xajax.js.waitFor = function( args )

Test for the specified condition, using the current script context; if the result is false, sleep for 1/10th of a second and try again.

function waitFor( $script,
$tenths )

Response command instructing xajax to delay execution of the response commands until a specified condition is met.

xajax.css.waitForCSS = function( args )

Attempt to detect when all .css files have been loaded once they are referenced by a LINK tag in the HEAD of the current document.

function waitForCSS( $iTimeout = 600 )

Response command instructing xajax to pause while the CSS files are loaded.

xajax.tools.willChange = function( element,
attribute,
newData )

Tests to see if the specified data is the same as the current value of the element’s attribute.

xajax.js.wrapFunction = function( args )

Construct a javascript function which will call the original function with the same name, potentially executing code before and after the call to the original function.

function wrapFunction( $sFunction,
$sArgs,
$aScripts,
$sReturnValueVariable )

Response command used to construct a wrapper function around and existing javascript function on the browser.

xajax.debug.writeMessage = function( text,
prefix,
cls )

Output a debug message to the debug window if available or send to an alert box.