SetaPDF_Core_Document_Action_GoToR Class representing a remote go-to action.

File: /SetaPDF v2/Core/Document/Action/GoToR.php

Go to a destination in another PDF file instead of the current file. See PDF 32000-1:2008 - 12.6.4.3

Class hierarchy

Summary

Properties

$_actionDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Action_GoToR::$_actionDictionary

The action dictionary

$_indirectReference

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_Action_GoToR::$_indirectReference


Static Methods

byObjectOrDictionary()

Creates an action object by an action dictionary.

Parameters
$objectOrDictionary : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws InvalidArgumentException

createActionDictionary()

Create a remote go-to Action dictionary.

Parameters
$destination : string|SetaPDF_Core_Type_Array|SetaPDF_Core_Type_Name|SetaPDF_Core_Type_String
 
$file : string|SetaPDF_Core_FileSpecification|SetaPDF_Core_Type_Dictionary

The path to the file, a file specification or a dictionary representing a file specification.

Exceptions

Throws InvalidArgumentException


Methods

__construct()

The constructor.

Parameters
$objectOrDictionary : bool|int|float|string|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws InvalidArgumentException

addNext()

Add an additional action to the next value of this action.

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action
 

getActionDictionary()

getDestination()

Get the destination object.

Parameters
$document : SetaPDF_Core_Document
 
Exceptions

Throws BadMethodCallException

getFile()

Get the file in which the destination shall be located.

getIndirectObject()

Get the indirect object of this annotation or creates it in the specific document context.

Parameters
$document : SetaPDF_Core_Document

The document instance

getNewWindow()

public SetaPDF_Core_Document_Action_GoToR::getNewWindow (
void
): boolean|null

Get the flag specifying whether to open the destination document in a new window.

Return Values

A boolean value if specified. Otherwise "null".

getNext()

Gets the PDF value of the next entry.

getPdfValue()

Get the PDF value of this action.

getType()

public SetaPDF_Core_Document_Action::getType (
void
): string

Get the action type specified in the S key.

setFile()

Set the file in which the destination shall be located.

Parameters
$file : SetaPDF_Core_FileSpecification|string
 

setIndirectObject()

Set the indirect object of this annotation.

Parameters
$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface
 

setNewWindow()

public SetaPDF_Core_Document_Action_GoToR::setNewWindow (
boolean|null $newWindow
): void

Set the flag specifying whether to open the destination document in a new window.

Parameters
$newWindow : boolean|null

Wether to open the destination in a new window or not. To use the reader preferences remove this flag by passing "null".

setNext()

Set the next action which should be executed after this one.

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action