blob: dc15ad0c87845c19a83ee16cbeead28e824e0689 (
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
<?php
/**
* TLiteral class file
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI\WebControls
*/
namespace Prado\Web\UI\WebControls;
use Prado\TPropertyValue;
/**
* TLiteral class
*
* TLiteral displays a static text on the Web page.
* TLiteral is similar to the TLabel control, except that the TLiteral
* control does not have style properties (e.g. BackColor, Font, etc.)
* You can programmatically control the text displayed in the control by setting
* the {@link setText Text} property. The text displayed may be HTML-encoded
* if the {@link setEncode Encode} property is set true (defaults to false).
*
* TLiteral will render the contents enclosed within its component tag
* if {@link setText Text} is empty.
*
* Note, if {@link setEncode Encode} is false, make sure {@link setText Text}
* does not contain unwanted characters that may bring security vulnerabilities.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Web\UI\WebControls
* @since 3.0
*/
class TLiteral extends \Prado\Web\UI\TControl implements \Prado\IDataRenderer
{
/**
* @return string the static text of the TLiteral
*/
public function getText()
{
return $this->getViewState('Text','');
}
/**
* Sets the static text of the TLiteral
* @param string the text to be set
*/
public function setText($value)
{
$this->setViewState('Text',$value,'');
}
/**
* Returns the static text of the TLiteral.
* This method is required by {@link \Prado\IDataRenderer}.
* It is the same as {@link getText()}.
* @return string the static text of the TLiteral
* @see getText
* @since 3.1.0
*/
public function getData()
{
return $this->getText();
}
/**
* Sets the static text of the TLiteral.
* This method is required by {@link \Prado\IDataRenderer}.
* It is the same as {@link setText()}.
* @param string the static text of the TLiteral
* @see setText
* @since 3.1.0
*/
public function setData($value)
{
$this->setText($value);
}
/**
* @return boolean whether the rendered text should be HTML-encoded. Defaults to false.
*/
public function getEncode()
{
return $this->getViewState('Encode',false);
}
/**
* @param boolean whether the rendered text should be HTML-encoded.
*/
public function setEncode($value)
{
$this->setViewState('Encode',TPropertyValue::ensureBoolean($value),false);
}
/**
* Renders the literal control.
* @param THtmlWriter the writer used for the rendering purpose
*/
public function render($writer)
{
if(($text=$this->getText())!=='')
{
if($this->getEncode())
$writer->write(THttpUtility::htmlEncode($text));
else
$writer->write($text);
}
else
parent::render($writer);
}
}
|
