PHP Class Prado\Web\UI\ActiveControls\TCallbackPageStateTracker

Tracking changes to the page state during callback.
Since: 3.1
Datei anzeigen Open project: pradosoft/prado Class Usage Examples

Protected Properties

Property Type Description
$_control the control tracked

Public Methods

Method Description
__construct ( $control ) Constructor. Add a set of default states to track.
respondToChanges ( ) For each of the changes call the corresponding change handlers.
trackChanges ( ) Start tracking view state changes. The clone function on objects are called for those viewstate having an object as value.

Protected Methods

Method Description
addStatesToTrack ( ) Add a list of view states to track. Each state is added to the StatesToTrack property with the view state name as key.
client ( ) : TCallbackClientScript
getChanges ( ) : array
getStatesToTrack ( ) : TMap
updateAccessKey ( $value ) Updates the modifier access key
updateAttributes ( $attributes ) Updates/adds a list of attributes on the control.
updateEnabled ( $enable ) Enables or Disables the control on the client-side.
updateStyle ( $style ) Updates the CSS style on the control on the client-side.
updateTabIndex ( $value ) Updates the tab index.
updateToolTip ( $value ) Updates the tooltip.
updateVisible ( $visible ) Hides or shows the control on the client-side. The control must be already rendered on the client-side.

Method Details

__construct() public method

Constructor. Add a set of default states to track.
public __construct ( $control )

addStatesToTrack() protected method

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.
protected addStatesToTrack ( )

client() protected method

protected client ( ) : TCallbackClientScript
return TCallbackClientScript callback client scripting

getChanges() protected method

protected getChanges ( ) : array
return array list of viewstate and the changed data.

getStatesToTrack() protected method

protected getStatesToTrack ( ) : TMap
return Prado\Collections\TMap list of viewstates to track.

respondToChanges() public method

For each of the changes call the corresponding change handlers.
public respondToChanges ( )

trackChanges() public method

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

updateAccessKey() protected method

Updates the modifier access key
protected updateAccessKey ( $value )

updateAttributes() protected method

Updates/adds a list of attributes on the control.
protected updateAttributes ( $attributes )

updateEnabled() protected method

Enables or Disables the control on the client-side.
protected updateEnabled ( $enable )

updateStyle() protected method

Updates the CSS style on the control on the client-side.
protected updateStyle ( $style )

updateTabIndex() protected method

Updates the tab index.
protected updateTabIndex ( $value )

updateToolTip() protected method

Updates the tooltip.
protected updateToolTip ( $value )

updateVisible() protected method

Hides or shows the control on the client-side. The control must be already rendered on the client-side.
protected updateVisible ( $visible )

Property Details

$_control protected_oe property

the control tracked
protected $_control