ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer Class Reference
+ Collaboration diagram for PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer:

Public Member Functions

 setParent ($parent)
 Set parent Shape Group Container. More...
 
 getParent ()
 Get the parent Shape Group Container. More...
 
 setSpgr ($value=false)
 Set whether this is a group shape. More...
 
 getSpgr ()
 Get whether this is a group shape. More...
 
 setSpType ($value)
 Set the shape type. More...
 
 getSpType ()
 Get the shape type. More...
 
 setSpFlag ($value)
 Set the shape flag. More...
 
 getSpFlag ()
 Get the shape flag. More...
 
 setSpId ($value)
 Set the shape index. More...
 
 getSpId ()
 Get the shape index. More...
 
 setOPT ($property, $value)
 Set an option for the Shape Group Container. More...
 
 getOPT ($property)
 Get an option for the Shape Group Container. More...
 
 getOPTCollection ()
 Get the collection of options. More...
 
 setStartCoordinates ($value='A1')
 Set cell coordinates of upper-left corner of shape. More...
 
 getStartCoordinates ()
 Get cell coordinates of upper-left corner of shape. More...
 
 setStartOffsetX ($startOffsetX=0)
 Set offset in x-direction of upper-left corner of shape measured in 1/1024 of column width. More...
 
 getStartOffsetX ()
 Get offset in x-direction of upper-left corner of shape measured in 1/1024 of column width. More...
 
 setStartOffsetY ($startOffsetY=0)
 Set offset in y-direction of upper-left corner of shape measured in 1/256 of row height. More...
 
 getStartOffsetY ()
 Get offset in y-direction of upper-left corner of shape measured in 1/256 of row height. More...
 
 setEndCoordinates ($value='A1')
 Set cell coordinates of bottom-right corner of shape. More...
 
 getEndCoordinates ()
 Get cell coordinates of bottom-right corner of shape. More...
 
 setEndOffsetX ($endOffsetX=0)
 Set offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width. More...
 
 getEndOffsetX ()
 Get offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width. More...
 
 setEndOffsetY ($endOffsetY=0)
 Set offset in y-direction of bottom-right corner of shape measured in 1/256 of row height. More...
 
 getEndOffsetY ()
 Get offset in y-direction of bottom-right corner of shape measured in 1/256 of row height. More...
 
 getNestingLevel ()
 Get the nesting level of this spContainer. More...
 

Private Attributes

 $_parent
 
 $_spgr = false
 
 $_spType
 
 $_spFlag
 
 $_spId
 
 $_OPT
 
 $_startCoordinates
 
 $_startOffsetX
 
 $_startOffsetY
 
 $_endCoordinates
 
 $_endOffsetX
 
 $_endOffsetY
 

Detailed Description

Definition at line 35 of file SpContainer.php.

Member Function Documentation

◆ getEndCoordinates()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getEndCoordinates ( )

Get cell coordinates of bottom-right corner of shape.

Returns
string

Definition at line 331 of file SpContainer.php.

References $_endCoordinates.

◆ getEndOffsetX()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getEndOffsetX ( )

Get offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width.

Returns
int

Definition at line 351 of file SpContainer.php.

References $_endOffsetX.

◆ getEndOffsetY()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getEndOffsetY ( )

Get offset in y-direction of bottom-right corner of shape measured in 1/256 of row height.

Returns
int

Definition at line 371 of file SpContainer.php.

References $_endOffsetY.

◆ getNestingLevel()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getNestingLevel ( )

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

Returns
int Nesting level

Definition at line 383 of file SpContainer.php.

References getParent().

384  {
385  $nestingLevel = 0;
386 
387  $parent = $this->getParent();
388  while ($parent instanceof PHPExcel_Shared_Escher_DgContainer_SpgrContainer) {
389  ++$nestingLevel;
390  $parent = $parent->getParent();
391  }
392 
393  return $nestingLevel;
394  }
getParent()
Get the parent Shape Group Container.
+ Here is the call graph for this function:

◆ getOPT()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getOPT (   $property)

Get an option for the Shape Group Container.

Parameters
int$propertyThe number specifies the option
Returns
mixed

Definition at line 238 of file SpContainer.php.

239  {
240  if (isset($this->_OPT[$property])) {
241  return $this->_OPT[$property];
242  }
243  return null;
244  }

◆ getOPTCollection()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getOPTCollection ( )

Get the collection of options.

Returns
array

Definition at line 251 of file SpContainer.php.

References $_OPT.

◆ getParent()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getParent ( )

Get the parent Shape Group Container.

Returns
PHPExcel_Shared_Escher_DgContainer_SpgrContainer

Definition at line 136 of file SpContainer.php.

References $_parent.

Referenced by getNestingLevel().

+ Here is the caller graph for this function:

◆ getSpFlag()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getSpFlag ( )

Get the shape flag.

Returns
int

Definition at line 196 of file SpContainer.php.

References $_spFlag.

◆ getSpgr()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getSpgr ( )

Get whether this is a group shape.

Returns
boolean

Definition at line 156 of file SpContainer.php.

References $_spgr.

◆ getSpId()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getSpId ( )

Get the shape index.

Returns
int

Definition at line 216 of file SpContainer.php.

References $_spId.

◆ getSpType()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getSpType ( )

Get the shape type.

Returns
int

Definition at line 176 of file SpContainer.php.

References $_spType.

◆ getStartCoordinates()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getStartCoordinates ( )

Get cell coordinates of upper-left corner of shape.

Returns
string

Definition at line 271 of file SpContainer.php.

References $_startCoordinates.

◆ getStartOffsetX()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getStartOffsetX ( )

Get offset in x-direction of upper-left corner of shape measured in 1/1024 of column width.

Returns
int

Definition at line 291 of file SpContainer.php.

References $_startOffsetX.

◆ getStartOffsetY()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::getStartOffsetY ( )

Get offset in y-direction of upper-left corner of shape measured in 1/256 of row height.

Returns
int

Definition at line 311 of file SpContainer.php.

References $_startOffsetY.

◆ setEndCoordinates()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setEndCoordinates (   $value = 'A1')

Set cell coordinates of bottom-right corner of shape.

Parameters
string$value

Definition at line 321 of file SpContainer.php.

322  {
323  $this->_endCoordinates = $value;
324  }

◆ setEndOffsetX()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setEndOffsetX (   $endOffsetX = 0)

Set offset in x-direction of bottom-right corner of shape measured in 1/1024 of column width.

Parameters
int$startOffsetX

Definition at line 341 of file SpContainer.php.

342  {
343  $this->_endOffsetX = $endOffsetX;
344  }

◆ setEndOffsetY()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setEndOffsetY (   $endOffsetY = 0)

Set offset in y-direction of bottom-right corner of shape measured in 1/256 of row height.

Parameters
int$endOffsetY

Definition at line 361 of file SpContainer.php.

362  {
363  $this->_endOffsetY = $endOffsetY;
364  }

◆ setOPT()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setOPT (   $property,
  $value 
)

Set an option for the Shape Group Container.

Parameters
int$propertyThe number specifies the option
mixed$value

Definition at line 227 of file SpContainer.php.

228  {
229  $this->_OPT[$property] = $value;
230  }

◆ setParent()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setParent (   $parent)

Set parent Shape Group Container.

Parameters
PHPExcel_Shared_Escher_DgContainer_SpgrContainer$parent

Definition at line 126 of file SpContainer.php.

127  {
128  $this->_parent = $parent;
129  }

◆ setSpFlag()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setSpFlag (   $value)

Set the shape flag.

Parameters
int$value

Definition at line 186 of file SpContainer.php.

187  {
188  $this->_spFlag = $value;
189  }

◆ setSpgr()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setSpgr (   $value = false)

Set whether this is a group shape.

Parameters
boolean$value

Definition at line 146 of file SpContainer.php.

147  {
148  $this->_spgr = $value;
149  }

◆ setSpId()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setSpId (   $value)

Set the shape index.

Parameters
int$value

Definition at line 206 of file SpContainer.php.

207  {
208  $this->_spId = $value;
209  }

◆ setSpType()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setSpType (   $value)

Set the shape type.

Parameters
int$value

Definition at line 166 of file SpContainer.php.

167  {
168  $this->_spType = $value;
169  }

◆ setStartCoordinates()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setStartCoordinates (   $value = 'A1')

Set cell coordinates of upper-left corner of shape.

Parameters
string$value

Definition at line 261 of file SpContainer.php.

262  {
263  $this->_startCoordinates = $value;
264  }

◆ setStartOffsetX()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setStartOffsetX (   $startOffsetX = 0)

Set offset in x-direction of upper-left corner of shape measured in 1/1024 of column width.

Parameters
int$startOffsetX

Definition at line 281 of file SpContainer.php.

282  {
283  $this->_startOffsetX = $startOffsetX;
284  }

◆ setStartOffsetY()

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::setStartOffsetY (   $startOffsetY = 0)

Set offset in y-direction of upper-left corner of shape measured in 1/256 of row height.

Parameters
int$startOffsetY

Definition at line 301 of file SpContainer.php.

302  {
303  $this->_startOffsetY = $startOffsetY;
304  }

Field Documentation

◆ $_endCoordinates

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_endCoordinates
private

Definition at line 105 of file SpContainer.php.

Referenced by getEndCoordinates().

◆ $_endOffsetX

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_endOffsetX
private

Definition at line 112 of file SpContainer.php.

Referenced by getEndOffsetX().

◆ $_endOffsetY

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_endOffsetY
private

Definition at line 119 of file SpContainer.php.

Referenced by getEndOffsetY().

◆ $_OPT

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_OPT
private

Definition at line 77 of file SpContainer.php.

Referenced by getOPTCollection().

◆ $_parent

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_parent
private

Definition at line 42 of file SpContainer.php.

Referenced by getParent().

◆ $_spFlag

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_spFlag
private

Definition at line 63 of file SpContainer.php.

Referenced by getSpFlag().

◆ $_spgr

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_spgr = false
private

Definition at line 49 of file SpContainer.php.

Referenced by getSpgr().

◆ $_spId

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_spId
private

Definition at line 70 of file SpContainer.php.

Referenced by getSpId().

◆ $_spType

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_spType
private

Definition at line 56 of file SpContainer.php.

Referenced by getSpType().

◆ $_startCoordinates

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_startCoordinates
private

Definition at line 84 of file SpContainer.php.

Referenced by getStartCoordinates().

◆ $_startOffsetX

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_startOffsetX
private

Definition at line 91 of file SpContainer.php.

Referenced by getStartOffsetX().

◆ $_startOffsetY

PHPExcel_Shared_Escher_DgContainer_SpgrContainer_SpContainer::$_startOffsetY
private

Definition at line 98 of file SpContainer.php.

Referenced by getStartOffsetY().


The documentation for this class was generated from the following file: