SetaPDF_Core_Document_Page_AdditionalActions Class representing a pages additional-actions dictionary

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

Class hierarchy

Summary

Properties


Methods

__construct()

public SetaPDF_Core_Document_Page_AdditionalActions::__construct ( SetaPDF_Core_Document_Page $page )

The constructor.

Parameters
$page : SetaPDF_Core_Document_Page
 

_getAction()

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

Get the action.

Parameters
$name : string
 

_setAction()

protected void SetaPDF_Core_Document_Page_AdditionalActions::_setAction ( string $name, SetaPDF_Core_Document_Action $action )

Set the action.

Parameters
$name : string
 
$action : SetaPDF_Core_Document_Action
 

cleanUp()

public void SetaPDF_Core_Document_Page_AdditionalActions::cleanUp ( void )

Release memory/cycled references.

getClose()

public null|SetaPDF_Core_Document_Action SetaPDF_Core_Document_Page_AdditionalActions::getClose ( void )

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

getDictionary()

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

Get the additional actions dictionary.

Parameters
$create : bool

Pass true to automatically create the dictionary

getOpen()

public null|SetaPDF_Core_Document_Action SetaPDF_Core_Document_Page_AdditionalActions::getOpen ( void )

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

setClose()

public SetaPDF_Core_Document_Page_AdditionalActions SetaPDF_Core_Document_Page_AdditionalActions::setClose ( SetaPDF_Core_Document_Action $action )

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.

setOpen()

public SetaPDF_Core_Document_Page_AdditionalActions SetaPDF_Core_Document_Page_AdditionalActions::setOpen ( SetaPDF_Core_Document_Action $action )

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.