PHPExcel_Style

# Class: PHPExcel_Style_Fill Source Location: /PHPExcel/Style/Fill.php
### Class Overview
PHPExcel_Style_Fill #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) Implements interfaces: PHPExcel_IComparable | ### Variables $_endColor $_fillType $_isSupervisor $_parent $_parentPropertyName $_rotation $_startColor | ### Constants FILL_GRADIENT_LINEAR FILL_GRADIENT_PATH FILL_NONE FILL_PATTERN_DARKDOWN FILL_PATTERN_DARKGRAY FILL_PATTERN_DARKGRID FILL_PATTERN_DARKHORIZONTAL FILL_PATTERN_DARKTRELLIS FILL_PATTERN_DARKUP FILL_PATTERN_DARKVERTICAL FILL_PATTERN_GRAY0625 FILL_PATTERN_GRAY125 FILL_PATTERN_LIGHTDOWN FILL_PATTERN_LIGHTGRAY FILL_PATTERN_LIGHTGRID FILL_PATTERN_LIGHTHORIZONTAL FILL_PATTERN_LIGHTTRELLIS FILL_PATTERN_LIGHTUP FILL_PATTERN_LIGHTVERTICAL FILL_PATTERN_MEDIUMGRAY FILL_SOLID | ### Methods __construct applyFromArray bindParent getActiveCell getActiveSheet getEndColor getFillType getHashCode getIsSupervisor getRotation getSelectedCells getSharedComponent getStartColor getStyleArray setEndColor setFillType setRotation setStartColor __clone
### Class Details [line 51] PHPExcel_Style_Fill PHPExcel_Style_Fill #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_endColor = [line 102] End color End color #### Tags:
access: | private
Type: | PHPExcel_Style_Color
[ Top ] #### $_fillType = [line 81] Fill type Fill type #### Tags:
access: | private
Type: | string
[ Top ] #### $_isSupervisor = [line 116] Supervisor? Supervisor? #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_parent = [line 123] Parent. Parent. Only used for supervisor #### Tags:
access: | private
Type: | PHPExcel_Style
[ Top ] #### $_parentPropertyName = [line 109] Parent Borders Parent Borders #### Tags:
var: | string
access: | private
Type: | _parentPropertyName
[ Top ] #### $_rotation = [line 88] Rotation Rotation #### Tags:
access: | private
Type: | double
[ Top ] #### $_startColor = [line 95] Start color Start color #### Tags:
access: | private
Type: | PHPExcel_Style_Color
[ Top ] ### Class Methods ### constructor __construct [line 128]
`PHPExcel_Style_Fill __construct( [ $isSupervisor = false])`
Create a new PHPExcel_Style_Fill Create a new PHPExcel_Style_Fill #### Tags:
access: | public
#### Parameters:
| $isSupervisor |
[ Top ] ### method applyFromArray [line 244]
`PHPExcel_Style_Fill applyFromArray( [array $pStyles = null])`
Apply styles from array Apply styles from array $objPHPExcel->getActiveSheet()->getStyle('B2')->getFill()->applyFromArray( array( 'type' => PHPExcel_Style_Fill::FILL_GRADIENT_LINEAR, 'rotation' => 0, 'startcolor' => array( 'rgb' => '000000' ), 'endcolor' => array( 'argb' => 'FFFFFFFF' ) ) ); #### Tags:
throws: | Exception
access: | public
#### Parameters:
array | $pStyles | Array containing style information
[ Top ] ### method bindParent [line 152]
`PHPExcel_Style_Fill bindParent( PHPExcel_Style $parent)`
Bind parent. Bind parent. Only used for supervisor #### Tags:
access: | public
#### Parameters:
PHPExcel_Style | $parent |
[ Top ] ### method getActiveCell [line 206]
`string getActiveCell( )`
Get the currently active cell coordinate in currently active sheet. Get the currently active cell coordinate in currently active sheet. Only used for supervisor #### Tags:
return: | E.g. 'A1'
access: | public
[ Top ] ### method getActiveSheet [line 184]
`PHPExcel_Worksheet getActiveSheet( )`
Get the currently active sheet. Get the currently active sheet. Only used for supervisor #### Tags:
access: | public
[ Top ] ### method getEndColor [line 361]
`PHPExcel_Style_Color getEndColor( )`
Get End Color Get End Color #### Tags:
access: | public
[ Top ] ### method getFillType [line 276]
`string getFillType( )`
Get Fill Type Get Fill Type #### Tags:
access: | public
[ Top ] ### method getHashCode [line 390]
`string getHashCode( )`
Get hash code Get hash code #### Tags:
return: | Hash code
access: | public
[ Top ] ### method getIsSupervisor [line 163]
`boolean getIsSupervisor( )`
Is this a supervisor or a real style component? Is this a supervisor or a real style component? #### Tags:
access: | public
[ Top ] ### method getRotation [line 304]
`double getRotation( )`
Get Rotation Get Rotation #### Tags:
access: | public
[ Top ] ### method getSelectedCells [line 195]
`string getSelectedCells( )`
Get the currently active cell coordinate in currently active sheet. Get the currently active cell coordinate in currently active sheet. Only used for supervisor #### Tags:
return: | E.g. 'A1'
access: | public
[ Top ] ### method getSharedComponent [line 174]
`PHPExcel_Style_Fill getSharedComponent( )`
Get the shared style component for the currently active cell in currently active sheet. Get the shared style component for the currently active cell in currently active sheet. Only used for style supervisor #### Tags:
access: | public
[ Top ] ### method getStartColor [line 332]
`PHPExcel_Style_Color getStartColor( )`
Get Start Color Get Start Color #### Tags:
access: | public
[ Top ] ### method getStyleArray [line 217]
`array getStyleArray( array $array)`
Build style array from subcomponents Build style array from subcomponents #### Tags:
access: | public
#### Parameters:
array | $array |
[ Top ] ### method setEndColor [line 372]
`PHPExcel_Style_Fill setEndColor( [PHPExcel_Style_Color $pValue = null])`
Set End Color Set End Color #### Tags:
throws: | Exception
access: | public
#### Parameters:
PHPExcel_Style_Color | $pValue |
[ Top ] ### method setFillType [line 289]
`PHPExcel_Style_Fill setFillType( [string $pValue = PHPExcel_Style_Fill::FILL_NONE])`
Set Fill Type Set Fill Type #### Tags:
access: | public
#### Parameters:
string | $pValue | PHPExcel_Style_Fill fill type
[ Top ] ### method setRotation [line 317]
`PHPExcel_Style_Fill setRotation( [double $pValue = 0])`
Set Rotation Set Rotation #### Tags:
access: | public
#### Parameters:
double | $pValue |
[ Top ] ### method setStartColor [line 343]
`PHPExcel_Style_Fill setStartColor( [PHPExcel_Style_Color $pValue = null])`
Set Start Color Set Start Color #### Tags:
throws: | Exception
access: | public
#### Parameters:
PHPExcel_Style_Color | $pValue |
[ Top ] ### method __clone [line 406]
`void __clone( )`
Implement PHP __clone to create a deep clone, not just a shallow copy. Implement PHP __clone to create a deep clone, not just a shallow copy. #### Tags:
access: | public
[ Top ] ### Class Constants #### FILL_GRADIENT_LINEAR = 'linear' [line 56] [ Top ] #### FILL_GRADIENT_PATH = 'path' [line 57] [ Top ] #### FILL_NONE = 'none' [line 54] [ Top ] #### FILL_PATTERN_DARKDOWN = 'darkDown' [line 58] [ Top ] #### FILL_PATTERN_DARKGRAY = 'darkGray' [line 59] [ Top ] #### FILL_PATTERN_DARKGRID = 'darkGrid' [line 60] [ Top ] #### FILL_PATTERN_DARKHORIZONTAL = 'darkHorizontal' [line 61] [ Top ] #### FILL_PATTERN_DARKTRELLIS = 'darkTrellis' [line 62] [ Top ] #### FILL_PATTERN_DARKUP = 'darkUp' [line 63] [ Top ] #### FILL_PATTERN_DARKVERTICAL = 'darkVertical' [line 64] [ Top ] #### FILL_PATTERN_GRAY0625 = 'gray0625' [line 65] [ Top ] #### FILL_PATTERN_GRAY125 = 'gray125' [line 66] [ Top ] #### FILL_PATTERN_LIGHTDOWN = 'lightDown' [line 67] [ Top ] #### FILL_PATTERN_LIGHTGRAY = 'lightGray' [line 68] [ Top ] #### FILL_PATTERN_LIGHTGRID = 'lightGrid' [line 69] [ Top ] #### FILL_PATTERN_LIGHTHORIZONTAL = 'lightHorizontal' [line 70] [ Top ] #### FILL_PATTERN_LIGHTTRELLIS = 'lightTrellis' [line 71] [ Top ] #### FILL_PATTERN_LIGHTUP = 'lightUp' [line 72] [ Top ] #### FILL_PATTERN_LIGHTVERTICAL = 'lightVertical' [line 73] [ Top ] #### FILL_PATTERN_MEDIUMGRAY = 'mediumGray' [line 74] [ Top ] #### FILL_SOLID = 'solid' [line 55] [ Top ] Documentation generated on Mon, 11 Jan 2010 08:09:25 +0100 by phpDocumentor 1.4.1