SetaPDF_FormFiller_Field_AdditionalActions Class representing a form fields additional-actions dictionary
File: /SetaPDF v2/FormFiller/Field/AdditionalActions.php
Class hierarchy
Summary
Properties
$_field
The annotation instance
Methods
__construct()
_getAction()
Get the action.
Parameters
- $name : string
- $instance : boolean
_setAction()
Set the action.
Parameters
- $name : string
- $javaScriptAction : string|SetaPDF_Core_Document_Action_JavaScript|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface
getCalculate()
Get the action that shall be performed when the mouse button is released inside the annotation’s active area.
getDictionary()
Get the additional actions dictionary.
Parameters
- $create : bool
Pass true to automatically create the dictionary
getFormat()
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.
getKeystroke()
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.
getValidate()
Get the JavaScript action that shall be performed when the field’s value is changed.
This action may check the new value for validity.
setCalculate()
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
setFormat()
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
setKeystroke()
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
setValidate()
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