PHPExcel_Writer_Excel5

# Class: PHPExcel_Writer_Excel5_Xf Source Location: /PHPExcel/Writer/Excel5/Xf.php
### Class Overview
PHPExcel_Writer_Excel5_Xf #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) | ### Variables $_bg_color $_BIFFVersion $_bottom_color $_fg_color $_fontIndex $_isStyleXf $_left_color $_numberFormatIndex $_right_color $_text_justlast $_top_color | ### Methods __construct setBgColor setBIFFVersion setBottomColor setDiagColor setFgColor setFontIndex setIsStyleXf setLeftColor setNumberFormatIndex setRightColor setTopColor writeXf _mapBorderStyle _mapFillType _mapHAlign _mapHidden _mapLocked _mapTextRotation _mapVAlign
### Class Details [line 92] PHPExcel_Writer_Excel5_Xf PHPExcel_Writer_Excel5_Xf #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_bg_color = [line 136] The cell's background color. The cell's background color. #### Tags:
access: | private
Type: | integer
[ Top ] #### $_BIFFVersion = [line 99] BIFF version BIFF version #### Tags:
access: | private
Type: | int
[ Top ] #### $_bottom_color = [line 142] Color of the bottom border of the cell. Color of the bottom border of the cell. #### Tags:
access: | private
Type: | integer
[ Top ] #### $_fg_color = [line 130] The cell's foreground color. The cell's foreground color. #### Tags:
access: | private
Type: | integer
[ Top ] #### $_fontIndex = [line 112] Index to the FONT record. Index to the FONT record. Index 4 does not exist #### Tags:
access: | private
Type: | integer
[ Top ] #### $_isStyleXf = [line 106] Style XF or a cell XF ? Style XF or a cell XF ? #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_left_color = [line 154] Color of the left border of the cell. Color of the left border of the cell. #### Tags:
access: | private
Type: | integer
[ Top ] #### $_numberFormatIndex = [line 118] An index (2 bytes) to a FORMAT record (number format). An index (2 bytes) to a FORMAT record (number format). #### Tags:
access: | private
Type: | integer
[ Top ] #### $_right_color = [line 160] Color of the right border of the cell. Color of the right border of the cell. #### Tags:
access: | private
Type: | integer
[ Top ] #### $_text_justlast = [line 124] 1 bit, apparently not used. 1 bit, apparently not used. #### Tags:
access: | private
Type: | integer
[ Top ] #### $_top_color = [line 148] Color of the top border of the cell. Color of the top border of the cell. #### Tags:
access: | private
Type: | integer
[ Top ] ### Class Methods ### constructor __construct [line 169]
`PHPExcel_Writer_Excel5_Xf __construct( [ $style = null], integer $index, PHPExcel_Style 1)`
Constructor Constructor #### Tags:
access: | public
#### Parameters:
integer | $index | the XF index for the format.
PHPExcel_Style | 1 |
PHPExcel_Style | $style |
[ Top ] ### method setBgColor [line 431]
`void setBgColor( int $colorIndex)`
Sets the cell's background color Sets the cell's background color #### Tags:
access: | public
#### Parameters:
int | $colorIndex | Color index
[ Top ] ### method setBIFFVersion [line 343]
`void setBIFFVersion( int $BIFFVersion)`
Set BIFF version Set BIFF version #### Tags:
access: | public
#### Parameters:
int | $BIFFVersion |
[ Top ] ### method setBottomColor [line 364]
`void setBottomColor( int $colorIndex)`
Sets the cell's bottom border color Sets the cell's bottom border color #### Tags:
access: | public
#### Parameters:
int | $colorIndex | Color index
[ Top ] ### method setDiagColor [line 408]
`void setDiagColor( int $colorIndex)`
Sets the cell's diagonal border color Sets the cell's diagonal border color #### Tags:
access: | public
#### Parameters:
int | $colorIndex | Color index
[ Top ] ### method setFgColor [line 420]
`void setFgColor( int $colorIndex)`
Sets the cell's foreground color Sets the cell's foreground color #### Tags:
access: | public
#### Parameters:
int | $colorIndex | Color index
[ Top ] ### method setFontIndex [line 453]
`void setFontIndex( int $value)`
Set the font index. Set the font index. #### Tags:
access: | public
#### Parameters:
int | $value | Font index, note that value 4 does not exist
[ Top ] ### method setIsStyleXf [line 353]
`void setIsStyleXf( boolean $value)`
Is this a style XF ? Is this a style XF ? #### Tags:
access: | public
#### Parameters:
boolean | $value |
[ Top ] ### method setLeftColor [line 386]
`void setLeftColor( int $colorIndex)`
Sets the cell's left border color Sets the cell's left border color #### Tags:
access: | public
#### Parameters:
int | $colorIndex | Color index
[ Top ] ### method setNumberFormatIndex [line 443]
`void setNumberFormatIndex( integer $numberFormatIndex)`
Sets the index to the number format record It can be date, time, currency, etc. Sets the index to the number format record It can be date, time, currency, etc... #### Tags:
access: | public
#### Parameters:
integer | $numberFormatIndex | Index to format record
[ Top ] ### method setRightColor [line 397]
`void setRightColor( int $colorIndex)`
Sets the cell's right border color Sets the cell's right border color #### Tags:
access: | public
#### Parameters:
int | $colorIndex | Color index
[ Top ] ### method setTopColor [line 375]
`void setTopColor( int $colorIndex)`
Sets the cell's top border color Sets the cell's top border color #### Tags:
access: | public
#### Parameters:
int | $colorIndex | Color index
[ Top ] ### method writeXf [line 200]
`string writeXf( string $style)`
Generate an Excel BIFF XF record (style or cell). Generate an Excel BIFF XF record (style or cell). #### Tags:
return: | The XF record
#### Parameters:
string | $style | The type of the XF record ('style' or 'cell').
[ Top ] ### method _mapBorderStyle [line 461]
`void _mapBorderStyle( $borderStyle)`
Map border style Map border style #### Tags:
access: | private
#### Parameters:
| $borderStyle |
[ Top ] ### method _mapFillType [line 484]
`void _mapFillType( $fillType)`
Map fill type Map fill type #### Tags:
access: | private
#### Parameters:
| $fillType |
[ Top ] ### method _mapHAlign [line 517]
`int _mapHAlign( string $hAlign)`
Map to BIFF2-BIFF8 codes for horizontal alignment Map to BIFF2-BIFF8 codes for horizontal alignment #### Tags:
access: | private
#### Parameters:
string | $hAlign |
[ Top ] ### method _mapHidden [line 585]
`int _mapHidden( string $hidden)`
Map hidden Map hidden #### Tags:
access: | private
#### Parameters:
string | $hidden |
[ Top ] ### method _mapLocked [line 570]
`int _mapLocked( string $locked)`
Map locked Map locked #### Tags:
access: | private
#### Parameters:
string | $locked |
[ Top ] ### method _mapTextRotation [line 552]
`int _mapTextRotation( int $textRotation)`
Map to BIFF8 codes for text rotation angle Map to BIFF8 codes for text rotation angle #### Tags:
access: | private
#### Parameters:
int | $textRotation |
[ Top ] ### method _mapVAlign [line 536]
`int _mapVAlign( string $vAlign)`
Map to BIFF2-BIFF8 codes for vertical alignment Map to BIFF2-BIFF8 codes for vertical alignment #### Tags:
access: | private
#### Parameters:
string | $vAlign |
[ Top ] Documentation generated on Mon, 11 Jan 2010 08:19:20 +0100 by phpDocumentor 1.4.1