setasign\SetaPDF2\Core\Document\Action
Action Class representing a PDF action
File: /SetaPDF v2/Core/Document/Action/Action.php
Old class name (alias):
\SetaPDF_Core_Document_Action
See PDF 32000-1:2008 - 12.6
Class hierarchy
Summary
Properties
Static Methods
byObjectOrDictionary()
public static Action::byObjectOrDictionary (
\SetaPDF_Core_Type_IndirectObject|\SetaPDF_Core_Type_IndirectReference|\SetaPDF_Core_Type_Dictionary $objectOrDictionary
): \SetaPDF_Core_Document_ActionCreates 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
Methods
__construct()
The constructor.
Parameters
- $objectOrDictionary : \SetaPDF_Core_Type_AbstractType
Exceptions
Throws \InvalidArgumentException
getIndirectObject()
public Action::getIndirectObject (
?\SetaPDF_Core_Document $document = null
): \SetaPDF_Core_Type_IndirectObjectInterfaceGet 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_IndirectReferenceGets the PDF value of the next entry.
setIndirectObject()
public Action::setIndirectObject (
\SetaPDF_Core_Type_IndirectObjectInterface $indirectReference
): voidSet 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
): voidSet the next action which should be executed after this one.