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
Summary
Properties
Static Methods
byObjectOrDictionary()
Creates an action object by an action dictionary.
Parameters
- $objectOrDictionary : \setasign\SetaPDF2\Core\Type\PdfIndirectObject|\setasign\SetaPDF2\Core\Type\PdfIndirectReference|\setasign\SetaPDF2\Core\Type\PdfDictionary
Exceptions
Throws \setasign\SetaPDF2\Core\Type\Exception
Throws \InvalidArgumentException
createActionDictionary()
Create a Go-To Action dictionary.
Parameters
- $destination : string|\setasign\SetaPDF2\Core\Type\PdfArray|\setasign\SetaPDF2\Core\Document\Destination
Exceptions
Throws \InvalidArgumentException
Methods
__construct()
The constructor.
Parameters
- $objectOrDictionary : string|\setasign\SetaPDF2\Core\Type\PdfName|\setasign\SetaPDF2\Core\Type\PdfString|\setasign\SetaPDF2\Core\Type\PdfDictionary|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface|\setasign\SetaPDF2\Core\Document\Destination
Exceptions
Throws \InvalidArgumentException
getDestination()
Get the destination object.
Parameters
- $document : ?\setasign\SetaPDF2\Core\Document
Exceptions
Throws \BadMethodCallException
getIndirectObject()
Get the indirect object of this annotation or creates it in the specific document context.
Parameters
- $document : ?\setasign\SetaPDF2\Core\Document
The document instance
getNext()
Gets the PDF value of the next entry.
setDestination()
Set the destination.
Parameters
- $destination : string|\setasign\SetaPDF2\Core\Type\PdfArray|\setasign\SetaPDF2\Core\Type\PdfName|\setasign\SetaPDF2\Core\Type\PdfString|\setasign\SetaPDF2\Core\Document\Destination
Exceptions
Throws \InvalidArgumentException
setIndirectObject()
Set the indirect object of this annotation.
Parameters
- $indirectReference : \setasign\SetaPDF2\Core\Type\IndirectObjectInterface
setNext()
Set the next action which should be executed after this one.