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
Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode 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 )

Méthodes protégées

Méthode Description
ensureFunction ( $javascript ) : string Returns javascript statement enclosed within a javascript function.

Method Details

ensureFunction() protected méthode

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

getEnablePageStateUpdate() public méthode

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

getHasPriority() public méthode

Deprecation: since 3.3.0
public getHasPriority ( ) : boolean
Résultat 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 méthode

public getOnComplete ( ) : string
Résultat string javascript code for client-side onComplete event

getOnException() public méthode

public getOnException ( ) : string
Résultat string javascript code for client-side onException event

getOnFailure() public méthode

public getOnFailure ( ) : string
Résultat string javascript code for client-side onFailure event

getOnInteractive() public méthode

public getOnInteractive ( ) : string
Résultat string javascript code for client-side onInteractive event

getOnLoaded() public méthode

public getOnLoaded ( ) : string
Résultat string javascript code for client-side onLoaded event

getOnLoading() public méthode

public getOnLoading ( ) : string
Résultat string javascript code for client-side onLoading event

getOnPreDispatch() public méthode

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

getOnSuccess() public méthode

public getOnSuccess ( ) : string
Résultat string javascript code for client-side onSuccess event

getOnUninitialized() public méthode

public getOnUninitialized ( ) : string
Résultat string javascript code for client-side onUninitialized event

getPostBackParameter() public méthode

public getPostBackParameter ( ) : string
Résultat string post back event parameter.

getPostBackTarget() public méthode

public getPostBackTarget ( ) : string
Résultat string post back target ID

getPostState() public méthode

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

getRequestTimeOut() public méthode

public getRequestTimeOut ( ) : integer
Résultat integer callback request timeout.

setEnablePageStateUpdate() public méthode

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 méthode

Deprecation: since 3.3.0
public setHasPriority ( $value )

setOnComplete() public méthode

public setOnComplete ( $javascript )

setOnException() public méthode

public setOnException ( $javascript )

setOnFailure() public méthode

public setOnFailure ( $javascript )

setOnInteractive() public méthode

public setOnInteractive ( $javascript )

setOnLoaded() public méthode

public setOnLoaded ( $javascript )

setOnLoading() public méthode

public setOnLoading ( $javascript )

setOnPreDispatch() public méthode

public setOnPreDispatch ( $javascript )

setOnSuccess() public méthode

public setOnSuccess ( $javascript )

setOnUninitialized() public méthode

public setOnUninitialized ( $javascript )

setPostBackParameter() public méthode

public setPostBackParameter ( $value )

setPostBackTarget() public méthode

public setPostBackTarget ( $value )

setPostState() public méthode

public setPostState ( $value )

setRequestTimeOut() public méthode

public setRequestTimeOut ( $value )