API Documentation
\
Pop
Acl
Assertion
Policy
Audit
Adapter
Model
Auth
Cache
Adapter
Code
Generator
Traits
Reflection
Config
Console
Controller
Cookie
Css
Color
Csv
Db
Adapter
Profiler
Gateway
Record
Relationships
Sql
Migration
Parser
Predicate
Schema
Formatter
Seeder
Debug
Handler
Storage
Dir
Dom
Event
Filter
Form
Element
Input
Select
Ftp
Http
Client
Server
Request
I18n
Format
Image
Adapter
Adjust
Color
Draw
Effect
Filter
Layer
Type
Kettle
Controller
Event
Model
Loader
Log
Writer
Mail
Client
Message
Transport
Smtp
Auth
Stream
Byte
Filter
Mime
Part
Model
Module
Nav
Paginator
Pdf
Build
Font
Standard
TrueType
Table
Cmap
Html
Image
PdfObject
Document
Page
Annotation
Color
Field
Text
Queue
Adapter
Processor
Jobs
Router
Match
Service
Session
Utils
Validator
View
Template
Stream
Popcorn

\Pop\Pdf\Document\Page\TextWrap

Pdf page text wrap class

Summary

Methods
Properties
Constants
__construct()
setAlignment()
setLeftX()
setRightX()
setLeading()
getAlignment()
getLeftX()
getRightX()
getLeading()
hasLeftX()
hasRightX()
hasLeading()
isLeft()
isRight()
createLeft()
createRight()
setBox()
setBoxCoordinates()
getBox()
getStrings()
No public properties found
LEFT
RIGHT
No protected methods found
$alignment
$leftX
$rightX
$leading
$box
N/A
No private methods found
No private properties found
N/A

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