SetaPDF v2 API Reference

): \SetaPDF_Core_Type_IndirectReference

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

_checkPermission()

protected AbstractField::_checkPermission (

int $permission = \setasign\SetaPDF2\Core\SecHandler\SecHandler ::PERM_FILL_FORM

): void

Checks for form-filling permissions.

Parameters

$permission : int

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

_getAppearanceReference()

protected AbstractField::_getAppearanceReference (

void

Get the reference to the normal appearance stream object.

_getBorderWidthAndStyle()

protected AbstractField::_getBorderWidthAndStyle (

void

): array

Resolve the border width and style

Exceptions

): \SetaPDF_Core_Type_Dictionary_Entry

_getFontRelation()

protected AbstractField::_getFontRelation (

\SetaPDF_Core_Type_Dictionary $nDictionary,
string &$fontName

Get the font relation and copy the resources to the Resources entry if needed.

Parameters

$nDictionary : \SetaPDF_Core_Type_Dictionary
$fontName : string

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

_getTDictionary()

protected AbstractField::_getTDictionary (

void

): bool|\SetaPDF_Core_Type_Dictionary

Get the dictionary that holds the last "T" entry.

_postDelete()

protected AbstractField::_postDelete (

void

): void

A method called after deleting a field.

This method forwards the deletion info to the fields instance.

_preDelete()

protected AbstractField::_preDelete (

void

): void

A method called before deleting a field.

This method forwards the deletion info to the fields instance.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

_preFlatten()

protected AbstractField::_preFlatten (

void

): void

A method called before flattening a field.

This method forwards the flatten info to the fields instance.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

_recreateAppearance()

protected AbstractField::_recreateAppearance (

bool $circle = false,
?\SetaPDF_Core_Canvas $canvas = null

): \SetaPDF_Core_Canvas

Recreate or creates the background appearance of the form field.

Parameters

$circle : bool
$canvas : ?\SetaPDF_Core_Canvas

Exceptions

cleanUp()

public AbstractChoice::cleanUp (

void

): void

Release cycled references and release memory.

delete()

public AbstractField::delete (

void

): void

Delete the field.

Exceptions

Throws Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

): \SetaPDF_FormFiller_Field_AdditionalActions

flatten()

public AbstractField::flatten (

bool $recreateAppearanceIfNeedAppearancesIsSet = false

): void

Flatten the field to the pages content stream.

Parameters

$recreateAppearanceIfNeedAppearancesIsSet : bool: Defines whether the field appearance is re-created if the NeedAppearances flag is set.

void

Gets the additional actions object instance for this field.

getAnnotation()

public AbstractField::getAnnotation (

void

): \SetaPDF_Core_Document_Page_Annotation_Widget

Get the widget annotation object from this field.

Exceptions

getAppearanceCanvas()

public AbstractField::getAppearanceCanvas (

void

): \SetaPDF_Core_Canvas

Get the appearance canvas of the "normal" appearance object.

Exceptions

): \SetaPDF_Core_Font_FontInterface

getAppearanceFont()

public AbstractField::getAppearanceFont (

void

Get the appearance font object.

Exceptions

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws Exception

getAppearanceFontSize()

public AbstractField::getAppearanceFontSize (

void

): ?float

Get the appearance font size.

Exceptions

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

): \SetaPDF_Core_DataStructure_Color

Throws Exception

getAppearanceTextColor()

public AbstractField::getAppearanceTextColor (

void

Get the individual appearance text color.

Exceptions

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws Exception

getAppearanceTextColorSpace()

public AbstractField::getAppearanceTextColorSpace (

void

): ?\SetaPDF_Core_ColorSpace

Get the individual color space object which should be used for setting the non-stroking color space.

getAppearanceValue()

public ComboField::getAppearanceValue (

string $encoding = 'UTF-8'

): string

Get the appearance value.

Parameters

$encoding : string

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

): \SetaPDF_FormFiller_Field_DefaultAppearanceData

getDefaultAppearanceData()

public AbstractField::getDefaultAppearanceData (

void

Get the default appearance data of the DA value.

Exceptions

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

): \SetaPDF_Core_Type_Dictionary

Throws Exception

getDefaultValue()

public ComboField::getDefaultValue (

string $encoding = 'UTF-8'

): ?string

Returns the default value of the field.

This value is used if the form is reset

Parameters

$encoding : string

See

FieldInterface::getDefaultValue()

getFieldDictionary()

public AbstractField::getFieldDictionary (

void

Get the field dictionary.

getFieldFlags()

public AbstractField::getFieldFlags (

void

): int

Returns the current field flags.

getFieldObject()

public AbstractField::getFieldObject (

void

): \SetaPDF_Core_Type_IndirectObject

Get the indirect object of the form field.

getFields()

public AbstractField::getFields (

void

): \SetaPDF_FormFiller_Fields

Get the fields instance.

getLineHeightFactor()

public AbstractField::getLineHeightFactor (

void

): float

Get the line height factor

The line height is calculated by this factor in relation to the font size:

copy

$lineHeight = $fontSize * $lineHeightFactor

By default, this value is calculated by the font bounding box values "ury - lly / 1000".

Exceptions

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

): \SetaPDF_Core_Type_IndirectObject

Throws Exception

See

AbstractField::setLineHeightFactor()

getName()

public AbstractField::getName (

void

): string

Alias for getQualifiedName().

See

AbstractField::getQualifiedName()

getNoExport()

public AbstractField::getNoExport (

void

): bool

Checks if the no-export flag is set.

getNormalAppearanceObject()

public AbstractField::getNormalAppearanceObject (

bool $createNew = false

Get or create the normal appearance object (the object referenced in the N entry).

Parameters

$createNew : bool: Pass true to force a recreation

Exceptions

getOptions()

public AbstractChoice::getOptions (

string $encoding = 'UTF-8'

): array

Get the options and the export values.

Parameters

$encoding : string: The output encoding

Return Values

An array of arrays with following keys: visibleValue and exportValue

Exceptions

): \SetaPDF_Core_Document_Page

getOriginalQualifiedName()

public AbstractField::getOriginalQualifiedName (

void

): string

Get the original qualified name (without suffix).

getPage()

public AbstractField::getPage (

void

Gets the page object on which the form field is placed.

Exceptions

Throws Exception

getPageNumber()

public AbstractField::getPageNumber (

void

): int

Get the page number on which the field appears.

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotDefinedException

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws Exception

getQualifiedName()

public AbstractField::getQualifiedName (

void

): string

Returns the qualified name.

getTooltip()

public AbstractField::getTooltip (

string $encoding = 'UTF-8'

): bool|string

Get the tooltip value.

Parameters

$encoding : string

getValue()

public ComboField::getValue (

string $encoding = 'UTF-8'

): ?string

Get the current value

Parameters

$encoding : string: The output encoding

Return Values

If no value is selected null will be returned otherwise a string.

getVisibleValue()

public ComboField::getVisibleValue (

string $encoding = 'UTF-8'

): string

Get the visible value of the current selected option

Parameters

$encoding : string

Exceptions

isEditable()

public ComboField::isEditable (

void

): bool

Checks if the combo box shall include an editable text box as well to a drop-down list

isFieldFlagSet()

public AbstractField::isFieldFlagSet (

int $flag

): bool

Checks if a specific field flag is set.

Parameters

$flag : int

isReadOnly()

public AbstractField::isReadOnly (

void

): bool

Checks if the field is set to read-only.

isRequired()

public AbstractField::isRequired (

void

): bool

Checks if the field is set to be required.

recreateAppearance()

public ComboField::recreateAppearance (

void

): void

Recreate or creates the appearance of the form field

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws Exception

setAppearanceFont()

public AbstractField::setAppearanceFont (

\SetaPDF_Core_Font_FontInterface $font,
float $size = null

): void

Set the appearance font object.

Parameters

$font : \SetaPDF_Core_Font_FontInterface
$size : float

setAppearanceFontSize()

public AbstractField::setAppearanceFontSize (

?float $fontSize

): void

Set an individual font size.

Parameters

$fontSize : ?float

setAppearanceTextColor()

public AbstractField::setAppearanceTextColor (

?\SetaPDF_Core_DataStructure_Color $textColor = null

): void

Set an individual appearance text color.

Parameters

$textColor : ?\SetaPDF_Core_DataStructure_Color

setAppearanceTextColorSpace()

public AbstractField::setAppearanceTextColorSpace (

?\SetaPDF_Core_ColorSpace $colorSpace = null

): void

Set the individual color space object which should be used for setting the non-stroking color space.

Parameters

$colorSpace : ?\SetaPDF_Core_ColorSpace

setAppearanceValueCallback()

public ComboField::setAppearanceValueCallback (

callback $callback

): void

Set the appearance value callback (to e.g. format a number).

The callback will be called with 2 arguments:

A reference to the field instance
The requested encoding

It needs to return a value in the specified encoding (internal calls need UTF-16BE throughout).

Parameters

$callback : callback

setDefaultValue()

public ComboField::setDefaultValue (

null|string|int $value,
string $encoding = 'UTF-8'

): void

Set the default value of the field.

Parameters

$value : null|string|int
$encoding : string

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

setEditable()

public ComboField::setEditable (

bool $editable = true,
bool $setDefaultValue = true

): void

Sets if the combo box shall include an editable text box as well to a drop-down list

Parameters

$editable : bool
$setDefaultValue : bool

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws Exception

setFieldFlags()

public AbstractField::setFieldFlags (

int $flags,
?bool $add = true

): void

Sets a field flag.

Parameters

$flags : int
$add : ?bool: Add = true, remove = false, set = null

setLineHeightFactor()

public AbstractField::setLineHeightFactor (

?float $lineHeightFactor

): void

Set the line height factor

The line height is calculated by this factor in relation to the font size:

copy

$lineHeight = $fontSize * $lineHeightFactor

By default, this value is calculated by the font bounding box values "ury - lly / 1000".

Parameters

$lineHeightFactor : ?float

See

AbstractField::getLineHeightFactor()

setNoExport()

public AbstractField::setNoExport (

bool $noExport = true

): void

Set the no-export flag.

Parameters

$noExport : bool

setReadOnly()

public AbstractField::setReadOnly (

bool $readOnly = true

): void

Sets the read-only flag.

Parameters

$readOnly : bool

Exceptions

Throws \DOMException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

setRequired()

public AbstractField::setRequired (

bool $required = true

): void

Sets the required flag.

Parameters

$required : bool

setTooltip()

public AbstractField::setTooltip (

string|false $value,
string $encoding = 'UTF-8'

): void

Set the tooltip value.

Parameters

$value : string|false
$encoding : string

setValue()

public ComboField::setValue (

string|int $value,
string $encoding = 'UTF-8'

): void

Set the fields value / Selects the option

The value could be an export value of an option or the numeric index of an option, received by getOptions(). If the field is marked as an editable text field, it is also possible to pass a string.

Parameters

$value : string|int
$encoding : string

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception