Documentation

AbstractAnnotation
in package
implements AnnotationInterface

AbstractYes

Pdf abstract page annotation class

Tags
category

Pop

author

Nick Sagona, III nick@popphp.org

copyright

Copyright (c) 2009-2026 Nick Sagona, III

license

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

version
6.0.0

Table of Contents

Interfaces

AnnotationInterface
Pdf page annotation interface

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
$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
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
setVRadius()  : AbstractAnnotation
Set the vertical border radius
setWidth()  : AbstractAnnotation
Set the width

Properties

$dashLength

Border dash length $var int|float

protected int|float $dashLength = 0

$hRadius

Horizontal border radius $var int|float

protected int|float $hRadius = 0

Methods

__construct()

Constructor

public __construct(int|float $width, int|float $height) : mixed

Instantiate a PDF annotation object.

Parameters
$width : int|float
$height : int|float

getBorderWidth()

Get the border width

public getBorderWidth() : int|float
Return values
int|float

getDashGap()

Get the border dash gap

public getDashGap() : int|float
Return values
int|float

getDashLength()

Get the border dash length

public getDashLength() : int|float
Return values
int|float

getHeight()

Get the height

public getHeight() : int|float
Return values
int|float

getHRadius()

Get the horizontal border radius

public getHRadius() : int|float
Return values
int|float

getVRadius()

Get the vertical border radius

public getVRadius() : int|float
Return values
int|float

        
On this page

Search results