Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. Page
        2. Page
          1. Annotation
            1. Widget
              1. AdditionalActions

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

Properties

Properties

$_annotation

protected \setasign\SetaPDF2\Core\Document\Page\Annotation\Annotation \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::$_annotation

The annotation instance


Methods

__construct()

public AdditionalActions::__construct ()

The constructor.

Parameters
$annotation : \setasign\SetaPDF2\Core\Document\Page\Annotation\WidgetAnnotation
 

_getAction()

protected \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::_getAction (
string $name,
bool $instance = true
): ?\setasign\SetaPDF2\Core\Document\Action\Action

Get the action.

Parameters
$name : string
 
$instance : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_setAction()

protected \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::_setAction (
string $name,
?\setasign\SetaPDF2\Core\Document\Action\Action $action = null
): void

Set the action.

Parameters
$name : string
 
$action : ?\setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::cleanUp (
void
): void

Release memory/cycled references.

getBlur()

public AdditionalActions::getBlur (
void
): ?\setasign\SetaPDF2\Core\Document\Action\Action

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

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getCursorEnter()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::getCursorEnter (
void
): ?\setasign\SetaPDF2\Core\Document\Action\Action

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

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getCursorExit()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::getCursorExit (
void
): ?\setasign\SetaPDF2\Core\Document\Action\Action

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

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getDictionary()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::getDictionary (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfDictionary

Get the "additional actions"-dictionary.

Parameters
$create : bool

Pass true to automatically create the dictionary

getFocus()

public AdditionalActions::getFocus (
void
): ?\setasign\SetaPDF2\Core\Document\Action\Action

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

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getMouseDown()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::getMouseDown (
void
): ?\setasign\SetaPDF2\Core\Document\Action\Action

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

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getMouseUp()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::getMouseUp (
void
): ?\setasign\SetaPDF2\Core\Document\Action\Action

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

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getPageClose()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::getPageClose (
void
): ?\setasign\SetaPDF2\Core\Document\Action\Action

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

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getPageInvisible()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::getPageInvisible (
void
): ?\setasign\SetaPDF2\Core\Document\Action\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 \setasign\SetaPDF2\Core\Type\Exception

getPageOpen()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::getPageOpen (
void
): ?\setasign\SetaPDF2\Core\Document\Action\Action

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

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getPageVisible()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::getPageVisible (
void
): ?\setasign\SetaPDF2\Core\Document\Action\Action

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

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setBlur()

public AdditionalActions::setBlur (): AdditionalActions

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

Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setCursorEnter()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::setCursorEnter (): \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions

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

Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setCursorExit()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::setCursorExit (): \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions

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

Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setFocus()

public AdditionalActions::setFocus (): AdditionalActions

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

Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setMouseDown()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::setMouseDown (): \setasign\SetaPDF2\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 : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setMouseUp()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::setMouseUp (): \setasign\SetaPDF2\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 : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setPageClose()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::setPageClose (): \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions

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

Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setPageInvisiable()

WARNING: This method is marked as deprecated!

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::setPageInvisiable (): $this
Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setPageInvisible()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::setPageInvisible (): \setasign\SetaPDF2\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 : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setPageOpen()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::setPageOpen (): \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions

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

Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setPageVisiable()

WARNING: This method is marked as deprecated!

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::setPageVisiable (): $this
Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setPageVisible()

public \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions::setPageVisible (): \setasign\SetaPDF2\Core\Document\Page\Annotation\AdditionalActions

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

Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception


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