## Class TCallbackPageStateTracker

Description

TCallbackPageStateTracker class.

Tracking changes to the page state during callback.

- since: 3.1
- version: $Id: TActiveControlAdapter.php 2773 2010-02-17 13:55:18Z Christophe.Boulain $
- author: Wei Zhuo <weizhuo[at]gmail[dot]com>

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

Method Summary
TCallbackPageStateTracker __construct (TControl $control)
void addStatesToTrack ()
TCallbackClientScript client ()
array getChanges ()
TMap getStatesToTrack ()
void respondToChanges ()
void trackChanges ()
void updateAccessKey (string $value)
void updateAttributes (array $attributes)
void updateEnabled (boolean $enable)
void updateStyle (array $style)
void updateTabIndex (integer $value)
void updateToolTip (string $value)
void updateVisible (boolean $visible)
Methods
Constructor __construct (line 214)

Constructor. Add a set of default states to track.

- access: public

TCallbackPageStateTracker __construct (TControl $control)

- TControl $control: control to track.

addStatesToTrack (line 231)

Add a list of view states to track. Each state is added to the StatesToTrack property with the view state name as key.

The value should be an array with two enteries. The first entery is the name of the class that will calculate the state differences. The second entry is a php function/method callback that handles the changes in the viewstate.

- access: protected

void addStatesToTrack ()
client (line 296)

- return: callback client scripting
- access: protected

TCallbackClientScript client ()
getChanges (line 267)

- return: list of viewstate and the changed data.
- access: protected

array getChanges ()
getStatesToTrack (line 246)

- return: list of viewstates to track.
- access: protected

TMap getStatesToTrack ()
respondToChanges (line 287)

For each of the changes call the corresponding change handlers.

- access: public

void respondToChanges ()
trackChanges (line 255)

Start tracking view state changes. The clone function on objects are called for those viewstate having an object as value.

- access: public

void trackChanges ()
updateAccessKey (line 323)

Updates the modifier access key

- access: protected

void updateAccessKey (string $value)

- string $value: access key

updateAttributes (line 366)

Updates/adds a list of attributes on the control.

- access: protected

void updateAttributes (array $attributes)

- array $attributes: list of attribute name-value pairs.

updateEnabled (line 345)

Enables or Disables the control on the client-side.

- access: protected

void updateEnabled (boolean $enable)

- boolean $enable: true to enable the control, false to disable.

updateStyle (line 354)

Updates the CSS style on the control on the client-side.

- access: protected

void updateStyle (array $style)

- array $style: list of new CSS style declarations.

updateTabIndex (line 314)

Updates the tab index.

- access: protected

void updateTabIndex (integer $value)

- integer $value: tab index

updateToolTip (line 305)

Updates the tooltip.

- access: protected

void updateToolTip (string $value)

- string $value: new tooltip

updateVisible (line 333)

Hides or shows the control on the client-side. The control must be already rendered on the client-side.

- access: protected

void updateVisible (boolean $visible)

- boolean $visible: true to show the control, false to hide.

Documentation generated on Mon, 22 Feb 2010 12:16:11 +0000 by phpDocumentor 1.3.0RC4