Documentation

Url extends AbstractAnnotation
in package

Pdf page url 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
$url  : string|null
External URL to link to
$vRadius  : int
Vertical border radius
$width  : int
Annotation width

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
getStream()  : string
Get the annotation stream
getUrl()  : string|null
Get the URL link
getVRadius()  : int
Get the vertical border radius
getWidth()  : int
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

$url

External URL to link to

protected string|null $url = null

Methods

__construct()

Constructor

public __construct(int $width, int $height, string $url) : mixed

Instantiate a PDF URL annotation object.

Parameters
$width : int
$height : int
$url : string

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

getStream()

Get the annotation stream

public getStream(int $i, int $x, int $y) : string
Parameters
$i : int
$x : int
$y : int
Return values
string

getUrl()

Get the URL link

public getUrl() : string|null
Return values
string|null

getVRadius()

Get the vertical border radius

public getVRadius() : int
Return values
int

setUrl()

Set the URL

public setUrl(string $url) : Url
Parameters
$url : string
Return values
Url

        
On this page

Search results