ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
PHPExcel_Worksheet_Drawing_Shadow Class Reference
+ Inheritance diagram for PHPExcel_Worksheet_Drawing_Shadow:
+ Collaboration diagram for PHPExcel_Worksheet_Drawing_Shadow:

Public Member Functions

 __construct ()
 Create a new PHPExcel_Worksheet_Drawing_Shadow. More...
 
 getVisible ()
 Get Visible. More...
 
 setVisible ($pValue=false)
 Set Visible. More...
 
 getBlurRadius ()
 Get Blur radius. More...
 
 setBlurRadius ($pValue=6)
 Set Blur radius. More...
 
 getDistance ()
 Get Shadow distance. More...
 
 setDistance ($pValue=2)
 Set Shadow distance. More...
 
 getDirection ()
 Get Shadow direction (in degrees) More...
 
 setDirection ($pValue=0)
 Set Shadow direction (in degrees) More...
 
 getAlignment ()
 Get Shadow alignment. More...
 
 setAlignment ($pValue=0)
 Set Shadow alignment. More...
 
 getColor ()
 Get Color. More...
 
 setColor (PHPExcel_Style_Color $pValue=null)
 Set Color. More...
 
 getAlpha ()
 Get Alpha. More...
 
 setAlpha ($pValue=0)
 Set Alpha. More...
 
 getHashCode ()
 Get hash code. More...
 
 __clone ()
 Implement PHP __clone to create a deep clone, not just a shallow copy. More...
 
 getHashCode ()
 Get hash code. More...
 

Data Fields

const SHADOW_BOTTOM = 'b'
 
const SHADOW_BOTTOM_LEFT = 'bl'
 
const SHADOW_BOTTOM_RIGHT = 'br'
 
const SHADOW_CENTER = 'ctr'
 
const SHADOW_LEFT = 'l'
 
const SHADOW_TOP = 't'
 
const SHADOW_TOP_LEFT = 'tl'
 
const SHADOW_TOP_RIGHT = 'tr'
 

Private Attributes

 $_visible
 
 $_blurRadius
 
 $_distance
 
 $_direction
 
 $_alignment
 
 $_color
 
 $_alpha
 

Detailed Description

Definition at line 36 of file Shadow.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Worksheet_Drawing_Shadow::__construct ( )

Create a new PHPExcel_Worksheet_Drawing_Shadow.

Definition at line 104 of file Shadow.php.

105 {
106 // Initialise values
107 $this->_visible = false;
108 $this->_blurRadius = 6;
109 $this->_distance = 2;
110 $this->_direction = 0;
113 $this->_alpha = 50;
114 }

References PHPExcel_Style_Color\COLOR_BLACK, and SHADOW_BOTTOM_RIGHT.

Member Function Documentation

◆ __clone()

PHPExcel_Worksheet_Drawing_Shadow::__clone ( )

Implement PHP __clone to create a deep clone, not just a shallow copy.

Definition at line 278 of file Shadow.php.

278 {
279 $vars = get_object_vars($this);
280 foreach ($vars as $key => $value) {
281 if (is_object($value)) {
282 $this->$key = clone $value;
283 } else {
284 $this->$key = $value;
285 }
286 }
287 }

◆ getAlignment()

PHPExcel_Worksheet_Drawing_Shadow::getAlignment ( )

Get Shadow alignment.

Returns
int

Definition at line 201 of file Shadow.php.

201 {
202 return $this->_alignment;
203 }

References $_alignment.

◆ getAlpha()

PHPExcel_Worksheet_Drawing_Shadow::getAlpha ( )

Get Alpha.

Returns
int

Definition at line 242 of file Shadow.php.

242 {
243 return $this->_alpha;
244 }

References $_alpha.

◆ getBlurRadius()

PHPExcel_Worksheet_Drawing_Shadow::getBlurRadius ( )

Get Blur radius.

Returns
int

Definition at line 141 of file Shadow.php.

References $_blurRadius.

◆ getColor()

PHPExcel_Worksheet_Drawing_Shadow::getColor ( )

Get Color.

Returns
PHPExcel_Style_Color

Definition at line 221 of file Shadow.php.

221 {
222 return $this->_color;
223 }

References $_color.

◆ getDirection()

PHPExcel_Worksheet_Drawing_Shadow::getDirection ( )

Get Shadow direction (in degrees)

Returns
int

Definition at line 181 of file Shadow.php.

181 {
182 return $this->_direction;
183 }

References $_direction.

◆ getDistance()

PHPExcel_Worksheet_Drawing_Shadow::getDistance ( )

Get Shadow distance.

Returns
int

Definition at line 161 of file Shadow.php.

161 {
162 return $this->_distance;
163 }

References $_distance.

◆ getHashCode()

PHPExcel_Worksheet_Drawing_Shadow::getHashCode ( )

Get hash code.

Returns
string Hash code

Implements PHPExcel_IComparable.

Definition at line 262 of file Shadow.php.

262 {
263 return md5(
264 ($this->_visible ? 't' : 'f')
265 . $this->_blurRadius
266 . $this->_distance
267 . $this->_direction
268 . $this->_alignment
269 . $this->_color->getHashCode()
270 . $this->_alpha
271 . __CLASS__
272 );
273 }

◆ getVisible()

PHPExcel_Worksheet_Drawing_Shadow::getVisible ( )

Get Visible.

Returns
boolean

Definition at line 121 of file Shadow.php.

121 {
122 return $this->_visible;
123 }

References $_visible.

◆ setAlignment()

PHPExcel_Worksheet_Drawing_Shadow::setAlignment (   $pValue = 0)

Set Shadow alignment.

Parameters
int$pValue
Returns
PHPExcel_Worksheet_Drawing_Shadow

Definition at line 211 of file Shadow.php.

211 {
212 $this->_alignment = $pValue;
213 return $this;
214 }

◆ setAlpha()

PHPExcel_Worksheet_Drawing_Shadow::setAlpha (   $pValue = 0)

Set Alpha.

Parameters
int$pValue
Returns
PHPExcel_Worksheet_Drawing_Shadow

Definition at line 252 of file Shadow.php.

252 {
253 $this->_alpha = $pValue;
254 return $this;
255 }

◆ setBlurRadius()

PHPExcel_Worksheet_Drawing_Shadow::setBlurRadius (   $pValue = 6)

Set Blur radius.

Parameters
int$pValue
Returns
PHPExcel_Worksheet_Drawing_Shadow

Definition at line 151 of file Shadow.php.

151 {
152 $this->_blurRadius = $pValue;
153 return $this;
154 }

◆ setColor()

PHPExcel_Worksheet_Drawing_Shadow::setColor ( PHPExcel_Style_Color  $pValue = null)

Set Color.

Parameters
PHPExcel_Style_Color$pValue
Exceptions
PHPExcel_Exception
Returns
PHPExcel_Worksheet_Drawing_Shadow

Definition at line 232 of file Shadow.php.

232 {
233 $this->_color = $pValue;
234 return $this;
235 }

◆ setDirection()

PHPExcel_Worksheet_Drawing_Shadow::setDirection (   $pValue = 0)

Set Shadow direction (in degrees)

Parameters
int$pValue
Returns
PHPExcel_Worksheet_Drawing_Shadow

Definition at line 191 of file Shadow.php.

191 {
192 $this->_direction = $pValue;
193 return $this;
194 }

◆ setDistance()

PHPExcel_Worksheet_Drawing_Shadow::setDistance (   $pValue = 2)

Set Shadow distance.

Parameters
int$pValue
Returns
PHPExcel_Worksheet_Drawing_Shadow

Definition at line 171 of file Shadow.php.

171 {
172 $this->_distance = $pValue;
173 return $this;
174 }

◆ setVisible()

PHPExcel_Worksheet_Drawing_Shadow::setVisible (   $pValue = false)

Set Visible.

Parameters
boolean$pValue
Returns
PHPExcel_Worksheet_Drawing_Shadow

Definition at line 131 of file Shadow.php.

131 {
132 $this->_visible = $pValue;
133 return $this;
134 }

Field Documentation

◆ $_alignment

PHPExcel_Worksheet_Drawing_Shadow::$_alignment
private

Definition at line 85 of file Shadow.php.

Referenced by getAlignment().

◆ $_alpha

PHPExcel_Worksheet_Drawing_Shadow::$_alpha
private

Definition at line 99 of file Shadow.php.

Referenced by getAlpha().

◆ $_blurRadius

PHPExcel_Worksheet_Drawing_Shadow::$_blurRadius
private

Definition at line 62 of file Shadow.php.

Referenced by getBlurRadius().

◆ $_color

PHPExcel_Worksheet_Drawing_Shadow::$_color
private

Definition at line 92 of file Shadow.php.

Referenced by getColor().

◆ $_direction

PHPExcel_Worksheet_Drawing_Shadow::$_direction
private

Definition at line 78 of file Shadow.php.

Referenced by getDirection().

◆ $_distance

PHPExcel_Worksheet_Drawing_Shadow::$_distance
private

Definition at line 71 of file Shadow.php.

Referenced by getDistance().

◆ $_visible

PHPExcel_Worksheet_Drawing_Shadow::$_visible
private

Definition at line 53 of file Shadow.php.

Referenced by getVisible().

◆ SHADOW_BOTTOM

const PHPExcel_Worksheet_Drawing_Shadow::SHADOW_BOTTOM = 'b'

Definition at line 39 of file Shadow.php.

◆ SHADOW_BOTTOM_LEFT

const PHPExcel_Worksheet_Drawing_Shadow::SHADOW_BOTTOM_LEFT = 'bl'

Definition at line 40 of file Shadow.php.

◆ SHADOW_BOTTOM_RIGHT

const PHPExcel_Worksheet_Drawing_Shadow::SHADOW_BOTTOM_RIGHT = 'br'

Definition at line 41 of file Shadow.php.

Referenced by __construct().

◆ SHADOW_CENTER

const PHPExcel_Worksheet_Drawing_Shadow::SHADOW_CENTER = 'ctr'

Definition at line 42 of file Shadow.php.

◆ SHADOW_LEFT

const PHPExcel_Worksheet_Drawing_Shadow::SHADOW_LEFT = 'l'

Definition at line 43 of file Shadow.php.

◆ SHADOW_TOP

const PHPExcel_Worksheet_Drawing_Shadow::SHADOW_TOP = 't'

Definition at line 44 of file Shadow.php.

◆ SHADOW_TOP_LEFT

const PHPExcel_Worksheet_Drawing_Shadow::SHADOW_TOP_LEFT = 'tl'

Definition at line 45 of file Shadow.php.

◆ SHADOW_TOP_RIGHT

const PHPExcel_Worksheet_Drawing_Shadow::SHADOW_TOP_RIGHT = 'tr'

Definition at line 46 of file Shadow.php.


The documentation for this class was generated from the following file: