PHPExcel_Style

# Class: PHPExcel_Style_Color Source Location: /PHPExcel/Style/Color.php
### Class Overview
PHPExcel_Style_Color #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) Implements interfaces: PHPExcel_IComparable | ### Variables $_argb $_indexedColors $_isSupervisor $_parent $_parentPropertyName | ### Constants COLOR_BLACK COLOR_BLUE COLOR_DARKBLUE COLOR_DARKGREEN COLOR_DARKRED COLOR_DARKYELLOW COLOR_GREEN COLOR_RED COLOR_WHITE COLOR_YELLOW | ### Methods applyFromArray bindParent __construct getActiveCell getActiveSheet getARGB getHashCode getIsSupervisor getRGB getSelectedCells getSharedComponent getStyleArray indexedColor setARGB setRGB __clone
### Class Details [line 48] PHPExcel_Style_Color PHPExcel_Style_Color #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### static $_indexedColors = [line 67] Indexed colors array Indexed colors array #### Tags:
access: | private
Type: | array
[ Top ] #### $_argb = [line 74] ARGB - Alpha RGB ARGB - Alpha RGB #### Tags:
access: | private
Type: | string
[ Top ] #### $_isSupervisor = [line 81] Supervisor? Supervisor? #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_parent = [line 88] Parent. Parent. Only used for supervisor #### Tags:
access: | private
Type: | mixed
[ Top ] #### $_parentPropertyName = [line 95] Parent property name Parent property name #### Tags:
access: | private
Type: | string
[ Top ] ### Class Methods ### static method indexedColor [line 312]
`static PHPExcel_Style_Color indexedColor( int $pIndex)`
Get indexed color Get indexed color #### Tags:
access: | public
#### Parameters:
int | $pIndex |
[ Top ] ### method applyFromArray [line 226]
`PHPExcel_Style_Color applyFromArray( [array $pStyles = null])`
Apply styles from array Apply styles from array $objPHPExcel->getActiveSheet()->getStyle('B2')->getFont()->getColor()->applyFromArray( array('rgb' => '808080') ); #### Tags:
throws: | Exception
access: | public
#### Parameters:
array | $pStyles | Array containing style information
[ Top ] ### method bindParent [line 118]
`PHPExcel_Style_Color bindParent( mixed $parent, string $parentPropertyName)`
Bind parent. Bind parent. Only used for supervisor #### Tags:
access: | public
#### Parameters:
mixed | $parent |
string | $parentPropertyName |
[ Top ] ### constructor __construct [line 102]
`PHPExcel_Style_Color __construct( [string $pARGB = PHPExcel_Style_Color::COLOR_BLACK], [ $isSupervisor = false])`
Create a new PHPExcel_Style_Color Create a new PHPExcel_Style_Color #### Tags:
access: | public
#### Parameters:
string | $pARGB |
| $isSupervisor |
[ Top ] ### method getActiveCell [line 185]
`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 163]
`PHPExcel_Worksheet getActiveSheet( )`
Get the currently active sheet. Get the currently active sheet. Only used for supervisor #### Tags:
access: | public
[ Top ] ### method getARGB [line 249]
`string getARGB( )`
Get ARGB Get ARGB #### Tags:
access: | public
[ Top ] ### method getHashCode [line 397]
`string getHashCode( )`
Get hash code Get hash code #### Tags:
return: | Hash code
access: | public
[ Top ] ### method getIsSupervisor [line 130]
`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 getRGB [line 280]
`string getRGB( )`
Get RGB Get RGB #### Tags:
access: | public
[ Top ] ### method getSelectedCells [line 174]
`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 141]
`PHPExcel_Style_Color 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 getStyleArray [line 196]
`array getStyleArray( array $array)`
Build style array from subcomponents Build style array from subcomponents #### Tags:
access: | public
#### Parameters:
array | $array |
[ Top ] ### method setARGB [line 262]
`PHPExcel_Style_Color setARGB( [string $pValue = PHPExcel_Style_Color::COLOR_BLACK])`
Set ARGB Set ARGB #### Tags:
access: | public
#### Parameters:
string | $pValue |
[ Top ] ### method setRGB [line 293]
`PHPExcel_Style_Color setRGB( [string $pValue = '000000'])`
Set RGB Set RGB #### Tags:
access: | public
#### Parameters:
string | $pValue |
[ Top ] ### method __clone [line 410]
`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 #### COLOR_BLACK = 'FF000000' [line 51] [ Top ] #### COLOR_BLUE = 'FF0000FF' [line 55] [ Top ] #### COLOR_DARKBLUE = 'FF000080' [line 56] [ Top ] #### COLOR_DARKGREEN = 'FF008000' [line 58] [ Top ] #### COLOR_DARKRED = 'FF800000' [line 54] [ Top ] #### COLOR_DARKYELLOW = 'FF808000' [line 60] [ Top ] #### COLOR_GREEN = 'FF00FF00' [line 57] [ Top ] #### COLOR_RED = 'FFFF0000' [line 53] [ Top ] #### COLOR_WHITE = 'FFFFFFFF' [line 52] [ Top ] #### COLOR_YELLOW = 'FFFFFF00' [line 59] [ Top ] Documentation generated on Mon, 11 Jan 2010 08:07:15 +0100 by phpDocumentor 1.4.1