ScreenAnnotation
extends Annotation
in package
Screen annotation (/Subtype /Screen).
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_5
Table of Contents
Constants
- PDF_TYPE = 'Annot'
Properties
- $a : PdfReference|null
- $aa : PdfReference|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
- $f : int
- $generationNumber : int
- $lang : PdfString|null
- $m : PdfString|null
- $mk : Serializable|null
- $nm : PdfString|null
- $objectNumber : int
- $oc : PdfReference|null
- $p : PdfReference|null
- $rect : PdfArray
- $structParent : int|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
PDF_TYPE
public
mixed
PDF_TYPE
= 'Annot'
Properties
$a
public
PdfReference|null
$a
= null
$aa
public
PdfReference|null
$aa
= null
$af
public
PdfArray|null
$af
= null
$ap
public
PdfDictionary|AppearanceDict|null
$ap
= null
$as
public
PdfName|null
$as
= null
$bm
public
PdfName|null
$bm
= null
$border
public
PdfArray|null
$border
= null
$bs
public
Serializable|null
$bs
= null
$c
public
PdfArray|null
$c
= null
$ca
public
PdfNumber|null
$ca
= null
$contents
public
PdfString|null
$contents
= null
$f
public
int
$f
= 0
$generationNumber
public
int
$generationNumber
= 0
$lang
public
PdfString|null
$lang
= null
$m
public
PdfString|null
$m
= null
$mk
public
Serializable|null
$mk
= null
$nm
public
PdfString|null
$nm
= null
$objectNumber
public
int
$objectNumber
= 0
$oc
public
PdfReference|null
$oc
= null
$p
public
PdfReference|null
$p
= null
$rect
public
PdfArray
$rect
$structParent
public
int|null
$structParent
= null
$t
public
PdfString|null
$t
= null
Methods
__construct()
public
__construct(PdfArray $rect) : mixed
Parameters
- $rect : PdfArray
getSubtype()
Returns the /Subtype value for this annotation.
public
getSubtype() : string
Return values
stringtoIndirectObject()
Wrap the object in an indirect object structure: X Y obj ... endobj
public
toIndirectObject() : string
Return values
stringtoPdf()
Serialize the object's dictionary/value to PDF syntax.
public
toPdf() : string
Return values
stringbuildDictionary()
Build the common annotation dictionary entries.
protected
buildDictionary() : PdfDictionary
Subclasses call this and add their own entries.