SetaPDF_Core_Document_Page_AdditionalActions Class representing a pages additional-actions dictionary

File: /SetaPDF v2/Core/Document/Page/AdditionalActions.php

Class hierarchy

Summary

Properties


Methods

__construct()

_getAction()

Get the action.

Parameters
$name : string
 
Exceptions

Throws SetaPDF_Core_Type_Exception

_setAction()

protected SetaPDF_Core_Document_Page_AdditionalActions::_setAction (
string $name [, SetaPDF_Core_Document_Action $action = null ]
): void

Set the action.

Parameters
$name : string
 
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

cleanUp()

Release memory/cycled references.

getClose()

Get the action that shall be performed when the page is closed.

Exceptions

Throws SetaPDF_Core_Type_Exception

getDictionary()

Get the additional actions dictionary.

Parameters
$create : bool

Pass true to automatically create the dictionary

getOpen()

Get the action that shall be performed when the page is opened.

Exceptions

Throws SetaPDF_Core_Type_Exception

setClose()

Set the action that shall be performed when the page is closed.

Parameters
$action : SetaPDF_Core_Document_Action
 
Return Values

Returns the SetaPDF_Core_Document_Page_AdditionalActions object for method chaining.

Exceptions

Throws SetaPDF_Core_Type_Exception

setOpen()

Set the action that shall be performed when the page is opened.

Parameters
$action : SetaPDF_Core_Document_Action
 
Return Values

Returns the SetaPDF_Core_Document_Page_AdditionalActions object for method chaining.

Exceptions

Throws SetaPDF_Core_Type_Exception