GoToRAction
extends Action
in package
GoToR action (/S /GoToR).
Navigates to a destination in a remote (different) PDF file. The destination (/D) and file (/F) are both required.
Example: $action = new GoToRAction( new PdfString('/path/to/other.pdf'), new PdfName('Chapter1') ); $action->newWindow = true;
Table of Contents
Constants
- PDF_TYPE = 'Action'
Properties
- $dest : mixed
- $f : PdfString
- $generationNumber : int
- $newWindow : bool|null
- $next : PdfReference|null
- $objectNumber : int
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
$dest
public
mixed
$dest
$f
public
PdfString
$f
$generationNumber
public
int
$generationNumber
= 0
$newWindow
public
bool|null
$newWindow
= null
$next
public
PdfReference|null
$next
= null
$objectNumber
public
int
$objectNumber
= 0
Methods
__construct()
public
__construct(PdfString $f, mixed $dest) : mixed
Parameters
- $f : PdfString
- $dest : mixed
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