PHP Class Prado\Web\UI\ActiveControls\TValueTriggeredCallback

Observes the value with {@link setPropertyName PropertyName} of a control with {@link setControlID ControlID}. Changes to the observed property value will trigger a new callback request. The property value is checked for changes every{@link setInterval Interval} seconds. A {@link setDecayRate DecayRate} can be set to increase the polling interval linearly if no changes are observed. Once a change is observed, the polling interval is reset to the original value.

Since: 3.1

Inheritance: extends TTriggeredCallback

Mostra file Open project: pradosoft/prado

Public Methods

Method	Description
getDecayRate ( ) : float	Gets the decay rate between callbacks. Default is 0;
getInterval ( ) : float
getPropertyName ( ) : string
render ( $writer )	Registers the javascript code for initializing the active control.
setDecayRate ( $value )	Sets the decay rate between callback. Default is 0;
setInterval ( $value )	Sets the polling interval in seconds to observe property changes.
setPropertyName ( $value )	Sets the control property name to observe value changes that fires the callback request.

Protected Methods

Method	Description
getClientClassName ( ) : string
getTriggerOptions ( ) : array

Method Details

getClientClassName() protected method

protected getClientClassName ( ) : string
return	string	corresponding javascript class name for TEventTriggeredCallback.

getDecayRate() public method

Gets the decay rate between callbacks. Default is 0;

public getDecayRate ( ) : float
return	float	decay rate between callbacks.

getInterval() public method

public getInterval ( ) : float
return	float	polling interval, 1 second default.

getPropertyName() public method

public getPropertyName ( ) : string
return	string	The control property name to observe value changes.

getTriggerOptions() protected method

protected getTriggerOptions ( ) : array
return	array	list of timer options for client-side.

render() public method

Registers the javascript code for initializing the active control.

public render ( $writer )

setDecayRate() public method

Sets the decay rate between callback. Default is 0;

public setDecayRate ( $value )

setInterval() public method

Default is 1 second.

public setInterval ( $value )

setPropertyName() public method

Sets the control property name to observe value changes that fires the callback request.

public setPropertyName ( $value )