API DOCS

DOCS & TUTORIALS » API DOCS » xajax_core » plugin_layer » support » xajaxEvent.inc.php » xajaxEvent

Class: xajaxEvent



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

variables

functions

xajaxEvent

function xajaxEvent($sName)

Construct and initialize this object.

getName

function getName()

Returns the name of the event.


configure

function configure($sName, $mValue)

Sets/stores configuration options that will be used when generating
the client script that is sent to the browser.

addHandler

function addHandler(&$xuf)

Adds a object to the list of handlers that will
be fired when the event is triggered.

generateRequest

function generateRequest($sXajaxPrefix, $sEventPrefix)

Generates a 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 script.

fire

function fire($aArgs)

Called by the when the event has been triggered.

 



XAJAX on SourceForge.net
Support this project Valid XHTML 1.0 Transitional