SetaPDF_Core_Document_Page_Annotation_AdditionalActions Class representing an annotations additional-actions dictionary

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

Class hierarchy

Summary

Properties


Methods

__construct()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::__construct ( SetaPDF_Core_Document_Page_Annotation $annotation )

The constructor.

Parameters
$annotation : SetaPDF_Core_Document_Page_Annotation
 

_getAction()

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

Get the action.

Parameters
$name : string
 
$instance : boolean
 

_setAction()

protected void SetaPDF_Core_Document_Page_Annotation_AdditionalActions::_setAction ( string $name [, SetaPDF_Core_Document_Action $action = null ] )

Set the action.

Parameters
$name : string
 
$action : SetaPDF_Core_Document_Action
 

cleanUp()

public void SetaPDF_Core_Document_Page_Annotation_AdditionalActions::cleanUp ( void )

Release memory/cycled references.

getCursorEnter()

public null|SetaPDF_Core_Document_Action SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getCursorEnter ( void )

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

getCursorExit()

public null|SetaPDF_Core_Document_Action SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getCursorExit ( void )

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

getDictionary()

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

Get the additional actions dictionary.

Parameters
$create : bool

Pass true to automatically create the dictionary

getMouseDown()

public null|SetaPDF_Core_Document_Action SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getMouseDown ( void )

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

getMouseUp()

public null|SetaPDF_Core_Document_Action SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getMouseUp ( void )

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

getPageClose()

public null|SetaPDF_Core_Document_Action SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getPageClose ( void )

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

getPageInvisible()

public null|SetaPDF_Core_Document_Action SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getPageInvisible ( void )

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()

public null|SetaPDF_Core_Document_Action SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getPageOpen ( void )

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

getPageVisible()

public null|SetaPDF_Core_Document_Action SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getPageVisible ( void )

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

setCursorEnter()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setCursorEnter ( SetaPDF_Core_Document_Action $action )

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

Parameters
$action : SetaPDF_Core_Document_Action
 

setCursorExit()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setCursorExit ( SetaPDF_Core_Document_Action $action )

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

Parameters
$action : SetaPDF_Core_Document_Action
 

setMouseDown()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setMouseDown ( SetaPDF_Core_Document_Action $action )

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()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setMouseUp ( SetaPDF_Core_Document_Action $action )

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()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setPageClose ( SetaPDF_Core_Document_Action $action )

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

Parameters
$action : SetaPDF_Core_Document_Action
 

setPageInvisiable()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setPageInvisiable ( SetaPDF_Core_Document_Action $action )

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()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setPageOpen ( SetaPDF_Core_Document_Action $action )

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

Parameters
$action : SetaPDF_Core_Document_Action
 

setPageVisiable()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setPageVisiable ( SetaPDF_Core_Document_Action $action )

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

Parameters
$action : SetaPDF_Core_Document_Action