SetaPDF_Core_Document_Page_Annotation_Widget_AdditionalActions Class representing a widget annotations additional-actions dictionary

File: /SetaPDF v2/Core/Document/Page/Annotation/Widget/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
 

_setAction()

Set the action.

Parameters
$name : string
 
$action : SetaPDF_Core_Document_Action
 

cleanUp()

Release memory/cycled references.

getBlur()

Get the action that shall be performed when the annotation loses the input focus.

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 : bool

Pass true to automatically create the dictionary

getFocus()

Get the action that shall be performed when the annotation receives the input focus.

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.

setBlur()

Set the action that shall be performed when the annotation loses the input focus.

Parameters
$action : SetaPDF_Core_Document_Action
 

setCursorEnter()

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

Parameters
$action : SetaPDF_Core_Document_Action
 

setCursorExit()

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

Parameters
$action : SetaPDF_Core_Document_Action
 

setFocus()

Set the action that shall be performed when the annotation receives the input focus.

Parameters
$action : SetaPDF_Core_Document_Action
 

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
 

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
 

setPageClose()

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

Parameters
$action : SetaPDF_Core_Document_Action
 

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
 

setPageOpen()

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

Parameters
$action : SetaPDF_Core_Document_Action
 

setPageVisiable()

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

Parameters
$action : SetaPDF_Core_Document_Action