Link
extends AbstractAnnotation
in package
Pdf page link annotation class
Tags
Table of Contents
- $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
- 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
- __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
- 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
$borderWidth
Border width
protected
int
$borderWidth
= 0
$dashGap
Border dash gap
protected
int
$dashGap
= 0
$dashLength
Border dash length
protected
int
$dashLength
= 0
$height
Annotation height
protected
int
$height
= 0
$hRadius
Horizontal border radius
protected
int
$hRadius
= 0
$pageTarget
Internal page object index target to link to
protected
int
$pageTarget
= null
$vRadius
Vertical border radius
protected
int
$vRadius
= 0
$width
Annotation width
protected
int
$width
= 0
$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
Return values
mixed —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 —getHeight()
Get the height
public
getHeight() : int
Return values
int —getHRadius()
Get the horizontal border radius
public
getHRadius() : int
Return values
int —getPageTarget()
Get the page target
public
getPageTarget() : int
Return values
int —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 —getWidth()
Get the width
public
getWidth() : 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 —setBorderWidth()
Set the border width
public
setBorderWidth(int $width) : AbstractAnnotation
Parameters
- $width : int
Return values
AbstractAnnotation —setDashGap()
Set the border dash gap
public
setDashGap(int $gap) : AbstractAnnotation
Parameters
- $gap : int
Return values
AbstractAnnotation —setDashLength()
Set the border dash length
public
setDashLength(int $length) : AbstractAnnotation
Parameters
- $length : int
Return values
AbstractAnnotation —setHeight()
Set the height
public
setHeight(int $height) : AbstractAnnotation
Parameters
- $height : int
Return values
AbstractAnnotation —setHRadius()
Set the horizontal border radius
public
setHRadius(int $radius) : AbstractAnnotation
Parameters
- $radius : int
Return values
AbstractAnnotation —setPageTarget()
Set the page target
public
setPageTarget(int $pageTarget) : Link
Parameters
- $pageTarget : int
Return values
Link —setVRadius()
Set the vertical border radius
public
setVRadius(int $radius) : AbstractAnnotation
Parameters
- $radius : int
Return values
AbstractAnnotation —setWidth()
Set the width
public
setWidth(int $width) : AbstractAnnotation
Parameters
- $width : int
Return values
AbstractAnnotation —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