SetOCGStateAction
extends Action
in package
Set-OCG-state action (/S /SetOCGState) — ISO 32000-2 §12.6.4.12.
Toggles visibility of optional content groups.
The /State array is a sequence of name + OCG reference pairs, e.g.: [/OFF 12 0 R 13 0 R /ON 14 0 R]
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_5
Table of Contents
Constants
- PDF_TYPE = 'Action'
Properties
- $generationNumber : int
- $next : PdfReference|null
- $objectNumber : int
- $preserveRB : bool|null
- $state : PdfArray
Methods
- __construct() : mixed
- 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
$generationNumber
public
int
$generationNumber
= 0
$next
public
PdfReference|null
$next
= null
$objectNumber
public
int
$objectNumber
= 0
$preserveRB
public
bool|null
$preserveRB
= null
$state
public
PdfArray
$state
Methods
__construct()
public
__construct(PdfArray $state) : mixed
Parameters
- $state : PdfArray
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