PHP Class Prado\Web\UI\ActiveControls\TCallbackClientSide

The following client side events are executing in order if the callback request and response are send and received successfuly. - onPreDispatch executed before a request is dispatched. - onUninitialized executed when callback request is uninitialized. - onLoading* executed when callback request is initiated - onLoaded* executed when callback request begins. - onInteractive executed when callback request is in progress. - onCompleteexecuted when callback response returns. - onSuccess executed when callback request returns and is successful. - onFailure executed when callback request returns and fails. - onException raised when callback request fails due to request/response errors. * Note that theses 2 events are not fired correctly by Opera. To make them work in this browser, Prado will fire them just after onPreDispatch. In a general way, onUninitialized, onLoading, onLoaded and onInteractive events are not implemented consistently in all browsers.When cross browser compatibility is needed, it is best to avoid use them The OnSuccess and OnFailure events are raised when the response is returned. A successful request/response will raise OnSuccess event otherwise OnFailure will be raised. - PostState true to collect the form inputs and post them during callback, default is true. - RequestTimeOut The request timeout in milliseconds. - EnablePageStateUpdate enable the callback response to enable the viewstate update.
Since: 3.1
Inheritance: extends Prado\Web\UI\TClientSideOptions
Show file Open project: pradosoft/prado

Public Methods

Method Description
getEnablePageStateUpdate ( ) : boolean
getHasPriority ( ) : boolean
getOnComplete ( ) : string
getOnException ( ) : string
getOnFailure ( ) : string
getOnInteractive ( ) : string
getOnLoaded ( ) : string
getOnLoading ( ) : string
getOnPreDispatch ( ) : string
getOnSuccess ( ) : string
getOnUninitialized ( ) : string
getPostBackParameter ( ) : string
getPostBackTarget ( ) : string
getPostState ( ) : boolean
getRequestTimeOut ( ) : integer
setEnablePageStateUpdate ( $value ) Set to true to enable the callback response to enable the viewstate update. This will automatically set HasPrority to true.
setHasPriority ( $value )
setOnComplete ( $javascript )
setOnException ( $javascript )
setOnFailure ( $javascript )
setOnInteractive ( $javascript )
setOnLoaded ( $javascript )
setOnLoading ( $javascript )
setOnPreDispatch ( $javascript )
setOnSuccess ( $javascript )
setOnUninitialized ( $javascript )
setPostBackParameter ( $value )
setPostBackTarget ( $value )
setPostState ( $value )
setRequestTimeOut ( $value )

Protected Methods

Method Description
ensureFunction ( $javascript ) : string Returns javascript statement enclosed within a javascript function.

Method Details

ensureFunction() protected method

Returns javascript statement enclosed within a javascript function.
protected ensureFunction ( $javascript ) : string
return string javascript statement wrapped in a javascript function

getEnablePageStateUpdate() public method

public getEnablePageStateUpdate ( ) : boolean
return boolean client-side viewstate will be updated on callback response if true. Default is true.

getHasPriority() public method

Deprecation: since 3.3.0
public getHasPriority ( ) : boolean
return boolean true if the callback request has priority and will abort existing prioritized request in order to send immediately. It does not affect callbacks that are not prioritized. Default is true.

getOnComplete() public method

public getOnComplete ( ) : string
return string javascript code for client-side onComplete event

getOnException() public method

public getOnException ( ) : string
return string javascript code for client-side onException event

getOnFailure() public method

public getOnFailure ( ) : string
return string javascript code for client-side onFailure event

getOnInteractive() public method

public getOnInteractive ( ) : string
return string javascript code for client-side onInteractive event

getOnLoaded() public method

public getOnLoaded ( ) : string
return string javascript code for client-side onLoaded event

getOnLoading() public method

public getOnLoading ( ) : string
return string javascript code for client-side onLoading event

getOnPreDispatch() public method

public getOnPreDispatch ( ) : string
return string javascript code to be executed before a request is dispatched.

getOnSuccess() public method

public getOnSuccess ( ) : string
return string javascript code for client-side onSuccess event

getOnUninitialized() public method

public getOnUninitialized ( ) : string
return string javascript code for client-side onUninitialized event

getPostBackParameter() public method

public getPostBackParameter ( ) : string
return string post back event parameter.

getPostBackTarget() public method

public getPostBackTarget ( ) : string
return string post back target ID

getPostState() public method

public getPostState ( ) : boolean
return boolean true to post the inputs of the form on callback, default is post the inputs on callback.

getRequestTimeOut() public method

public getRequestTimeOut ( ) : integer
return integer callback request timeout.

setEnablePageStateUpdate() public method

Set to true to enable the callback response to enable the viewstate update. This will automatically set HasPrority to true.
public setEnablePageStateUpdate ( $value )

setHasPriority() public method

Deprecation: since 3.3.0
public setHasPriority ( $value )

setOnComplete() public method

public setOnComplete ( $javascript )

setOnException() public method

public setOnException ( $javascript )

setOnFailure() public method

public setOnFailure ( $javascript )

setOnInteractive() public method

public setOnInteractive ( $javascript )

setOnLoaded() public method

public setOnLoaded ( $javascript )

setOnLoading() public method

public setOnLoading ( $javascript )

setOnPreDispatch() public method

public setOnPreDispatch ( $javascript )

setOnSuccess() public method

public setOnSuccess ( $javascript )

setOnUninitialized() public method

public setOnUninitialized ( $javascript )

setPostBackParameter() public method

public setPostBackParameter ( $value )

setPostBackTarget() public method

public setPostBackTarget ( $value )

setPostState() public method

public setPostState ( $value )

setRequestTimeOut() public method

public setRequestTimeOut ( $value )