setasign\SetaPDF2\Core\Document\Page\Annotation\Widget
AdditionalActions Class representing a widget annotations additional-actions dictionary
File: /SetaPDF v2/Core/Document/Page/Annotation/Widget/AdditionalActions.php
Old class name (alias):
\SetaPDF_Core_Document_Page_Annotation_Widget_AdditionalActions
Class hierarchy
Summary
Methods
- __construct()
- _getAction()
- _setAction()
- cleanUp()
- getBlur()
- getCursorEnter()
- getCursorExit()
- getDictionary()
- getFocus()
- getMouseDown()
- getMouseUp()
- getPageClose()
- getPageInvisible()
- getPageOpen()
- getPageVisible()
- setBlur()
- setCursorEnter()
- setCursorExit()
- setFocus()
- setMouseDown()
- setMouseUp()
- setPageClose()
- setPageInvisiable()
- setPageInvisible()
- setPageOpen()
- setPageVisiable()
- setPageVisible()
Properties
$_annotation
The annotation instance
Methods
__construct()
_getAction()
bool $instance = true
Get the action.
Parameters
- $name : string
- $instance : bool
Exceptions
_setAction()
Set the action.
Parameters
- $name : string
- $action : ?\SetaPDF_Core_Document_Action
Exceptions
getBlur()
Get the action that shall be performed when the annotation loses the input focus.
Exceptions
getCursorEnter()
Get the action that shall be performed when the cursor enters the annotation’s active area.
Exceptions
getCursorExit()
Get the action that shall be performed when the cursor exits the annotation’s active area.
Exceptions
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.
Exceptions
getMouseDown()
Get the action that shall be performed when the mouse button is pressed inside the annotation’s active area.
Exceptions
getMouseUp()
Get the action that shall be performed when the mouse button is released inside the annotation’s active area.
Exceptions
getPageClose()
Get the action that shall be performed when the page containing the annotation is closed.
Exceptions
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
getPageOpen()
Get the action that shall be performed when the page containing the annotation is opened.
Exceptions
getPageVisible()
Get the action that shall be performed when the page containing the annotation becomes visible.
Exceptions
setBlur()
Set the action that shall be performed when the annotation loses the input focus.
Parameters
- $action : \SetaPDF_Core_Document_Action
Exceptions
setCursorEnter()
Set the action that shall be performed when the cursor enters the annotation’s active area.
Parameters
- $action : \SetaPDF_Core_Document_Action
Exceptions
setCursorExit()
Set the action that shall be performed when the cursor exits the annotation’s active area.
Parameters
- $action : \SetaPDF_Core_Document_Action
Exceptions
setFocus()
Set the action that shall be performed when the annotation receives the input focus.
Parameters
- $action : \SetaPDF_Core_Document_Action
Exceptions
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
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
setPageClose()
Set the action that shall be performed when the page containing the annotation is closed.
Parameters
- $action : \SetaPDF_Core_Document_Action
Exceptions
setPageInvisiable()
WARNING: This method is marked as deprecated!
Parameters
- $action : \SetaPDF_Core_Document_Action
Exceptions
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
setPageOpen()
Set the action that shall be performed when the page containing the annotation is opened.
Parameters
- $action : \SetaPDF_Core_Document_Action
Exceptions
setPageVisiable()
WARNING: This method is marked as deprecated!
Parameters
- $action : \SetaPDF_Core_Document_Action
Exceptions
setPageVisible()
Set the action that shall be performed when the page containing the annotation becomes visible.
Parameters
- $action : \SetaPDF_Core_Document_Action