Class SetaPDF_Core_Document_Action_GoTo in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. Document
  2. Document
    1. Action
    2. Action

SetaPDF_Core_Document_Action_GoTo Class representing a Go-To action

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

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

Class hierarchy

SetaPDF_Core_Document_Action
- SetaPDF_Core_Document_Action_GoTo

Summary

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_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 SetaPDF_Core_Type_Exception

Throws InvalidArgumentException

createActionDictionary()

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

addNext()

public SetaPDF_Core_Document_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 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_GoTo::getDestination (

[ SetaPDF_Core_Document $document = null ]

): boolean|SetaPDF_Core_Document_Destination

Get the destination object.

Parameters

$document : SetaPDF_Core_Document

Exceptions

Throws BadMethodCallException

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

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_GoTo::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 SetaPDF_Core_Document_Action::setIndirectObject (

SetaPDF_Core_Type_IndirectObjectInterface $indirectReference

): void

Set the indirect object of this annotation.

Parameters

$indirectReference : SetaPDF_Core_Type_IndirectObjectInterface

setNext()

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