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
|
<?php
/**
* TImage 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;
/**
* TImage class
*
* TImage displays an image on a page. The image is specified via the
* {@link setImageUrl ImageUrl} property which takes a relative or absolute
* URL to the image file. The alignment of the image displayed is set by
* the {@link setImageAlign ImageAlign} property. To set alternative texts
* or long description of the image, use {@link setAlternateText AlternateText}
* or {@link setDescriptionUrl DescriptionUrl} property, respectively.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Web\UI\WebControls
* @since 3.0
*/
class TImage extends TWebControl implements IDataRenderer
{
/**
* @return string tag name of image control
*/
protected function getTagName()
{
return 'img';
}
/**
* Adds attributes related to an HTML image element to renderer.
* @param THtmlWriter the writer used for the rendering purpose
*/
protected function addAttributesToRender($writer)
{
$writer->addAttribute('src',$this->getImageUrl());
$writer->addAttribute('alt',$this->getAlternateText());
if(($desc=$this->getDescriptionUrl())!=='')
$writer->addAttribute('longdesc',$desc);
if(($align=$this->getImageAlign())!=='')
$writer->addAttribute('align',$align);
parent::addAttributesToRender($writer);
}
/**
* Renders the body content of the image.
* Nothing to be rendered within image tags.
* @param THtmlWriter the writer for rendering
*/
public function renderContents($writer)
{
}
/**
* @return string the alternative text displayed in the TImage component when the image is unavailable.
*/
public function getAlternateText()
{
return $this->getViewState('AlternateText','');
}
/**
* Sets the alternative text to be displayed in the TImage when the image is unavailable.
* @param string the alternative text
*/
public function setAlternateText($value)
{
$this->setViewState('AlternateText',$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 the URL of the image file
*/
public function getImageUrl()
{
return $this->getViewState('ImageUrl','');
}
/**
* @param string the URL of the image file
*/
public function setImageUrl($value)
{
$this->setViewState('ImageUrl',$value,'');
}
/**
* Returns the URL of the image file.
* This method is required by {@link IDataRenderer}.
* It is the same as {@link getImageUrl()}.
* @return string the URL of the image file.
* @see getImageUrl
* @since 3.1.0
*/
public function getData()
{
return $this->getImageUrl();
}
/**
* Sets the URL of the image.
* This method is required by {@link IDataRenderer}.
* It is the same as {@link setImageUrl()}.
* @param string the URL of the image file.
* @see setImageUrl
* @since 3.1.0
*/
public function setData($value)
{
$this->setImageUrl($value);
}
/**
* @return string the URL to long description
*/
public function getDescriptionUrl()
{
return $this->getViewState('DescriptionUrl','');
}
/**
* @param string the URL to the long description of the image.
*/
public function setDescriptionUrl($value)
{
$this->setViewState('DescriptionUrl',$value,'');
}
}
|
