Class GoToAction 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

GoToAction Class representing a Go-To action

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

Go to a destination in the current document. See PDF 32000-1:2008 - 12.6.4.2

Class hierarchy

Action
- GoToAction

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 GoToAction::createActionDictionary (

string|\SetaPDF_Core_Type_Array|\SetaPDF_Core_Document_Destination $destination

): \SetaPDF_Core_Type_Dictionary

Create a Go-To Action dictionary.

Parameters

$destination : string|\SetaPDF_Core_Type_Array|\SetaPDF_Core_Document_Destination

Exceptions

Throws \InvalidArgumentException

Methods

__construct()

public GoToAction::__construct (

)

The constructor.

Parameters

$objectOrDictionary : string|\SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_String|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface|\SetaPDF_Core_Document_Destination

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 GoToAction::getDestination (

?\SetaPDF_Core_Document $document = null

): bool|\SetaPDF_Core_Document_Destination

Get the destination object.

Parameters

$document : ?\SetaPDF_Core_Document

Exceptions

Throws \BadMethodCallException

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

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 GoToAction::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

setIndirectObject()

public Action::setIndirectObject (

\SetaPDF_Core_Type_IndirectObjectInterface $indirectReference

): void

Set the indirect object of this annotation.

Parameters

$indirectReference : \SetaPDF_Core_Type_IndirectObjectInterface

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