RenditionAction
extends Action
in package
Rendition action (/S /Rendition) — ISO 32000-2 §13.2.2.
Controls playback of media renditions.
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_5
Table of Contents
Constants
- PDF_TYPE = 'Action'
Properties
- $an : PdfReference|null
- $generationNumber : int
- $js : PdfString|null
- $next : PdfReference|null
- $objectNumber : int
- $op : int|null
- $r : PdfReference|null
Methods
- getActionType() : string
- Returns the /S (action type) value for this action.
- 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.
- baseDictionary() : PdfDictionary
- Build a dictionary pre-populated with the common /Type, /S, and /Next entries so subclasses only need to add their subtype-specific fields.
Constants
PDF_TYPE
public
mixed
PDF_TYPE
= 'Action'
Properties
$an
public
PdfReference|null
$an
= null
$generationNumber
public
int
$generationNumber
= 0
$js
public
PdfString|null
$js
= null
$next
public
PdfReference|null
$next
= null
$objectNumber
public
int
$objectNumber
= 0
$op
public
int|null
$op
= null
$r
public
PdfReference|null
$r
= null
Methods
getActionType()
Returns the /S (action type) value for this action.
public
getActionType() : 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
stringbaseDictionary()
Build a dictionary pre-populated with the common /Type, /S, and /Next entries so subclasses only need to add their subtype-specific fields.
protected
baseDictionary() : PdfDictionary