PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class 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.
  • HasPriority true to ensure that the callback request will be sent immediately and will abort existing prioritized requests. It does not affect callbacks that are not prioritized.
  • EnablePageStateUpdate enable the callback response to enable the viewstate update. This will automatically set HasPriority to true when enabled.
TComponent
Extended by TClientSideOptions
Extended by TCallbackClientSide

Direct known subclasses

TActiveCustomValidatorClientSide, TActiveDatePickerClientScript
Package: System\Web\UI\ActiveControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Wei Zhuo <weizhuo[at]gamil[dot]com>
Since: 3.1
Located at Web/UI/ActiveControls/TCallbackClientSide.php
Methods summary
protected string
# ensureFunction( string $javascript )

Returns javascript statement enclosed within a javascript function.

Returns javascript statement enclosed within a javascript function.

Parameters

$javascript
string
javascript statement

Returns

string
javascript statement wrapped in a javascript function

Overrides

TClientSideOptions::ensureFunction()
public
# setOnPreDispatch( string $javascript )

Parameters

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

Returns

string
javascript code to be executed before a request is dispatched.
public string
# getOnUninitialized( )

Returns

string
javascript code for client-side onUninitialized event
public
# setOnUninitialized( string $javascript )

Parameters

$javascript
string
javascript code for client-side onUninitialized event.
public string
# getOnLoading( )

Returns

string
javascript code for client-side onLoading event
public
# setOnLoading( string $javascript )

Parameters

$javascript
string
javascript code for client-side onLoading event.
public string
# getOnLoaded( )

Returns

string
javascript code for client-side onLoaded event
public
# setOnLoaded( string $javascript )

Parameters

$javascript
string
javascript code for client-side onLoaded event.
public string
# getOnInteractive( )

Returns

string
javascript code for client-side onInteractive event
public
# setOnInteractive( string $javascript )

Parameters

$javascript
string
javascript code for client-side onInteractive event.
public string
# getOnComplete( )

Returns

string
javascript code for client-side onComplete event
public
# setOnComplete( string $javascript )

Parameters

$javascript
string
javascript code for client-side onComplete event.
public string
# getOnSuccess( )

Returns

string
javascript code for client-side onSuccess event
public
# setOnSuccess( string $javascript )

Parameters

$javascript
string
javascript code for client-side onSuccess event.
public string
# getOnFailure( )

Returns

string
javascript code for client-side onFailure event
public
# setOnFailure( string $javascript )

Parameters

$javascript
string
javascript code for client-side onFailure event.
public string
# getOnException( )

Returns

string
javascript code for client-side onException event
public
# setOnException( string $javascript )

Parameters

$javascript
string
javascript code for client-side onException event.
public boolean
# getPostState( )

Returns

boolean
true to post the inputs of the form on callback, default is post the inputs on callback.
public
# setPostState( boolean $value )

Parameters

$value
boolean
true to post the inputs of the form with callback requests. Default is to post the inputs.
public integer
# getRequestTimeOut( )

Returns

integer
callback request timeout.
public
# setRequestTimeOut( integer $value )

Parameters

$value
integer
callback request timeout
public boolean
# getHasPriority( )

Returns

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.
public
# setHasPriority( boolean $value )

Parameters

$value
boolean
true to ensure that the callback request will be sent immediately and will abort existing prioritized requests. It does not affect callbacks that are not prioritized.
public
# setEnablePageStateUpdate( boolean $value )

Set to true to enable the callback response to enable the viewstate update. This will automatically set HasPrority to true.

Set to true to enable the callback response to enable the viewstate update. This will automatically set HasPrority to true.

Parameters

$value
boolean
true enables the callback response to update the viewstate.
public boolean
# getEnablePageStateUpdate( )

Returns

boolean
client-side viewstate will be updated on callback response if true. Default is true.
public string
# getPostBackTarget( )

Returns

string
post back target ID
public
# setPostBackTarget( string $value )

Parameters

$value
string
post back target ID
public string
# getPostBackParameter( )

Returns

string
post back event parameter.
public
# setPostBackParameter( string $value )

Parameters

$value
string
post back event parameter.
Methods inherited from TClientSideOptions
getOption(), getOptions(), setFunction(), setOption()
Methods inherited from TComponent
__call(), __construct(), __destruct(), __get(), __isset(), __set(), __sleep(), __unset(), __wakeup(), addParsedObject(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO