Constants

LEFT

LEFT = 'LEFT'

Alignment constants

RIGHT

RIGHT = 'RIGHT'

Properties

$alignment

$alignment : string

Text alignment

Type

string

$leftX

$leftX : integer

Left X boundary

Type

integer

$rightX

$rightX : integer

Right X boundary

Type

integer

$leading

$leading : integer

Text leading

Type

integer

$box

$box : array

Wrap box boundary

Type

array

Methods

__construct()

__construct(string  $alignment = self::LEFT, integer  $leftX, integer  $rightX, array  $box = array(), integer  $leading) 

Constructor

Instantiate a PDF text wrap object.

Parameters

string $alignment
integer $leftX
integer $rightX
array $box
integer $leading

getAlignment()

getAlignment() : string

Get alignment

Returns

string

getLeftX()

getLeftX() : integer

Get the left X

Returns

integer

getRightX()

getRightX() : integer

Get the right X

Returns

integer

getLeading()

getLeading() : integer

Get the leading

Returns

integer

hasLeftX()

hasLeftX() : boolean

Has left X

Returns

boolean

hasRightX()

hasRightX() : boolean

Has right X

Returns

boolean

hasLeading()

hasLeading() : boolean

Has leading

Returns

boolean

isLeft()

isLeft() : boolean

Is LEFT alignment

Returns

boolean

isRight()

isRight() : boolean

Is RIGHT alignment

Returns

boolean

createLeft()

createLeft(integer  $leftX, integer  $rightX, array  $box = array(), integer  $leading) : \Pop\Pdf\Document\Page\Text\Wrap

Create LEFT alignment object

Parameters

integer $leftX
integer $rightX
array $box
integer $leading

Returns

\Pop\Pdf\Document\Page\Text\Wrap

createRight()

createRight(integer  $leftX, integer  $rightX, array  $box = array(), integer  $leading) : \Pop\Pdf\Document\Page\Text\Wrap

Create RIGHT alignment object

Parameters

integer $leftX
integer $rightX
array $box
integer $leading

Returns

\Pop\Pdf\Document\Page\Text\Wrap

setBox()

setBox(array  $box) : \Pop\Pdf\Document\Page\Text\Wrap

Set the wrap box boundary

Parameters

array $box

Throws

\InvalidArgumentException

Returns

\Pop\Pdf\Document\Page\Text\Wrap

setBoxCoordinates()

setBoxCoordinates(integer  $left, integer  $right, integer  $top, integer  $bottom) : \Pop\Pdf\Document\Page\Text\Wrap

Set the wrap box boundary by coordinates

Parameters

integer $left
integer $right
integer $top
integer $bottom

Returns

\Pop\Pdf\Document\Page\Text\Wrap

getBox()

getBox() : array

Get the wrap box boundary

Returns

array