Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. Page
        2. Page
          1. Annotation
            1. AdditionalActions
            2. Annotation
            3. AppearanceCharacteristics
            4. BorderEffect
            5. BorderStyle
            6. CaretAnnotation
            7. CircleAnnotation
            8. FileAttachmentAnnotation
            9. Flags
            10. FreeTextAnnotation
            11. HighlightAnnotation
            12. InkAnnotation
            13. LineAnnotation
            14. LineEndingStyle
            15. LinkAnnotation
            16. MarkupAnnotation
            17. PolyLineAnnotation
            18. PolygonAnnotation
            19. PopupAnnotation
            20. QuadPointsTrait
            21. ScreenAnnotation
            22. SquareAnnotation
            23. SquigglyAnnotation
            24. StampAnnotation
            25. StrikeOutAnnotation
            26. TextAnnotation
            27. TextMarkupAnnotation
            28. UnderlineAnnotation
            29. Widget
            30. WidgetAnnotation

setasign\SetaPDF2\Core\Document\Page\Annotation

AdditionalActions Class representing an annotations additional-actions dictionary

File: /SetaPDF v2/Core/Document/Page/Annotation/AdditionalActions.php
Old class name (alias): \SetaPDF_Core_Document_Page_Annotation_AdditionalActions

Class hierarchy

Summary

Methods

Properties

Properties

$_annotation

protected Annotation AdditionalActions::$_annotation

The annotation instance


Methods

__construct()

public AdditionalActions::__construct (
Annotation $annotation
)

The constructor.

Parameters
$annotation : Annotation
 

_getAction()

protected 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 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 AdditionalActions::cleanUp (
void
): void

Release memory/cycled references.

getCursorEnter()

public 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 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 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

getMouseDown()

public 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 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 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 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 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 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

setCursorEnter()

public AdditionalActions::setCursorEnter (): 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 AdditionalActions::setCursorExit (): 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

setMouseDown()

public AdditionalActions::setMouseDown (): 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 AdditionalActions::setMouseUp (): 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 AdditionalActions::setPageClose (): 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 AdditionalActions::setPageInvisiable (): $this
Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setPageInvisible()

public AdditionalActions::setPageInvisible (): 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 AdditionalActions::setPageOpen (): 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 AdditionalActions::setPageVisiable (): $this
Parameters
$action : \setasign\SetaPDF2\Core\Document\Action\Action
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setPageVisible()

public AdditionalActions::setPageVisible (): 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)