HideAction
extends Action
in package
Hide action (/S /Hide) — ISO 32000-2 §12.6.4.10.
Sets the Hidden flag on one or more annotations or form fields.
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_2
Table of Contents
Constants
- PDF_TYPE = 'Action'
Properties
- $generationNumber : int
- $h : bool
- $next : PdfReference|null
- $objectNumber : int
- $t : PdfString|PdfArray|PdfReference
- /T — a single target or an array of targets.
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
$h
public
bool
$h
= true
$next
public
PdfReference|null
$next
= null
$objectNumber
public
int
$objectNumber
= 0
$t
/T — a single target or an array of targets.
public
PdfString|PdfArray|PdfReference
$t
Methods
__construct()
public
__construct(PdfString|PdfArray|PdfReference $t[, bool $hide = true ]) : mixed
Parameters
- $t : PdfString|PdfArray|PdfReference
- $hide : bool = true
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