SetaPDF_Core_Document_Action Class representing a PDF action
File: /SetaPDF v2/Core/Document/Action.php
See PDF 32000-1:2008 - 12.6
Class hierarchy
- SetaPDF_Core_Document_Action
Summary
Properties
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_ActionCreates 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
Methods
__construct()
public SetaPDF_Core_Document_Action::__construct (
SetaPDF_Core_Type_AbstractType $objectOrDictionary
)The constructor.
Parameters
- $objectOrDictionary : SetaPDF_Core_Type_AbstractType
Exceptions
Throws InvalidArgumentException
Throws SetaPDF_Core_Type_Exception
addNext()
Add an additional action to the next value of this action.
Parameters
Exceptions
Throws SetaPDF_Core_Type_Exception
getIndirectObject()
public SetaPDF_Core_Document_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 SetaPDF_Core_Document_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 SetaPDF_Core_Document_Action::setIndirectObject (
SetaPDF_Core_Type_IndirectObjectInterface $indirectReference
): voidSet 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
): voidSet the next action which should be executed after this one.