SetaPDF_Core_Document_Page_Annotation_AdditionalActions Class representing an annotations additional-actions dictionary

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

Class hierarchy

Summary

Properties


Methods

_getAction()

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

Get the action.

Parameters
$name : string
 
$instance : boolean
 
Exceptions

Throws SetaPDF_Core_Type_Exception

_setAction()

Set the action.

Parameters
$name : string
 
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

cleanUp()

Release memory/cycled references.

getCursorEnter()

Get the action that shall be performed when the cursor enters the annotation’s active area.

Exceptions

Throws SetaPDF_Core_Type_Exception

getCursorExit()

Get the action that shall be performed when the cursor exits the annotation’s active area.

Exceptions

Throws SetaPDF_Core_Type_Exception

getDictionary()

Get the additional actions dictionary.

Parameters
$create : bool

Pass true to automatically create the dictionary

getMouseDown()

Get the action that shall be performed when the mouse button is pressed inside the annotation’s active area.

Exceptions

Throws SetaPDF_Core_Type_Exception

getMouseUp()

Get the action that shall be performed when the mouse button is released inside the annotation’s active area.

Exceptions

Throws SetaPDF_Core_Type_Exception

getPageClose()

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

Exceptions

Throws SetaPDF_Core_Type_Exception

getPageInvisible()

Get the action that shall be performed when the page containing the annotation is no longer visible in the conforming reader’s user interface.

Exceptions

Throws SetaPDF_Core_Type_Exception

getPageOpen()

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

Exceptions

Throws SetaPDF_Core_Type_Exception

getPageVisible()

Get the action that shall be performed when the page containing the annotation becomes visible.

Exceptions

Throws SetaPDF_Core_Type_Exception

setCursorEnter()

Set the action that shall be performed when the cursor enters the annotation’s active area.

Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setCursorExit()

Set the action that shall be performed when the cursor exits the annotation’s active area.

Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setMouseDown()

Set the action that shall be performed when the mouse button is pressed inside the annotation’s active area.

Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setMouseUp()

Set the action that shall be performed when the mouse button is released inside the annotation’s active area.

Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setPageClose()

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

Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setPageInvisible()

Set the action that shall be performed when the page containing the annotation is no longer visible in the conforming reader’s user interface.

Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setPageOpen()

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

Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setPageVisible()

Set the action that shall be performed when the page containing the annotation becomes visible.

Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception