Url
extends AbstractAnnotation
in package
Pdf page url annotation class
Tags
Table of Contents
Properties
- $borderWidth : int|float
- Border width $var int|float
- $dashGap : int|float
- Border dash gap $var int|float
- $dashLength : int|float
- Border dash length $var int|float
- $height : int|float
- Annotation height $var int|float
- $hRadius : int|float
- Horizontal border radius $var int|float
- $url : string|null
- External URL to link to
- $vRadius : int|float
- Vertical border radius $var int|float
- $width : int|float
- Annotation width $var int|float
Methods
- __construct() : mixed
- Constructor
- getBorderWidth() : int|float
- Get the border width
- getDashGap() : int|float
- Get the border dash gap
- getDashLength() : int|float
- Get the border dash length
- getHeight() : int|float
- Get the height
- getHRadius() : int|float
- Get the horizontal border radius
- getStream() : string
- Get the annotation stream
- getUrl() : string|null
- Get the URL link
- getVRadius() : int|float
- Get the vertical border radius
- getWidth() : int|float
- Get the width
- 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
- setUrl() : Url
- Set the URL
- setVRadius() : AbstractAnnotation
- Set the vertical border radius
- setWidth() : AbstractAnnotation
- Set the width
Properties
$borderWidth
Border width $var int|float
protected
int|float
$borderWidth
= 0
$dashGap
Border dash gap $var int|float
protected
int|float
$dashGap
= 0
$dashLength
Border dash length $var int|float
protected
int|float
$dashLength
= 0
$height
Annotation height $var int|float
protected
int|float
$height
= 0
$hRadius
Horizontal border radius $var int|float
protected
int|float
$hRadius
= 0
$url
External URL to link to
protected
string|null
$url
= null
$vRadius
Vertical border radius $var int|float
protected
int|float
$vRadius
= 0
$width
Annotation width $var int|float
protected
int|float
$width
= 0
Methods
__construct()
Constructor
public
__construct(int|float $width, int|float $height, string $url) : mixed
Instantiate a PDF URL annotation object.
Parameters
- $width : int|float
- $height : int|float
- $url : string
getBorderWidth()
Get the border width
public
getBorderWidth() : int|float
Return values
int|floatgetDashGap()
Get the border dash gap
public
getDashGap() : int|float
Return values
int|floatgetDashLength()
Get the border dash length
public
getDashLength() : int|float
Return values
int|floatgetHeight()
Get the height
public
getHeight() : int|float
Return values
int|floatgetHRadius()
Get the horizontal border radius
public
getHRadius() : int|float
Return values
int|floatgetStream()
Get the annotation stream
public
getStream(int $i, int|float $x, int|float $y) : string
Parameters
- $i : int
- $x : int|float
- $y : int|float
Return values
stringgetUrl()
Get the URL link
public
getUrl() : string|null
Return values
string|nullgetVRadius()
Get the vertical border radius
public
getVRadius() : int|float
Return values
int|floatgetWidth()
Get the width
public
getWidth() : int|float
Return values
int|floatsetBorderWidth()
Set the border width
public
setBorderWidth(int|float $width) : AbstractAnnotation
Parameters
- $width : int|float
Return values
AbstractAnnotationsetDashGap()
Set the border dash gap
public
setDashGap(int|float $gap) : AbstractAnnotation
Parameters
- $gap : int|float
Return values
AbstractAnnotationsetDashLength()
Set the border dash length
public
setDashLength(int|float $length) : AbstractAnnotation
Parameters
- $length : int|float
Return values
AbstractAnnotationsetHeight()
Set the height
public
setHeight(int|float $height) : AbstractAnnotation
Parameters
- $height : int|float
Return values
AbstractAnnotationsetHRadius()
Set the horizontal border radius
public
setHRadius(int|float $radius) : AbstractAnnotation
Parameters
- $radius : int|float
Return values
AbstractAnnotationsetUrl()
Set the URL
public
setUrl(string $url) : Url
Parameters
- $url : string
Return values
UrlsetVRadius()
Set the vertical border radius
public
setVRadius(int|float $radius) : AbstractAnnotation
Parameters
- $radius : int|float
Return values
AbstractAnnotationsetWidth()
Set the width
public
setWidth(int|float $width) : AbstractAnnotation
Parameters
- $width : int|float