Class GoToRAction in namespace setasign\SetaPDF2\Core\Document\Action in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Document
  2. Document
    1. Action

setasign\SetaPDF2\Core\Document\Action

GoToRAction Class representing a remote go-to action.

File: /SetaPDF v2/Core/Document/Action/GoToRAction.php
Old class name (alias): \SetaPDF_Core_Document_Action_GoToR

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

Class hierarchy

Action
- GoToRAction

Summary

Properties

$_actionDictionary

protected \SetaPDF_Core_Type_Dictionary Action::$_actionDictionary

The action dictionary

$_indirectReference

protected \SetaPDF_Core_Type_IndirectObjectInterface Action::$_indirectReference

Static Methods

byObjectOrDictionary()

public static Action::byObjectOrDictionary (

\SetaPDF_Core_Type_IndirectObject|\SetaPDF_Core_Type_IndirectReference|\SetaPDF_Core_Type_Dictionary $objectOrDictionary

): \SetaPDF_Core_Document_Action

Creates an action object by an action dictionary.

Parameters

$objectOrDictionary : \SetaPDF_Core_Type_IndirectObject|\SetaPDF_Core_Type_IndirectReference|\SetaPDF_Core_Type_Dictionary

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \InvalidArgumentException

createActionDictionary()

public static GoToRAction::createActionDictionary (

): \SetaPDF_Core_Type_Dictionary

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

Throws \setasign\SetaPDF2\Core\Type\Exception

Methods

__construct()

public GoToRAction::__construct (

string|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface $objectOrDictionary

)

The constructor.

Parameters

$objectOrDictionary : string|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

Throws \InvalidArgumentException

Throws \setasign\SetaPDF2\Core\Type\Exception

addNext()

public Action::addNext (

\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Document_Action $next

): void

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

Parameters

$next : \SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Document_Action

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getActionDictionary()

public Action::getActionDictionary (

void

): \SetaPDF_Core_Type_Dictionary

Get the action dictionary.

getDestination()

public GoToRAction::getDestination (

?\SetaPDF_Core_Document $document = null

): bool|\SetaPDF_Core_Document_Destination

Get the destination object.

Parameters

$document : ?\SetaPDF_Core_Document

Exceptions

Throws \BadMethodCallException

getFile()

public GoToRAction::getFile (

void

): bool|\SetaPDF_Core_FileSpecification

Get the file in which the destination shall be located.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getIndirectObject()

public Action::getIndirectObject (

?\SetaPDF_Core_Document $document = null

): \SetaPDF_Core_Type_IndirectObjectInterface

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 GoToRAction::getNewWindow (

void

): ?bool

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

Return Values

A boolean value if specified. Otherwise "null".

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getNext()

public Action::getNext (

void

): false|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_Array|\SetaPDF_Core_Type_IndirectReference

Gets the PDF value of the next entry.

getPdfValue()

public Action::getPdfValue (

void

): \SetaPDF_Core_Type_Dictionary

Get the PDF value of this action.

getType()

public Action::getType (

void

): string

Get the action type specified in the S key.

setDestination()

public GoToRAction::setDestination (

string|\SetaPDF_Core_Type_Array|\SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_String|\SetaPDF_Core_Document_Destination $destination

): void

Set the destination.

Parameters

$destination : string|\SetaPDF_Core_Type_Array|\SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_String|\SetaPDF_Core_Document_Destination

Exceptions

Throws \InvalidArgumentException

setFile()

public GoToRAction::setFile (

\SetaPDF_Core_FileSpecification|string $file

): void

Set the file in which the destination shall be located.

Parameters

$file : \SetaPDF_Core_FileSpecification|string

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setIndirectObject()

public Action::setIndirectObject (

\SetaPDF_Core_Type_IndirectObjectInterface $indirectReference

): void

Set the indirect object of this annotation.

Parameters

$indirectReference : \SetaPDF_Core_Type_IndirectObjectInterface

setNewWindow()

public GoToRAction::setNewWindow (

?bool $newWindow

): void

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

Parameters

$newWindow : ?bool: Whether to open the destination in a new window or not. To use the reader preferences remove this flag by passing "null".

setNext()

public Action::setNext (

\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Document_Action|\SetaPDF_Core_Type_IndirectObjectInterface $next

): void

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

Parameters

$next : \SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Document_Action|\SetaPDF_Core_Type_IndirectObjectInterface