SetaPDF_FormFiller_Field_AdditionalActions Class representing a form fields additional-actions dictionary

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

Class hierarchy

Summary

Properties


Methods

__construct()

public SetaPDF_FormFiller_Field_AdditionalActions::__construct ( SetaPDF_FormFiller_Field_AbstractField $field )

The constructor.

Parameters
$field : SetaPDF_FormFiller_Field_AbstractField
 

_getAction()

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

Get the action.

Parameters
$name : string
 
$instance : boolean
 

_setAction()

protected void SetaPDF_FormFiller_Field_AdditionalActions::_setAction ( string $name, string|SetaPDF_Core_Document_Action_JavaScript|SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_IndirectObjectInterface $javaScriptAction )

Set the action.

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

cleanUp()

public void SetaPDF_FormFiller_Field_AdditionalActions::cleanUp ( void )

Release memory/cycled references.

getCalculate()

public null|SetaPDF_Core_Document_Action_JavaScript SetaPDF_FormFiller_Field_AdditionalActions::getCalculate ( void )

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

getDictionary()

public null|SetaPDF_Core_Type_AbstractType|SetaPDF_Core_Type_Dictionary SetaPDF_FormFiller_Field_AdditionalActions::getDictionary ( [ bool $create = false ] )

Get the additional actions dictionary.

Parameters
$create : bool

Pass true to automatically create the dictionary

getFormat()

public null|SetaPDF_Core_Document_Action_JavaScript SetaPDF_FormFiller_Field_AdditionalActions::getFormat ( void )

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()

public null|SetaPDF_Core_Document_Action_JavaScript SetaPDF_FormFiller_Field_AdditionalActions::getKeystroke ( void )

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()

public null|SetaPDF_Core_Document_Action_JavaScript SetaPDF_FormFiller_Field_AdditionalActions::getValidate ( void )

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()

public SetaPDF_FormFiller_Field_AdditionalActions SetaPDF_FormFiller_Field_AdditionalActions::setCalculate ( SetaPDF_Core_Document_Action_JavaScript|string $action )

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()

public SetaPDF_FormFiller_Field_AdditionalActions SetaPDF_FormFiller_Field_AdditionalActions::setFormat ( SetaPDF_Core_Document_Action_JavaScript|string $action )

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()

public SetaPDF_FormFiller_Field_AdditionalActions SetaPDF_FormFiller_Field_AdditionalActions::setKeystroke ( SetaPDF_Core_Document_Action_JavaScript|string $action )

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()

public SetaPDF_FormFiller_Field_AdditionalActions SetaPDF_FormFiller_Field_AdditionalActions::setValidate ( SetaPDF_Core_Document_Action_JavaScript|string $action )

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