setasign\SetaPDF2\Core\Document\Page

AdditionalActions Class representing a pages additional-actions dictionary

File: /SetaPDF v2/Core/Document/Page/AdditionalActions.php
Old class name (alias): \SetaPDF_Core_Document_Page_AdditionalActions

Class hierarchy

Summary

Properties

$_page


Methods

__construct()

_getAction()

Get the action.

Parameters
$name : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_setAction()

protected AdditionalActions::_setAction (
string $name,
?\setasign\SetaPDF2\Core\Document\Action\Action $action = null
): void

Set the action.

Parameters
$name : string
 
$action : ?\setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public AdditionalActions::cleanUp (
void
): void

Release memory/cycled references.

getClose()

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

Exceptions

Throws \setasign\SetaPDF2\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 \setasign\SetaPDF2\Core\Type\Exception

setClose()

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

Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setOpen()

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

Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception