Class \Prado\Web\UI\ActiveControls\TCallbackClientSide

TCallbackClientSide class.

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.
RetryLimit The number of times the request is retried when it timeouts, default 1
EnablePageStateUpdate enable the callback response to enable the viewstate update.

Class hierarchy

\Prado\Web\UI\ActiveControls\TCallbackClientSide

\Prado\Web\UI\TClientSideOptions

\Prado\TComponent

Author: Wei Zhuo <weizhuo[at]gamil[dot]com>
Since: 3.1

Methods summary
`public`	`getEnablePageStateUpdate() : bool`
`public`	`getOnComplete() : string`
`public`	`getOnException() : string`
`public`	`getOnFailure() : string`
`public`	`getOnInteractive() : string`
`public`	`getOnLoaded() : string`
`public`	`getOnLoading() : string`
`public`	`getOnPreDispatch() : string`
`public`	`getOnSuccess() : string`
`public`	`getOnUninitialized() : string`
`public`	`getPostBackParameter() : string`
`public`	`getPostBackTarget() : string`
`public`	`getPostState() : bool`
`public`	`getRequestTimeOut() : int`
`public`	`getRetryLimit() : int`
`public`	`setEnablePageStateUpdate(bool $value) : mixed` Set to true to enable the callback response to enable the viewstate update. This will automatically set HasPrority to true.
`public`	`setOnComplete(string $javascript) : mixed`
`public`	`setOnException(string $javascript) : mixed`
`public`	`setOnFailure(string $javascript) : mixed`
`public`	`setOnInteractive(string $javascript) : mixed`
`public`	`setOnLoaded(string $javascript) : mixed`
`public`	`setOnLoading(string $javascript) : mixed`
`public`	`setOnPreDispatch(string $javascript) : mixed`
`public`	`setOnSuccess(string $javascript) : mixed`
`public`	`setOnUninitialized(string $javascript) : mixed`
`public`	`setPostBackParameter(string $value) : mixed`
`public`	`setPostBackTarget(string $value) : mixed`
`public`	`setPostState(bool $value) : mixed`
`public`	`setRequestTimeOut(int $value) : mixed`
`public`	`setRetryLimit(bool $value) : mixed`
`protected`	`ensureFunction(string $javascript) : string` Returns javascript statement enclosed within a javascript function.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getOptions, getSubProperty, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, ensureFunction, getCallChain, getClassFxEvents, getOption, instanceBehavior, setFunction, setOption, filter_prado_fx

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\ActiveControls\TCallbackClientSide

Class hierarchy