xajaxEvent. inc.php

Definition of the xajax Event object.

Summary

xajaxEvent. inc.php	Definition of the xajax Event object.
xajaxEvent	Please see copyright.inc.php for a detailed description, copyright and license information.
xajaxEvent	A container class which holds a reference to handler functions and configuration options associated with a registered event.
Variables
sName	The name of the event.
aConfiguration	Configuration / call options to be used when initiating a xajax request to trigger this event.
aHandlers	A list of xajaxUserFunction objects associated with this registered event.
Functions
xajaxEvent	Construct and initialize this xajaxEvent object.
getName	Returns the name of the event.
configure	Sets/stores configuration options that will be used when generating the client script that is sent to the browser.
addHandler	Adds a xajaxUserFunction object to the list of handlers that will be fired when the event is triggered.
generateRequest	Generates a xajaxRequest object that corresponds to the event so that the client script can easily invoke this event.
generateClientScript	Generates a block of javascript code that declares a stub function that can be used to easily trigger the event from the browser.
fire	Called by the xajaxEventPlugin when the event has been triggered.

xajaxEvent

A container class which holds a reference to handler functions and configuration options associated with a registered event.

Summary

Variables
sName	The name of the event.
aConfiguration	Configuration / call options to be used when initiating a xajax request to trigger this event.
aHandlers	A list of xajaxUserFunction objects associated with this registered event.
Functions
xajaxEvent	Construct and initialize this xajaxEvent object.
getName	Returns the name of the event.
configure	Sets/stores configuration options that will be used when generating the client script that is sent to the browser.
addHandler	Adds a xajaxUserFunction object to the list of handlers that will be fired when the event is triggered.
generateRequest	Generates a xajaxRequest object that corresponds to the event so that the client script can easily invoke this event.
generateClientScript	Generates a block of javascript code that declares a stub function that can be used to easily trigger the event from the browser.
fire	Called by the xajaxEventPlugin when the event has been triggered.

function generateRequest( $sXajaxPrefix,
$sEventPrefix )

Generates a xajaxRequest object that corresponds to the event so that the client script can easily invoke this event.

sXajaxPrefix	(string): The prefix that will be prepended to the client script stub function associated with this event.
sEventPrefix	(string): The prefix prepended to the client script function stub and xajaxRequest script.