Index

  1. \SetaPDF
    1. FormFiller
    2. FormFiller
      1. Field
        1. Choice
        2. AbstractField
        3. AdditionalActions
        4. AppearanceValueCallbackInterface
        5. Button
        6. ButtonGroup
        7. Combo
        8. DefaultAppearanceData
        9. Exception
        10. FieldInterface
        11. Flags
        12. Formatter
        13. List
        14. PushButton
        15. Signature
        16. Text

SetaPDF_FormFiller_Field_AdditionalActions Class representing a form fields additional-actions dictionary

File: /SetaPDF v2/FormFiller/Field/AdditionalActions.php

Class hierarchy

Summary

Methods

Properties

Properties

$_field

protected SetaPDF_FormFiller_Field_AbstractField SetaPDF_FormFiller_Field_AdditionalActions::$_field

The annotation instance


Methods

__construct()

public SetaPDF_FormFiller_Field_AdditionalActions::__construct ()

The constructor.

Parameters
$field : SetaPDF_FormFiller_Field_AbstractField
 

_getAction()

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

Get the action.

Parameters
$name : string
 
$instance : boolean
 
Exceptions

Throws SetaPDF_Core_Type_Exception

_setAction()

protected SetaPDF_FormFiller_Field_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 SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_FormFiller_Field_AdditionalActions::cleanUp (
void
): void

Release memory/cycled references.

getCalculate()

public SetaPDF_FormFiller_Field_AdditionalActions::getCalculate (
void
): null|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 SetaPDF_Core_Type_Exception

getDictionary()

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

getFormat()

public SetaPDF_FormFiller_Field_AdditionalActions::getFormat (
void
): null|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 SetaPDF_Core_Type_Exception

getKeystroke()

public SetaPDF_FormFiller_Field_AdditionalActions::getKeystroke (
void
): null|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 SetaPDF_Core_Type_Exception

getValidate()

public SetaPDF_FormFiller_Field_AdditionalActions::getValidate (
void
): null|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 SetaPDF_Core_Type_Exception

setCalculate()

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

setFormat()

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

setKeystroke()

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

setValidate()

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


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