phpdftk API Documentation

MarkupAnnotation extends Annotation
in package

AbstractYes

Shared base for markup annotations — ISO 32000-2 §12.5.6.2, Table 170.

Markup annotations are the subset of annotations that represent user-authored commentary on the document (Text, FreeText, Line, Square, Circle, Polygon, PolyLine, Highlight, Underline, Squiggly, StrikeOut, Stamp, Caret, Ink, FileAttachment, Sound, Redact). They share a set of fields beyond the base annotation dictionary for authoring metadata, threaded replies, popup windows, and rich content.

Non-markup annotations (Link, Popup, Widget, Screen, PrinterMark, TrapNet, Watermark, 3D, Projection, RichMedia, Movie) keep extending Annotation directly.

Attributes
#[RequiresPdfVersion]
\Phpdftk\Pdf\Core\PdfVersion::V1_4

Table of Contents

Constants

PDF_TYPE  = 'Annot'

Properties

$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
$creationDate  : PdfString|null
$exData  : PdfDictionary|null
$f  : int
$generationNumber  : int
$irt  : PdfReference|null
$it  : PdfName|null
$lang  : PdfString|null
$m  : PdfString|null
$markupCa  : float|null
$nm  : PdfString|null
$objectNumber  : int
$oc  : PdfReference|null
$p  : PdfReference|null
$popup  : PdfReference|null
$rc  : PdfString|null
$rect  : PdfArray
$rt  : PdfName|null
$structParent  : int|null
$subj  : PdfString|null
$t  : PdfString|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

$generationNumber

public int $generationNumber = 0

$structParent

public int|null $structParent = null

Methods

getSubtype()

Returns the /Subtype value for this annotation.

public abstract 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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results