Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Page
        2. Page
          1. Annotation
          2. Annotation
            1. Widget
            2. Widget
              1. AdditionalActions

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

Methods

Properties

Properties

$_annotation

protected SetaPDF_Core_Document_Page_Annotation SetaPDF_Core_Document_Page_Annotation_AdditionalActions::$_annotation

The annotation instance


Methods

__construct()

public SetaPDF_Core_Document_Page_Annotation_Widget_AdditionalActions::__construct ()

The constructor.

Parameters
$annotation : SetaPDF_Core_Document_Page_Annotation_Widget
 

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

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

Set the action.

Parameters
$name : string
 
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::cleanUp (
void
): void

Release memory/cycled references.

getBlur()

public SetaPDF_Core_Document_Page_Annotation_Widget_AdditionalActions::getBlur (
void
): null|SetaPDF_Core_Document_Action

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

Exceptions

Throws SetaPDF_Core_Type_Exception

getCursorEnter()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getCursorEnter (
void
): null|SetaPDF_Core_Document_Action

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

Exceptions

Throws SetaPDF_Core_Type_Exception

getCursorExit()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getCursorExit (
void
): null|SetaPDF_Core_Document_Action

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

Exceptions

Throws SetaPDF_Core_Type_Exception

getDictionary()

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

Get the additional actions dictionary.

Parameters
$create : bool

Pass true to automatically create the dictionary

getFocus()

public SetaPDF_Core_Document_Page_Annotation_Widget_AdditionalActions::getFocus (
void
): null|SetaPDF_Core_Document_Action

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

Exceptions

Throws SetaPDF_Core_Type_Exception

getMouseDown()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getMouseDown (
void
): null|SetaPDF_Core_Document_Action

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

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getMouseUp (
void
): null|SetaPDF_Core_Document_Action

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

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getPageClose (
void
): null|SetaPDF_Core_Document_Action

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

Exceptions

Throws SetaPDF_Core_Type_Exception

getPageInvisible()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getPageInvisible (
void
): null|SetaPDF_Core_Document_Action

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

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getPageOpen (
void
): null|SetaPDF_Core_Document_Action

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

Exceptions

Throws SetaPDF_Core_Type_Exception

getPageVisible()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::getPageVisible (
void
): null|SetaPDF_Core_Document_Action

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

Exceptions

Throws SetaPDF_Core_Type_Exception

setBlur()

public SetaPDF_Core_Document_Page_Annotation_Widget_AdditionalActions::setBlur (): SetaPDF_Core_Document_Page_Annotation_Widget_AdditionalActions

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

Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setCursorEnter()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setCursorEnter (): SetaPDF_Core_Document_Page_Annotation_AdditionalActions

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

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setCursorExit (): SetaPDF_Core_Document_Page_Annotation_AdditionalActions

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

setFocus()

public SetaPDF_Core_Document_Page_Annotation_Widget_AdditionalActions::setFocus (): SetaPDF_Core_Document_Page_Annotation_Widget_AdditionalActions

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

Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setMouseDown()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setMouseDown (): SetaPDF_Core_Document_Page_Annotation_AdditionalActions

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

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setMouseUp (): SetaPDF_Core_Document_Page_Annotation_AdditionalActions

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

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setPageClose (): SetaPDF_Core_Document_Page_Annotation_AdditionalActions

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

WARNING: This method is marked as deprecated!

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setPageInvisiable (): $this
Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setPageInvisible()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setPageInvisible (): SetaPDF_Core_Document_Page_Annotation_AdditionalActions

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

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setPageOpen (): SetaPDF_Core_Document_Page_Annotation_AdditionalActions

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

WARNING: This method is marked as deprecated!

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setPageVisiable (): $this
Parameters
$action : SetaPDF_Core_Document_Action
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setPageVisible()

public SetaPDF_Core_Document_Page_Annotation_AdditionalActions::setPageVisible (): SetaPDF_Core_Document_Page_Annotation_AdditionalActions

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


© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)