[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/phpexcel/PHPExcel/Style/ -> Color.php (summary)

(no description)

File Size: 443 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PHPExcel_Style_Color:: (16 methods):
  __construct()
  bindParent()
  getSharedComponent()
  getStyleArray()
  applyFromArray()
  getARGB()
  setARGB()
  getRGB()
  setRGB()
  getColourComponent()
  getRed()
  getGreen()
  getBlue()
  changeBrightness()
  indexedColor()
  getHashCode()


Class: PHPExcel_Style_Color  - X-Ref

PHPExcel_Style_Color

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

__construct($pARGB = PHPExcel_Style_Color::COLOR_BLACK, $isSupervisor = false, $isConditional = false)   X-Ref
Create a new PHPExcel_Style_Color

param: string    $pARGB            ARGB value for the colour
param: boolean    $isSupervisor    Flag indicating if this is a supervisor or not
param: boolean    $isConditional    Flag indicating if this is a conditional style or not

bindParent($parent, $parentPropertyName = null)   X-Ref
Bind parent. Only used for supervisor

param: mixed $parent
param: string $parentPropertyName
return: PHPExcel_Style_Color

getSharedComponent()   X-Ref
Get the shared style component for the currently active cell in currently active sheet.
Only used for style supervisor

return: PHPExcel_Style_Color

getStyleArray($array)   X-Ref
Build style array from subcomponents

param: array $array
return: array

applyFromArray($pStyles = null)   X-Ref
Apply styles from array

<code>
$objPHPExcel->getActiveSheet()->getStyle('B2')->getFont()->getColor()->applyFromArray( array('rgb' => '808080') );
</code>

param: array    $pStyles    Array containing style information
return: PHPExcel_Style_Color

getARGB()   X-Ref
Get ARGB

return: string

setARGB($pValue = PHPExcel_Style_Color::COLOR_BLACK)   X-Ref
Set ARGB

param: string $pValue
return: PHPExcel_Style_Color

getRGB()   X-Ref
Get RGB

return: string

setRGB($pValue = '000000')   X-Ref
Set RGB

param: string    $pValue    RGB value
return: PHPExcel_Style_Color

getColourComponent($RGB, $offset, $hex = true)   X-Ref
Get a specified colour component of an RGB value

param: string        $RGB        The colour as an RGB value (e.g. FF00CCCC or CCDDEE
param: int            $offset        Position within the RGB value to extract
param: boolean        $hex        Flag indicating whether the component should be returned as a hex or a
return: string        The extracted colour component

getRed($RGB, $hex = true)   X-Ref
Get the red colour component of an RGB value

param: string        $RGB        The colour as an RGB value (e.g. FF00CCCC or CCDDEE
param: boolean        $hex        Flag indicating whether the component should be returned as a hex or a
return: string        The red colour component

getGreen($RGB, $hex = true)   X-Ref
Get the green colour component of an RGB value

param: string        $RGB        The colour as an RGB value (e.g. FF00CCCC or CCDDEE
param: boolean        $hex        Flag indicating whether the component should be returned as a hex or a
return: string        The green colour component

getBlue($RGB, $hex = true)   X-Ref
Get the blue colour component of an RGB value

param: string        $RGB        The colour as an RGB value (e.g. FF00CCCC or CCDDEE
param: boolean        $hex        Flag indicating whether the component should be returned as a hex or a
return: string        The blue colour component

changeBrightness($hex, $adjustPercentage)   X-Ref
Adjust the brightness of a color

param: string        $hex    The colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE)
param: float        $adjustPercentage    The percentage by which to adjust the colour as a float from -1 to 1
return: string        The adjusted colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE)

indexedColor($pIndex, $background = false)   X-Ref
Get indexed color

param: int            $pIndex            Index entry point into the colour array
param: boolean        $background        Flag to indicate whether default background or foreground colour
return: PHPExcel_Style_Color

getHashCode()   X-Ref
Get hash code

return: string    Hash code



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1