Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Action
        2. Action
          1. Form
          2. GoTo
          3. GoToR
          4. ImportData
          5. JavaScript
          6. Launch
          7. Named
          8. ResetForm
          9. SubmitForm
          10. Uri

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

Static Methods

Methods

Properties

Properties

$_actionDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Action::$_actionDictionary

The action dictionary

$_indirectReference

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_Action::$_indirectReference

Static Methods

byObjectOrDictionary()

public static SetaPDF_Core_Document_Action::byObjectOrDictionary (): 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 SetaPDF_Core_Type_Exception

Throws InvalidArgumentException

createActionDictionary()

public static SetaPDF_Core_Document_Action_GoToR::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 SetaPDF_Core_Type_Exception


Methods

__construct()

public SetaPDF_Core_Document_Action_GoToR::__construct ()

The constructor.

Parameters
$objectOrDictionary : string|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception

addNext()

public SetaPDF_Core_Document_Action::addNext (): void

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

Parameters
$next : SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

getActionDictionary()

public SetaPDF_Core_Document_Action::getActionDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the action dictionary.

getDestination()

public SetaPDF_Core_Document_Action_GoToR::getDestination (
[ SetaPDF_Core_Document $document = null ]
): boolean|SetaPDF_Core_Document_Destination

Get the destination object.

Parameters
$document : SetaPDF_Core_Document
 
Exceptions

Throws BadMethodCallException

getFile()

public SetaPDF_Core_Document_Action_GoToR::getFile (
void
): bool|SetaPDF_Core_FileSpecification

Get the file in which the destination shall be located.

Exceptions

Throws SetaPDF_Core_Type_Exception

getIndirectObject()

public SetaPDF_Core_Document_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 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".

Exceptions

Throws SetaPDF_Core_Type_Exception

getNext()

public SetaPDF_Core_Document_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 SetaPDF_Core_Document_Action::getPdfValue (
void
): SetaPDF_Core_Type_Dictionary

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.

setDestination()

public SetaPDF_Core_Document_Action_GoToR::setDestination (): 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 SetaPDF_Core_Document_Action_GoToR::setFile (): void

Set the file in which the destination shall be located.

Parameters
$file : SetaPDF_Core_FileSpecification|string
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setIndirectObject()

public SetaPDF_Core_Document_Action::setIndirectObject (): void

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

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

setNext()

public SetaPDF_Core_Document_Action::setNext (): 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
 

© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)