Plugins

# Class: SpaceManager Source Location: /plugins/exportPdf/client/ExportPdfObjects.php
### Class Overview
Handles positioning of blocks in the PDF document. | ### Variables $allocated $levels $log $maxX $maxY $minX $minY $YoAtTop | ### Methods __construct allocateArea checkIn checkTableIn getAvailableSpan getBlockExtent getMaxExtent getX getY reset __call
### Class Details [line 664] Handles positioning of blocks in the PDF document. [ Top ] ### Class Variables #### $allocated = array() [line 700] #### Tags:
access: | protected
Type: | array
[ Top ] #### $levels = array() [line 705] #### Tags:
access: | protected
Type: | array
[ Top ] #### $log = [line 669] #### Tags:
access: | private
Type: | Logger
[ Top ] #### $maxX = [line 679] #### Tags:
access: | protected
Type: | float
[ Top ] #### $maxY = [line 689] #### Tags:
access: | protected
Type: | float
[ Top ] #### $minX = [line 674] #### Tags:
access: | protected
Type: | float
[ Top ] #### $minY = [line 684] #### Tags:
access: | protected
Type: | float
[ Top ] #### $YoAtTop = true [line 695] Indicates if the Y-origin is at top of page. #### Tags:
access: | protected
Type: | boolean
[ Top ] ### Class Methods ### constructor __construct [line 711]
`SpaceManager __construct( array $params)`
Constructor. #### Tags:
access: | public
#### Parameters:
array | $params | contains page max extent + Y-origin location.
[ Top ] ### method allocateArea [line 750]
`array allocateArea( PdfBlock $block, float $x, float $y)`
Records newly added areas in allocated space list. #### Tags:
return: | (X,Y)
access: | protected
#### Parameters:
PdfBlock | $block |
float | $x | X-coord of block reference point
float | $y | Y-coord of block reference point
[ Top ] ### method checkIn [line 850]
`array checkIn( PdfBlock $block, [boolean $dontAllocate = false])`
Returns the nearest available reference point (min X, min Y) according to the block positioning properties. #### Tags:
return: | (X,Y) of reference point
access: | public
#### Parameters:
PdfBlock | $block |
boolean | $dontAllocate | if true no space allocation is performed
[ Top ] ### method checkTableIn [line 914]
`array checkTableIn( PdfBlock $block, TableElement $table)`
Determines next available reference point coordinates for given table. #### Tags:
return: | (X,Y) of reference point
access: | public
#### Parameters:
PdfBlock | $block | table description block
TableElement | $table | table content
[ Top ] ### method getAvailableSpan [line 928]
`float getAvailableSpan( PdfBlock $block)`
Returns given block available width (parent block width). #### Tags:
access: | public
#### Parameters:
PdfBlock | $block |
[ Top ] ### method getBlockExtent [line 822]
`array getBlockExtent( [string $name = ''])`
Returns the min and max coordinates of given block. If name is invalid, returns the maximal allowed extent. #### Tags:
access: | protected
#### Parameters:
string | $name | block name
[ Top ] ### method getMaxExtent [line 837]
`array getMaxExtent( PdfBlock $block)`
Return x-coord of the block rightest point and y-coord of the block lowest allowed point. #### Tags:
return: | (x-rightest, y-lowest)
access: | public
#### Parameters:
PdfBlock | $block |
[ Top ] ### method getX [line 806]
`float getX( PdfBlock $block, float $minX, float $maxX)`
Computes the block reference point X-coordinate. #### Tags:
access: | protected
#### Parameters:
PdfBlock | $block |
float | $minX | extent minimal X-coord
float | $maxX | extent maximal X-coord
[ Top ] ### method getY [line 772]
`float getY( PdfBlock $block, float $minY, float $maxY)`
Computes the block reference point Y-coordinate. #### Tags:
access: | protected
#### Parameters:
PdfBlock | $block |
float | $minY | extent minimal Y-coord
float | $maxY | extent maximal Y-coord
[ Top ] ### method reset [line 738]
`void reset( )`
Resets allocated spaces. #### Tags:
access: | public
[ Top ] ### method __call [line 728]
`mixed __call( mixed $m, mixed $a)`
Used to get any property value #### Tags:
return: | property value
access: | public
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:46 +0200 by phpDocumentor 1.3.0RC3