Documentation

Link extends AbstractAnnotation
in package

Pdf page link annotation class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
5.2.0

Table of Contents

Properties

$borderWidth  : int
Border width
$dashGap  : int
Border dash gap
$dashLength  : int
Border dash length
$height  : int
Annotation height
$hRadius  : int
Horizontal border radius
$pageTarget  : int|null
Internal page object index target to link to
$vRadius  : int
Vertical border radius
$width  : int
Annotation width
$xTarget  : int
Internal x-position target to link to on internal page
$yTarget  : int
Internal y-position target to link to on internal page
$zTarget  : int
Internal z-position target (zoom) to link to on internal page

Methods

__construct()  : mixed
Constructor
getBorderWidth()  : int
Get the border width
getDashGap()  : int
Get the border dash gap
getDashLength()  : int
Get the border dash length
getHeight()  : int
Get the height
getHRadius()  : int
Get the horizontal border radius
getPageTarget()  : int|null
Get the page target
getStream()  : string
Get the annotation stream
getVRadius()  : int
Get the vertical border radius
getWidth()  : int
Get the width
getXTarget()  : int
Get the X target
getYTarget()  : int
Get the Y target
getZTarget()  : int
Get the Z (zoom) target
setBorderWidth()  : AbstractAnnotation
Set the border width
setDashGap()  : AbstractAnnotation
Set the border dash gap
setDashLength()  : AbstractAnnotation
Set the border dash length
setHeight()  : AbstractAnnotation
Set the height
setHRadius()  : AbstractAnnotation
Set the horizontal border radius
setPageTarget()  : Link
Set the page target
setVRadius()  : AbstractAnnotation
Set the vertical border radius
setWidth()  : AbstractAnnotation
Set the width
setXTarget()  : Link
Set the X target
setYTarget()  : Link
Set the Y target
setZTarget()  : Link
Set the Z (zoom) target

Properties

$pageTarget

Internal page object index target to link to

protected int|null $pageTarget = null

$xTarget

Internal x-position target to link to on internal page

protected int $xTarget = 0

$yTarget

Internal y-position target to link to on internal page

protected int $yTarget = 0

$zTarget

Internal z-position target (zoom) to link to on internal page

protected int $zTarget = 0

Methods

__construct()

Constructor

public __construct(int $width, int $height, int $xTarget, int $yTarget) : mixed

Instantiate a PDF link annotation object.

Parameters
$width : int
$height : int
$xTarget : int
$yTarget : int

getBorderWidth()

Get the border width

public getBorderWidth() : int
Return values
int

getDashGap()

Get the border dash gap

public getDashGap() : int
Return values
int

getDashLength()

Get the border dash length

public getDashLength() : int
Return values
int

getHRadius()

Get the horizontal border radius

public getHRadius() : int
Return values
int

getPageTarget()

Get the page target

public getPageTarget() : int|null
Return values
int|null

getStream()

Get the annotation stream

public getStream(int $i, int $x, int $y, int $pageIndex, array<string|int, mixed> $kids) : string
Parameters
$i : int
$x : int
$y : int
$pageIndex : int
$kids : array<string|int, mixed>
Return values
string

getVRadius()

Get the vertical border radius

public getVRadius() : int
Return values
int

getXTarget()

Get the X target

public getXTarget() : int
Return values
int

getYTarget()

Get the Y target

public getYTarget() : int
Return values
int

getZTarget()

Get the Z (zoom) target

public getZTarget() : int
Return values
int

setPageTarget()

Set the page target

public setPageTarget(int $pageTarget) : Link
Parameters
$pageTarget : int
Return values
Link

setXTarget()

Set the X target

public setXTarget(int $xTarget) : Link
Parameters
$xTarget : int
Return values
Link

setYTarget()

Set the Y target

public setYTarget(int $yTarget) : Link
Parameters
$yTarget : int
Return values
Link

setZTarget()

Set the Z (zoom) target

public setZTarget(int $zTarget) : Link
Parameters
$zTarget : int
Return values
Link

        
On this page

Search results