phpdftk API Documentation

LinkAnnotation extends Annotation
in package

Link annotation (/Subtype /Link).

Table of Contents

Constants

PDF_TYPE  = 'Annot'

Properties

$a  : PdfDictionary|null
$af  : PdfArray|null
$ap  : PdfDictionary|AppearanceDict|null
$as  : PdfName|null
$bm  : PdfName|null
$border  : PdfArray|null
$bs  : Serializable|null
$c  : PdfArray|null
$ca  : PdfNumber|null
$contents  : PdfString|null
$dest  : Serializable|null
/Dest — destination for this link. Accepts PdfReference (for named-tree references), Destination (inline explicit destination — ISO 32000-2 Table 148), PdfArray (raw inline destination), or PdfString (legacy named destination).
$f  : int
$generationNumber  : int
$h  : PdfName|null
$lang  : PdfString|null
$m  : PdfString|null
$nm  : PdfString|null
$objectNumber  : int
$oc  : PdfReference|null
$p  : PdfReference|null
$pa  : PdfDictionary|null
$quadPoints  : PdfArray|null
$rect  : PdfArray
$structParent  : int|null

Methods

__construct()  : mixed
getSubtype()  : string
Returns the /Subtype value for this annotation.
toIndirectObject()  : string
Wrap the object in an indirect object structure: X Y obj ... endobj
toPdf()  : string
Serialize the object's dictionary/value to PDF syntax.
buildDictionary()  : PdfDictionary
Build the common annotation dictionary entries.

Constants

Properties

$dest

/Dest — destination for this link. Accepts PdfReference (for named-tree references), Destination (inline explicit destination — ISO 32000-2 Table 148), PdfArray (raw inline destination), or PdfString (legacy named destination).

public Serializable|null $dest = null

$generationNumber

public int $generationNumber = 0

$structParent

public int|null $structParent = null

Methods

getSubtype()

Returns the /Subtype value for this annotation.

public getSubtype() : string
Return values
string

toIndirectObject()

Wrap the object in an indirect object structure: X Y obj ... endobj

public toIndirectObject() : string
Return values
string

toPdf()

Serialize the object's dictionary/value to PDF syntax.

public toPdf() : string
Return values
string

buildDictionary()

Build the common annotation dictionary entries.

protected buildDictionary() : PdfDictionary

Subclasses call this and add their own entries.

Return values
PdfDictionary

        
On this page

Search results