Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Catalog
        2. Catalog
          1. Names
          2. Names
          3. AcroForm
          4. AdditionalActions
          5. Dests
          6. Extensions
          7. MarkInfo
          8. OptionalContent
          9. Outlines
          10. OutputIntents
          11. PageLabels
          12. Pages
          13. Permissions
          14. StructTreeRoot
          15. ViewerPreferences

SetaPDF_Core_Document_Catalog_AdditionalActions Class representing the document catalog’s additional-actions dictionary

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

Class hierarchy

Summary

Methods

Properties

Properties

$_catalog

protected SetaPDF_Core_Document_Catalog SetaPDF_Core_Document_Catalog_AdditionalActions::$_catalog

The catalog instance


Methods

__construct()

public SetaPDF_Core_Document_Catalog_AdditionalActions::__construct ()

The constructor.

Parameters
$catalog : SetaPDF_Core_Document_Catalog
 

_getAction()

protected SetaPDF_Core_Document_Catalog_AdditionalActions::_getAction (
string $name [, boolean $instance = true ]
): null|SetaPDF_Core_Document_Action_JavaScript

Get the action.

Parameters
$name : string
 
$instance : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

_setAction()

protected SetaPDF_Core_Document_Catalog_AdditionalActions::_setAction (): void

Set the action.

Parameters
$name : string
 
$javaScriptAction : string|SetaPDF_Core_Document_Action_JavaScript|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

cleanUp()

public SetaPDF_Core_Document_Catalog_AdditionalActions::cleanUp (
void
): void

Release memory/cycled references.

getDictionary()

public SetaPDF_Core_Document_Catalog_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

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDidPrint()

public SetaPDF_Core_Document_Catalog_AdditionalActions::getDidPrint (
void
): null|SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed after printing the document.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDidSave()

public SetaPDF_Core_Document_Catalog_AdditionalActions::getDidSave (
void
): null|SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed after saving the document.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDocument()

public SetaPDF_Core_Document_Catalog_AdditionalActions::getDocument (
void
): SetaPDF_Core_Document

Get the document instance.

getWillClose()

public SetaPDF_Core_Document_Catalog_AdditionalActions::getWillClose (
void
): null|SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed before closing the document.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getWillPrint()

public SetaPDF_Core_Document_Catalog_AdditionalActions::getWillPrint (
void
): null|SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed before printing the document.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getWillSave()

public SetaPDF_Core_Document_Catalog_AdditionalActions::getWillSave (
void
): null|SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed before saving the document.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setDidPrint()

public SetaPDF_Core_Document_Catalog_AdditionalActions::setDidPrint (): SetaPDF_Core_Document_Catalog_AdditionalActions

Set the JavaScript action that shall be performed after printing the document.

Parameters
$javaScriptAction : string|SetaPDF_Core_Document_Action_JavaScript|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Return Values

Returns the SetaPDF_Core_Document_Catalog_AdditionalActions object for method chaining.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setDidSave()

public SetaPDF_Core_Document_Catalog_AdditionalActions::setDidSave (): SetaPDF_Core_Document_Catalog_AdditionalActions

Set the JavaScript action that shall be performed after saving the document.

Parameters
$javaScriptAction : string|SetaPDF_Core_Document_Action_JavaScript|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Return Values

Returns the SetaPDF_Core_Document_Catalog_AdditionalActions object for method chaining.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setWillClose()

public SetaPDF_Core_Document_Catalog_AdditionalActions::setWillClose (): SetaPDF_Core_Document_Catalog_AdditionalActions

Set the JavaScript action that shall be performed before closing the document.

Parameters
$javaScriptAction : string|SetaPDF_Core_Document_Action_JavaScript|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Return Values

Returns the SetaPDF_Core_Document_Catalog_AdditionalActions object for method chaining.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setWillPrint()

public SetaPDF_Core_Document_Catalog_AdditionalActions::setWillPrint (): SetaPDF_Core_Document_Catalog_AdditionalActions

Set the JavaScript action that shall be performed before printing the document.

Parameters
$javaScriptAction : string|SetaPDF_Core_Document_Action_JavaScript|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Return Values

Returns the SetaPDF_Core_Document_Catalog_AdditionalActions object for method chaining.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setWillSave()

public SetaPDF_Core_Document_Catalog_AdditionalActions::setWillSave (): SetaPDF_Core_Document_Catalog_AdditionalActions

Set the JavaScript action that shall be performed before saving the document.

Parameters
$javaScriptAction : string|SetaPDF_Core_Document_Action_JavaScript|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
 
Return Values

Returns the SetaPDF_Core_Document_Catalog_AdditionalActions object for method chaining.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception


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