PHPExcel_Worksheet

# Class: PHPExcel_Worksheet_HeaderFooterDrawing Source Location: /PHPExcel/Worksheet/HeaderFooterDrawing.php
### Class Overview
    PHPExcel_Worksheet_BaseDrawing
       |
       --PHPExcel_Worksheet_Drawing
          |
          --PHPExcel_Worksheet_HeaderFooterDrawing
PHPExcel_Worksheet_HeaderFooterDrawing #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) Implements interfaces: PHPExcel_IComparable | ### Variables $_height $_name $_offsetX $_offsetY $_path $_resizeProportional $_width | ### Methods __construct getExtension getFilename getHashCode getHeight getName getOffsetX getOffsetY getPath getResizeProportional getWidth setHeight setName setOffsetX setOffsetY setPath setResizeProportional setWidth setWidthAndHeight __clone
### Inherited Variables #### Class: PHPExcel_Worksheet_BaseDrawing PHPExcel_Worksheet_BaseDrawing::$_coordinates PHPExcel_Worksheet_BaseDrawing::$_description PHPExcel_Worksheet_BaseDrawing::$_imageCounter PHPExcel_Worksheet_BaseDrawing::$_imageIndex PHPExcel_Worksheet_BaseDrawing::$_rotation PHPExcel_Worksheet_BaseDrawing::$_shadow PHPExcel_Worksheet_BaseDrawing::$_worksheet | ### Inherited Methods #### Class: PHPExcel_Worksheet_Drawing PHPExcel_Worksheet_Drawing::__construct() Create a new PHPExcel_Worksheet_Drawing PHPExcel_Worksheet_Drawing::getExtension() Get Extension PHPExcel_Worksheet_Drawing::getFilename() Get Filename PHPExcel_Worksheet_Drawing::getHashCode() Get hash code PHPExcel_Worksheet_Drawing::getIndexedFilename() Get indexed filename (using image index) PHPExcel_Worksheet_Drawing::getPath() Get Path PHPExcel_Worksheet_Drawing::setPath() Set Path PHPExcel_Worksheet_Drawing::__clone() Implement PHP __clone to create a deep clone, not just a shallow copy. #### Class: PHPExcel_Worksheet_BaseDrawing PHPExcel_Worksheet_BaseDrawing::__construct() Create a new PHPExcel_Worksheet_BaseDrawing PHPExcel_Worksheet_BaseDrawing::getCoordinates() Get Coordinates PHPExcel_Worksheet_BaseDrawing::getDescription() Get Description PHPExcel_Worksheet_BaseDrawing::getHashCode() Get hash code PHPExcel_Worksheet_BaseDrawing::getHeight() Get Height PHPExcel_Worksheet_BaseDrawing::getImageIndex() Get image index PHPExcel_Worksheet_BaseDrawing::getName() Get Name PHPExcel_Worksheet_BaseDrawing::getOffsetX() Get OffsetX PHPExcel_Worksheet_BaseDrawing::getOffsetY() Get OffsetY PHPExcel_Worksheet_BaseDrawing::getResizeProportional() Get ResizeProportional PHPExcel_Worksheet_BaseDrawing::getRotation() Get Rotation PHPExcel_Worksheet_BaseDrawing::getShadow() Get Shadow PHPExcel_Worksheet_BaseDrawing::getWidth() Get Width PHPExcel_Worksheet_BaseDrawing::getWorksheet() Get Worksheet PHPExcel_Worksheet_BaseDrawing::setCoordinates() Set Coordinates PHPExcel_Worksheet_BaseDrawing::setDescription() Set Description PHPExcel_Worksheet_BaseDrawing::setHeight() Set Height PHPExcel_Worksheet_BaseDrawing::setName() Set Name PHPExcel_Worksheet_BaseDrawing::setOffsetX() Set OffsetX PHPExcel_Worksheet_BaseDrawing::setOffsetY() Set OffsetY PHPExcel_Worksheet_BaseDrawing::setResizeProportional() Set ResizeProportional PHPExcel_Worksheet_BaseDrawing::setRotation() Set Rotation PHPExcel_Worksheet_BaseDrawing::setShadow() Set Shadow PHPExcel_Worksheet_BaseDrawing::setWidth() Set Width PHPExcel_Worksheet_BaseDrawing::setWidthAndHeight() Set width and height with proportional resize PHPExcel_Worksheet_BaseDrawing::setWorksheet() Set Worksheet PHPExcel_Worksheet_BaseDrawing::__clone() Implement PHP __clone to create a deep clone, not just a shallow copy.
### Class Details [line 57] PHPExcel_Worksheet_HeaderFooterDrawing PHPExcel_Worksheet_HeaderFooterDrawing #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_height = [line 99] Height Height #### Tags:
access: | protected
Type: | int
Overrides: | Array
[ Top ] #### $_name = [line 71] Name Name #### Tags:
access: | protected
Type: | string
Overrides: | Array
[ Top ] #### $_offsetX = [line 78] Offset X Offset X #### Tags:
access: | protected
Type: | int
Overrides: | Array
[ Top ] #### $_offsetY = [line 85] Offset Y Offset Y #### Tags:
access: | protected
Type: | int
Overrides: | Array
[ Top ] #### $_path = [line 64] Path Path #### Tags:
access: | private
Type: | string
Overrides: | Array
[ Top ] #### $_resizeProportional = [line 106] Proportional resize Proportional resize #### Tags:
access: | protected
Type: | boolean
Overrides: | Array
[ Top ] #### $_width = [line 92] Width Width #### Tags:
access: | protected
Type: | int
Overrides: | Array
[ Top ] ### Class Methods ### constructor __construct [line 111]
`PHPExcel_Worksheet_HeaderFooterDrawing __construct( )`
Create a new PHPExcel_Worksheet_HeaderFooterDrawing Create a new PHPExcel_Worksheet_HeaderFooterDrawing #### Tags:
access: | public
Overrides PHPExcel_Worksheet_Drawing::__construct() (Create a new PHPExcel_Worksheet_Drawing) [ Top ] ### method getExtension [line 301]
`string getExtension( )`
Get Extension Get Extension #### Tags:
access: | public
Overrides PHPExcel_Worksheet_Drawing::getExtension() (Get Extension) [ Top ] ### method getFilename [line 292]
`string getFilename( )`
Get Filename Get Filename #### Tags:
access: | public
Overrides PHPExcel_Worksheet_Drawing::getFilename() (Get Filename) [ Top ] ### method getHashCode [line 345]
`string getHashCode( )`
Get hash code Get hash code #### Tags:
return: | Hash code
access: | public
Overrides PHPExcel_Worksheet_Drawing::getHashCode() (Get hash code) [ Top ] ### method getHeight [line 216]
`int getHeight( )`
Get Height Get Height #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::getHeight() (Get Height) [ Top ] ### method getName [line 128]
`string getName( )`
Get Name Get Name #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::getName() (Get Name) [ Top ] ### method getOffsetX [line 148]
`int getOffsetX( )`
Get OffsetX Get OffsetX #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::getOffsetX() (Get OffsetX) [ Top ] ### method getOffsetY [line 168]
`int getOffsetY( )`
Get OffsetY Get OffsetY #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::getOffsetY() (Get OffsetY) [ Top ] ### method getPath [line 310]
`string getPath( )`
Get Path Get Path #### Tags:
access: | public
Overrides PHPExcel_Worksheet_Drawing::getPath() (Get Path) [ Top ] ### method getResizeProportional [line 272]
`boolean getResizeProportional( )`
Get ResizeProportional Get ResizeProportional #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::getResizeProportional() (Get ResizeProportional) [ Top ] ### method getWidth [line 188]
`int getWidth( )`
Get Width Get Width #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::getWidth() (Get Width) [ Top ] ### method setHeight [line 226]
`PHPExcel_Worksheet_HeaderFooterDrawing setHeight( [int $pValue = 0])`
Set Height Set Height #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::setHeight() (Set Height) #### Parameters:
int | $pValue |
[ Top ] ### method setName [line 138]
`PHPExcel_Worksheet_HeaderFooterDrawing setName( [string $pValue = ''])`
Set Name Set Name #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::setName() (Set Name) #### Parameters:
string | $pValue |
[ Top ] ### method setOffsetX [line 158]
`PHPExcel_Worksheet_HeaderFooterDrawing setOffsetX( [int $pValue = 0])`
Set OffsetX Set OffsetX #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::setOffsetX() (Set OffsetX) #### Parameters:
int | $pValue |
[ Top ] ### method setOffsetY [line 178]
`PHPExcel_Worksheet_HeaderFooterDrawing setOffsetY( [int $pValue = 0])`
Set OffsetY Set OffsetY #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::setOffsetY() (Set OffsetY) #### Parameters:
int | $pValue |
[ Top ] ### method setPath [line 322]
`PHPExcel_Worksheet_HeaderFooterDrawing setPath( [string $pValue = ''], [boolean $pVerifyFile = true])`
Set Path Set Path #### Tags:
throws: | Exception
access: | public
Overrides PHPExcel_Worksheet_Drawing::setPath() (Set Path) #### Parameters:
string | $pValue | File path
boolean | $pVerifyFile | Verify file
[ Top ] ### method setResizeProportional [line 282]
`PHPExcel_Worksheet_HeaderFooterDrawing setResizeProportional( [boolean $pValue = true])`
Set ResizeProportional Set ResizeProportional #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::setResizeProportional() (Set ResizeProportional) #### Parameters:
boolean | $pValue |
[ Top ] ### method setWidth [line 198]
`PHPExcel_Worksheet_HeaderFooterDrawing setWidth( [int $pValue = 0])`
Set Width Set Width #### Tags:
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::setWidth() (Set Width) #### Parameters:
int | $pValue |
[ Top ] ### method setWidthAndHeight [line 252]
`PHPExcel_Worksheet_HeaderFooterDrawing setWidthAndHeight( [int $width = 0], [int $height = 0])`
Set width and height with proportional resize Set width and height with proportional resize Example: $objDrawing->setResizeProportional(true); $objDrawing->setWidthAndHeight(160,120); #### Tags:
author: | Vincent@luo MSN:kele_100@hotmail.com
access: | public
Overrides PHPExcel_Worksheet_BaseDrawing::setWidthAndHeight() (Set width and height with proportional resize) #### Parameters:
int | $width |
int | $height |
[ Top ] ### method __clone [line 360]
`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
Overrides PHPExcel_Worksheet_Drawing::__clone() (Implement PHP __clone to create a deep clone, not just a shallow copy.) [ Top ] Documentation generated on Mon, 11 Jan 2010 08:11:19 +0100 by phpDocumentor 1.4.1