Index

  1. \setasign\SetaPDF2
    1. FormFiller
      1. Field
        1. AbstractChoice
        2. AbstractField
        3. AdditionalActions
        4. AppearanceValueCallbackInterface
        5. CheckboxButtonField
        6. ComboField
        7. DefaultAppearanceData
        8. Exception
        9. FieldInterface
        10. Flags
        11. Formatter
        12. ListField
        13. PushButtonField
        14. RadioButtonGroup
        15. SignatureField
        16. TextField
        17. VariableTextTrait

setasign\SetaPDF2\FormFiller\Field

AdditionalActions Class representing a form fields additional-actions dictionary

File: /SetaPDF v2/FormFiller/Field/AdditionalActions.php
Old class name (alias): \SetaPDF_FormFiller_Field_AdditionalActions

Class hierarchy

Summary

Methods

Properties

Properties

$_field

protected \SetaPDF_FormFiller_Field_AbstractField AdditionalActions::$_field

The annotation instance


Methods

__construct()

public AdditionalActions::__construct ()

The constructor.

Parameters
$field : \SetaPDF_FormFiller_Field_AbstractField
 

_getAction()

protected AdditionalActions::_getAction (
string $name,
bool $instance = true
): ?\SetaPDF_Core_Document_Action_JavaScript

Get the action.

Parameters
$name : string
 
$instance : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_setAction()

protected AdditionalActions::_setAction (): void

Set the action.

Parameters
$name : string
 
$javaScriptAction : string|\SetaPDF_Core_Document_Action_JavaScript|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public AdditionalActions::cleanUp (
void
): void

Release memory/cycled references.

getCalculate()

public AdditionalActions::getCalculate (
void
): ?\SetaPDF_Core_Document_Action_JavaScript

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

getDictionary()

public AdditionalActions::getDictionary (
bool $create = false
): ?\SetaPDF_Core_Type_Dictionary

Get the additional actions dictionary.

Parameters
$create : bool

Pass true to automatically create the dictionary

getFormat()

public AdditionalActions::getFormat (
void
): ?\SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed before the field is formatted to display its value.

This action may modify the field’s value before formatting.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getKeystroke()

public AdditionalActions::getKeystroke (
void
): ?\SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed when the user modifies a character in a text field or combo box or modifies the selection in a scrollable list box.

This action may check the added text for validity and reject or modify it.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getValidate()

public AdditionalActions::getValidate (
void
): ?\SetaPDF_Core_Document_Action_JavaScript

Get the JavaScript action that shall be performed when the field’s value is changed.

This action may check the new value for validity.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setCalculate()

public AdditionalActions::setCalculate (): \SetaPDF_FormFiller_Field_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_JavaScript|string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setFormat()

public AdditionalActions::setFormat (): \SetaPDF_FormFiller_Field_AdditionalActions

Set the JavaScript action that shall be performed before the field is formatted to display its value.

This action may modify the field’s value before formatting.

Parameters
$action : \SetaPDF_Core_Document_Action_JavaScript|string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setKeystroke()

public AdditionalActions::setKeystroke (): \SetaPDF_FormFiller_Field_AdditionalActions

Set the JavaScript action that shall be performed when the user modifies a character in a text field or combo box or modifies the selection in a scrollable list box.

This action may check the added text for validity and reject or modify it.

Parameters
$action : \SetaPDF_Core_Document_Action_JavaScript|string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setValidate()

public AdditionalActions::setValidate (): \SetaPDF_FormFiller_Field_AdditionalActions

Set the JavaScript action that shall be performed when the field’s value is changed.

This action may check the new value for validity.

Parameters
$action : \SetaPDF_Core_Document_Action_JavaScript|string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception


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