Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Page
        2. Page
          1. Annotation
          2. Annotation
          3. AdditionalActions
          4. Annotations
          5. Contents

SetaPDF_Core_Document_Page_AdditionalActions Class representing a pages additional-actions dictionary

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

Class hierarchy

Summary

Methods

Properties

Properties

$_page

protected SetaPDF_Core_Document_Page SetaPDF_Core_Document_Page_AdditionalActions::$_page

The catalog instance


Methods

__construct()

public SetaPDF_Core_Document_Page_AdditionalActions::__construct ()

The constructor.

Parameters
$page : SetaPDF_Core_Document_Page
 

_getAction()

protected SetaPDF_Core_Document_Page_AdditionalActions::_getAction (
string $name
): null|SetaPDF_Core_Document_Action

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()

public SetaPDF_Core_Document_Page_AdditionalActions::cleanUp (
void
): void

Release memory/cycled references.

getClose()

public SetaPDF_Core_Document_Page_AdditionalActions::getClose (
void
): null|SetaPDF_Core_Document_Action

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

Exceptions

Throws SetaPDF_Core_Type_Exception

getDictionary()

public SetaPDF_Core_Document_Page_AdditionalActions::getDictionary (
[ bool $create = false ]
): null|SetaPDF_Core_Type_AbstractType|SetaPDF_Core_Type_Dictionary

Get the additional actions dictionary.

Parameters
$create : bool

Pass true to automatically create the dictionary

getOpen()

public SetaPDF_Core_Document_Page_AdditionalActions::getOpen (
void
): null|SetaPDF_Core_Document_Action

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

Exceptions

Throws SetaPDF_Core_Type_Exception

setClose()

public SetaPDF_Core_Document_Page_AdditionalActions::setClose (): SetaPDF_Core_Document_Page_AdditionalActions

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()

public SetaPDF_Core_Document_Page_AdditionalActions::setOpen (): SetaPDF_Core_Document_Page_AdditionalActions

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


© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)