1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
<?php
/**
* TValueTriggeredCallback class file.
*
* @author Wei Zhuo <weizhuo[at]gamil[dot]com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI\ActiveControls
*/
namespace Prado\Web\UI\ActiveControls;
use Prado\Exceptions\TConfigurationException;
use Prado\Prado;
use Prado\TPropertyValue;
/**
* TValueTriggeredCallback Class
*
* 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.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @package Prado\Web\UI\ActiveControls
* @since 3.1
*/
class TValueTriggeredCallback extends TTriggeredCallback
{
/**
* @return string The control property name to observe value changes.
*/
public function getPropertyName()
{
return $this->getViewState('PropertyName', '');
}
/**
* Sets the control property name to observe value changes that fires the callback request.
* @param string The control property name to observe value changes.
*/
public function setPropertyName($value)
{
$this->setViewState('PropertyName', $value, '');
}
/**
* Sets the polling interval in seconds to observe property changes.
* Default is 1 second.
* @param float polling interval in seconds.
*/
public function setInterval($value)
{
$this->setViewState('Interval', TPropertyValue::ensureFloat($value), 1);
}
/**
* @return float polling interval, 1 second default.
*/
public function getInterval()
{
return $this->getViewState('Interval', 1);
}
/**
* Gets the decay rate between callbacks. Default is 0;
* @return float decay rate between callbacks.
*/
public function getDecayRate()
{
return $this->getViewState('Decay', 0);
}
/**
* Sets the decay rate between callback. Default is 0;
* @param float decay rate between callbacks.
*/
public function setDecayRate($value)
{
$decay = TPropertyValue::ensureFloat($value);
if($decay < 0)
throw new TConfigurationException('callback_decay_be_not_negative', $this->getID());
$this->setViewState('Decay', $decay);
}
/**
* @return array list of timer options for client-side.
*/
protected function getTriggerOptions()
{
$options = parent::getTriggerOptions();
$options['PropertyName'] = $this->getPropertyName();
$options['Interval'] = $this->getInterval();
$options['Decay'] = $this->getDecayRate();
return $options;
}
/**
* Registers the javascript code for initializing the active control.
* @param THtmlWriter the renderer.
*/
public function render($writer)
{
parent::render($writer);
$this->getActiveControl()->registerCallbackClientScript(
$this->getClientClassName(), $this->getTriggerOptions());
}
/**
* @return string corresponding javascript class name for TEventTriggeredCallback.
*/
protected function getClientClassName()
{
return 'Prado.WebUI.TValueTriggeredCallback';
}
}
|
