PHPExcel_Shared_Escher

# Class: PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer Source Location: /PHPExcel/Shared/Escher/DgContainer/SpgrContainer/SpContainer.php
### Class Overview
PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) | ### Variables $_endCoordinates $_endOffsetX $_endOffsetY $_OPT $_parent $_spgr $_spId $_spType $_startCoordinates $_startOffsetX $_startOffsetY | ### Methods getEndCoordinates getEndOffsetX getEndOffsetY getNestingLevel getOPT getOPTCollection getParent getSpgr getSpId getSpType getStartCoordinates getStartOffsetX getStartOffsetY setEndCoordinates setEndOffsetX setEndOffsetY setOPT setParent setSpgr setSpId setSpType setStartCoordinates setStartOffsetX setStartOffsetY
### Class Details [line 35] PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_endCoordinates = [line 98] Cell coordinates of bottom-right corner of shape, e. Cell coordinates of bottom-right corner of shape, e.g. 'B2' #### Tags:
access: | private
Type: | string
[ Top ] #### $_endOffsetX = [line 105] Horizontal offset of bottom-right corner of shape measured in 1/1024 of column width Horizontal offset of bottom-right corner of shape measured in 1/1024 of column width #### Tags:
access: | private
Type: | int
[ Top ] #### $_endOffsetY = [line 112] Vertical offset of bottom-right corner of shape measured in 1/256 of row height Vertical offset of bottom-right corner of shape measured in 1/256 of row height #### Tags:
access: | private
Type: | int
[ Top ] #### $_OPT = [line 70] Array of options Array of options #### Tags:
access: | private
Type: | array
[ Top ] #### $_parent = [line 42] Parent Shape Group Container Parent Shape Group Container #### Tags:
access: | private
Type: | PHPExcel_Shared_Escher_DgContainer_SpgrContainer
[ Top ] #### $_spgr = false [line 49] Is this a group shape? Is this a group shape? #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_spId = [line 63] Shape index (usually group shape has index 0, and the rest: 1,2,3. Shape index (usually group shape has index 0, and the rest: 1,2,3...) #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_spType = [line 56] Shape type Shape type #### Tags:
access: | private
Type: | int
[ Top ] #### $_startCoordinates = [line 77] Cell coordinates of upper-left corner of shape, e. Cell coordinates of upper-left corner of shape, e.g. 'A1' #### Tags:
access: | private
Type: | string
[ Top ] #### $_startOffsetX = [line 84] Horizontal offset of upper-left corner of shape measured in 1/1024 of column width Horizontal offset of upper-left corner of shape measured in 1/1024 of column width #### Tags:
access: | private
Type: | int
[ Top ] #### $_startOffsetY = [line 91] Vertical offset of upper-left corner of shape measured in 1/256 of row height Vertical offset of upper-left corner of shape measured in 1/256 of row height #### Tags:
access: | private
Type: | int
[ Top ] ### Class Methods ### method getEndCoordinates [line 304]
`string getEndCoordinates( )`
Get cell coordinates of bottom-right corner of shape Get cell coordinates of bottom-right corner of shape #### Tags:
access: | public
[ Top ] ### method getEndOffsetX [line 324]
`int getEndOffsetX( )`
Get offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width Get offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width #### Tags:
access: | public
[ Top ] ### method getEndOffsetY [line 344]
`int getEndOffsetY( )`
Get offset in y-direction of bottom-right corner of shape measured in 1/256 of row height Get offset in y-direction of bottom-right corner of shape measured in 1/256 of row height #### Tags:
access: | public
[ Top ] ### method getNestingLevel [line 356]
`int getNestingLevel( )`
Get the nesting level of this spContainer. Get the nesting level of this spContainer. This is the number of spgrContainers between this spContainer and the dgContainer. A value of 1 = immediately within first spgrContainer Higher nesting level occurs if and only if spContainer is part of a shape group #### Tags:
return: | Nesting level
access: | public
[ Top ] ### method getOPT [line 211]
`mixed getOPT( int $property)`
Get an option for the Shape Group Container Get an option for the Shape Group Container #### Tags:
access: | public
#### Parameters:
int | $property | The number specifies the option
[ Top ] ### method getOPTCollection [line 224]
`array getOPTCollection( )`
Get the collection of options Get the collection of options #### Tags:
access: | public
[ Top ] ### method getParent [line 129]
`PHPExcel_Shared_Escher_DgContainer_SpgrContainer getParent( )`
Get the parent Shape Group Container Get the parent Shape Group Container #### Tags:
access: | public
[ Top ] ### method getSpgr [line 149]
`boolean getSpgr( )`
Get whether this is a group shape Get whether this is a group shape #### Tags:
access: | public
[ Top ] ### method getSpId [line 189]
`int getSpId( )`
Get the shape index Get the shape index #### Tags:
access: | public
[ Top ] ### method getSpType [line 169]
`int getSpType( )`
Get the shape type Get the shape type #### Tags:
access: | public
[ Top ] ### method getStartCoordinates [line 244]
`string getStartCoordinates( )`
Get cell coordinates of upper-left corner of shape Get cell coordinates of upper-left corner of shape #### Tags:
access: | public
[ Top ] ### method getStartOffsetX [line 264]
`int getStartOffsetX( )`
Get offset in x-direction of upper-left corner of shape measured in 1/1024 of column width Get offset in x-direction of upper-left corner of shape measured in 1/1024 of column width #### Tags:
access: | public
[ Top ] ### method getStartOffsetY [line 284]
`int getStartOffsetY( )`
Get offset in y-direction of upper-left corner of shape measured in 1/256 of row height Get offset in y-direction of upper-left corner of shape measured in 1/256 of row height #### Tags:
access: | public
[ Top ] ### method setEndCoordinates [line 294]
`void setEndCoordinates( [string $value = 'A1'])`
Set cell coordinates of bottom-right corner of shape Set cell coordinates of bottom-right corner of shape #### Tags:
access: | public
#### Parameters:
string | $value |
[ Top ] ### method setEndOffsetX [line 314]
`void setEndOffsetX( [ $endOffsetX = 0], int $startOffsetX)`
Set offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width Set offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width #### Tags:
access: | public
#### Parameters:
int | $startOffsetX |
| $endOffsetX |
[ Top ] ### method setEndOffsetY [line 334]
`void setEndOffsetY( [int $endOffsetY = 0])`
Set offset in y-direction of bottom-right corner of shape measured in 1/256 of row height Set offset in y-direction of bottom-right corner of shape measured in 1/256 of row height #### Tags:
access: | public
#### Parameters:
int | $endOffsetY |
[ Top ] ### method setOPT [line 200]
`void setOPT( int $property, mixed $value)`
Set an option for the Shape Group Container Set an option for the Shape Group Container #### Tags:
access: | public
#### Parameters:
int | $property | The number specifies the option
mixed | $value |
[ Top ] ### method setParent [line 119]
`void setParent( PHPExcel_Shared_Escher_DgContainer_SpgrContainer $parent)`
Set parent Shape Group Container Set parent Shape Group Container #### Tags:
access: | public
#### Parameters:
PHPExcel_Shared_Escher_DgContainer_SpgrContainer | $parent |
[ Top ] ### method setSpgr [line 139]
`void setSpgr( [boolean $value = false])`
Set whether this is a group shape Set whether this is a group shape #### Tags:
access: | public
#### Parameters:
boolean | $value |
[ Top ] ### method setSpId [line 179]
`void setSpId( int $value)`
Set the shape index Set the shape index #### Tags:
access: | public
#### Parameters:
int | $value |
[ Top ] ### method setSpType [line 159]
`void setSpType( int $value)`
Set the shape type Set the shape type #### Tags:
access: | public
#### Parameters:
int | $value |
[ Top ] ### method setStartCoordinates [line 234]
`void setStartCoordinates( [string $value = 'A1'])`
Set cell coordinates of upper-left corner of shape Set cell coordinates of upper-left corner of shape #### Tags:
access: | public
#### Parameters:
string | $value |
[ Top ] ### method setStartOffsetX [line 254]
`void setStartOffsetX( [int $startOffsetX = 0])`
Set offset in x-direction of upper-left corner of shape measured in 1/1024 of column width Set offset in x-direction of upper-left corner of shape measured in 1/1024 of column width #### Tags:
access: | public
#### Parameters:
int | $startOffsetX |
[ Top ] ### method setStartOffsetY [line 274]
`void setStartOffsetY( [int $startOffsetY = 0])`
Set offset in y-direction of upper-left corner of shape measured in 1/256 of row height Set offset in y-direction of upper-left corner of shape measured in 1/256 of row height #### Tags:
access: | public
#### Parameters:
int | $startOffsetY |
[ Top ] Documentation generated on Mon, 11 Jan 2010 08:13:56 +0100 by phpDocumentor 1.4.1