blob: 74fface88b1c5263ebec09bde7a8547f1f221fd5 (
plain)
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
|
<?php
/**
* TEventTriggeredCallback 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\Prado;
use Prado\TPropertyValue;
/**
* TEventTriggeredCallback Class
*
* Triggers a new callback request when a particular {@link setEventName EventName}
* on a control with ID given by {@link setControlID ControlID} is raised.
*
* The default action of the event on the client-side can be prevented when
* {@link setPreventDefaultAction PreventDefaultAction} is set to true.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @package Prado\Web\UI\ActiveControls
* @since 3.1
*/
class TEventTriggeredCallback extends TTriggeredCallback
{
/**
* @return string The client-side event name the trigger listens to.
*/
public function getEventName()
{
return $this->getViewState('EventName', '');
}
/**
* Sets the client-side event name that fires the callback request.
* @param string The client-side event name the trigger listens to.
*/
public function setEventName($value)
{
$this->setViewState('EventName', $value, '');
}
/**
* @param boolean true to prevent/stop default event action.
*/
public function setPreventDefaultAction($value)
{
$this->setViewState('StopEvent', TPropertyValue::ensureBoolean($value), false);
}
/**
* @return boolean true to prevent/stop default event action.
*/
public function getPreventDefaultAction()
{
return $this->getViewState('StopEvent', false);
}
/**
* @return array list of timer options for client-side.
*/
protected function getTriggerOptions()
{
$options = parent::getTriggerOptions();
$name = preg_replace('/^on/', '', $this->getEventName());
$options['EventName'] = strtolower($name);
$options['StopEvent'] = $this->getPreventDefaultAction();
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.TEventTriggeredCallback';
}
}
|
