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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
<?php
/**
* THyperLink class file.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.xisc.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @package Prado\Web\UI\WebControls
*/
namespace Prado\Web\UI\WebControls;
use Prado\Prado;
use Prado\Web\THttpUtility;
/**
* THyperLink class
*
* THyperLink displays a hyperlink on a page. The hyperlink URL is specified
* via the {@link setNavigateUrl NavigateUrl} property, and link text is via
* the {@link setText Text} property. It is also possible to display an image
* by setting the {@link setImageUrl ImageUrl} property. In this case,
* the alignment of the image displayed is set by the
* {@link setImageAlign ImageAlign} property and {@link getText Text} is
* displayed as the alternate text of the image.
*
* The link target is specified via the {@link setTarget Target} property.
* If both {@link getImageUrl ImageUrl} and {@link getText Text} are empty,
* the content enclosed within the control tag will be rendered.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Web\UI\WebControls
* @since 3.0
*/
class THyperLink extends \Prado\Web\UI\WebControls\TWebControl implements \Prado\IDataRenderer
{
/**
* @return string tag name of the hyperlink
*/
protected function getTagName()
{
return 'a';
}
/**
* Adds attributes related to a hyperlink element to renderer.
* @param THtmlWriter the writer used for the rendering purpose
*/
protected function addAttributesToRender($writer)
{
$isEnabled=$this->getEnabled(true);
if($this->getEnabled() && !$isEnabled)
$writer->addAttribute('disabled','disabled');
parent::addAttributesToRender($writer);
if(($url=$this->getNavigateUrl())!=='' && $isEnabled)
$writer->addAttribute('href',$url);
if(($target=$this->getTarget())!=='')
$writer->addAttribute('target',$target);
}
/**
* Renders the body content of the hyperlink.
* @param THtmlWriter the writer for rendering
*/
public function renderContents($writer)
{
if(($imageUrl=$this->getImageUrl())==='')
{
if(($text=$this->getText())!=='')
$writer->write(THttpUtility::htmlEncode($text));
else if($this->getHasControls())
parent::renderContents($writer);
else
$writer->write(THttpUtility::htmlEncode($this->getNavigateUrl()));
}
else
{
$this->createImage($imageUrl)->renderControl($writer);
}
}
/**
* Gets the TImage for rendering the ImageUrl property. This is not for
* creating dynamic images.
* @param string image url.
* @return TImage image control for rendering.
*/
protected function createImage($imageUrl)
{
$image=Prado::createComponent('\\Prado\\Web\\UI\\WebControls\\TImage');
$image->setImageUrl($imageUrl);
if(($width=$this->getImageWidth())!=='')
$image->setWidth($width);
if(($height=$this->getImageHeight())!=='')
$image->setHeight($height);
if(($toolTip=$this->getToolTip())!=='')
$image->setToolTip($toolTip);
if(($text=$this->getText())!=='')
$image->setAlternateText($text);
if(($align=$this->getImageAlign())!=='')
$image->setImageAlign($align);
$image->setBorderWidth('0');
return $image;
}
/**
* @return string the text caption of the THyperLink
*/
public function getText()
{
return $this->getViewState('Text','');
}
/**
* Sets the text caption of the THyperLink.
* @param string the text caption to be set
*/
public function setText($value)
{
$this->setViewState('Text',$value,'');
}
/**
* @return string the alignment of the image with respective to other elements on the page, defaults to empty.
*/
public function getImageAlign()
{
return $this->getViewState('ImageAlign','');
}
/**
* Sets the alignment of the image with respective to other elements on the page.
* Possible values include: absbottom, absmiddle, baseline, bottom, left,
* middle, right, texttop, and top. If an empty string is passed in,
* imagealign attribute will not be rendered.
* @param string the alignment of the image
*/
public function setImageAlign($value)
{
$this->setViewState('ImageAlign',$value,'');
}
/**
* @return string height of the image in the THyperLink
*/
public function getImageHeight()
{
return $this->getViewState('ImageHeight','');
}
/**
* Sets the height of the image in the THyperLink
* @param string height of the image in the THyperLink
*/
public function setImageHeight($value)
{
$this->setViewSTate('ImageHeight',$value,'');
}
/**
* @return string the location of the image file for the THyperLink
*/
public function getImageUrl()
{
return $this->getViewState('ImageUrl','');
}
/**
* Sets the location of image file of the THyperLink.
* @param string the image file location
*/
public function setImageUrl($value)
{
$this->setViewState('ImageUrl',$value,'');
}
/**
* @return string width of the image in the THyperLink
*/
public function getImageWidth()
{
return $this->getViewState('ImageWidth','');
}
/**
* Sets the width of the image in the THyperLink
* @param string width of the image
*/
public function setImageWidth($value)
{
$this->setViewState('ImageWidth',$value,'');
}
/**
* @return string the URL to link to when the THyperLink component is clicked.
*/
public function getNavigateUrl()
{
return $this->getViewState('NavigateUrl','');
}
/**
* Sets the URL to link to when the THyperLink component is clicked.
* @param string the URL
*/
public function setNavigateUrl($value)
{
$this->setViewState('NavigateUrl',$value,'');
}
/**
* Returns the URL to link to when the THyperLink component is clicked.
* This method is required by {@link \Prado\IDataRenderer}.
* It is the same as {@link getText()}.
* @return string the text caption
* @see getText
* @since 3.1.0
*/
public function getData()
{
return $this->getText();
}
/**
* Sets the URL to link to when the THyperLink component is clicked.
* This method is required by {@link \Prado\IDataRenderer}.
* It is the same as {@link setText()}.
* @param string the text caption to be set
* @see setText
* @since 3.1.0
*/
public function setData($value)
{
$this->setText($value);
}
/**
* @return string the target window or frame to display the Web page content linked to when the THyperLink component is clicked.
*/
public function getTarget()
{
return $this->getViewState('Target','');
}
/**
* Sets the target window or frame to display the Web page content linked to when the THyperLink component is clicked.
* @param string the target window, valid values include '_blank', '_parent', '_self', '_top' and empty string.
*/
public function setTarget($value)
{
$this->setViewState('Target',$value,'');
}
}
|
