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 (
$name [, $instance = true ]
):

Get the action.

Parameters
$name
 
$instance
 

_setAction()

Set the action.

Parameters
$name
 
$action : SetaPDF_Core_Document_Action|null
 
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.

getCursorExit()

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

getDictionary()

Get the additional actions dictionary.

Parameters
$create

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.

getMouseUp()

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

getPageClose()

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

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.

getPageOpen()

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

getPageVisible()

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

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

setPageInvisiable()

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

setPageVisiable()

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