Class TActiveControlAdapter

Description

TActiveControlAdapter class.

Customize the parent TControl class for active control classes. TActiveControlAdapter instantiates a common base active control class throught the BaseActiveControl property. The type of BaseActiveControl can be provided in the second parameter in the constructor. Default is TBaseActiveControl or TBaseActiveCallbackControl if the control adapted implements ICallbackEventHandler.

TActiveControlAdapter will tracking viewstate changes to update the corresponding client-side properties.

  • author: Wei Zhuo <weizhuo[at]gmail[dot]com>
  • version: $Id: TActiveControlAdapter.php 3159 2012-06-01 18:01:40Z ctrlaltca $
  • since: 3.1

Located in /Web/UI/ActiveControls/TActiveControlAdapter.php (line 36)

TComponent
   |
   --TApplicationComponent
      |
      --TControlAdapter
         |
         --TActiveControlAdapter
Direct descendents
Class Description
TActiveListControlAdapter TActiveListControlAdapter class.
Method Summary
TActiveControlAdapter __construct ( $control, [string $baseCallbackClass = null])
void onLoad ( $param)
void onPreRender ( $param)
void render ( $writer)
void saveState ()
void setBaseControlClass (string $type)
Variables

Inherited Variables

Inherited from TControlAdapter

TControlAdapter::$_control
Methods
Constructor __construct (line 56)

Constructor.

  • access: public
TActiveControlAdapter __construct ( $control, [string $baseCallbackClass = null])
  • IActiveControl $control: active control to adapt.
  • string $baseCallbackClass: Base active control class name.

Redefinition of:
TControlAdapter::__construct()
Constructor.
getBaseActiveControl (line 131)
  • return: Common active control options.
  • access: public
TBaseActiveControl getBaseActiveControl ()
getIsTrackingPageState (line 144)
  • return: true if the viewstate needs to be tracked.
  • access: protected
boolean getIsTrackingPageState ()
getStateTracker (line 188)
  • return: state tracker.
  • access: public
TCallbackPageStateTracker getStateTracker ()
onLoad (line 161)

Starts viewstate tracking if necessary after when controls has been loaded

  • access: public
void onLoad ( $param)
  • $param

Redefinition of:
TControlAdapter::onLoad()
This method is invoked when the control enters 'OnLoad' stage.
onPreRender (line 81)

Publish the ajax script

  • access: public
void onPreRender ( $param)
  • $param

Redefinition of:
TControlAdapter::onPreRender()
This method is invoked when the control enters 'OnPreRender' stage.
render (line 89)

Renders the callback client scripts.

  • access: public
void render ( $writer)
  • $writer

Redefinition of:
TControlAdapter::render()
This method is invoked when the control renders itself.
renderCallbackClientScripts (line 104)

Register the callback clientscripts and sets the post loader IDs.

  • access: protected
void renderCallbackClientScripts ()
saveState (line 175)

Saves additional persistent control state. Respond to viewstate changes if necessary.

  • access: public
void saveState ()

Redefinition of:
TControlAdapter::saveState()
Saves additional persistent control state.
setBaseActiveControl (line 123)
  • access: public
void setBaseActiveControl (TBaseActiveControl $control)
setBaseControlClass (line 65)
  • access: protected
void setBaseControlClass (string $type)
  • string $type: base active control instance

Inherited Methods

Inherited From TControlAdapter

TControlAdapter::__construct()
TControlAdapter::createChildControls()
TControlAdapter::getControl()
TControlAdapter::getPage()
TControlAdapter::loadState()
TControlAdapter::onInit()
TControlAdapter::onLoad()
TControlAdapter::onPreRender()
TControlAdapter::onUnload()
TControlAdapter::render()
TControlAdapter::renderChildren()
TControlAdapter::saveState()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()

Documentation generated on Mon, 25 Jun 2012 14:36:53 +0200 by phpDocumentor 1.4.3