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

_purgeValue()

protected TextField::_purgeValue (

string $value

): string

Purges the value accoring to field properties like "multiline" or "max-length".

Parameters

$value : string: Value in UTF-16BE encoding

_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 TextField::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

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.

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

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

Throws \setasign\SetaPDF2\Core\Reader\Exception

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

Throws \setasign\SetaPDF2\Exception

): \SetaPDF_FormFiller_Field_AdditionalActions

See

AbstractField::delete()

getAdditionalActions()

public TextField::getAdditionalActions (

void

Gets the additional actions object instance for this field.

getAlign()

public VariableTextTrait::getAlign (

void

): string

Get the field alignment.

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

): \SetaPDF_FormFiller_Field_DefaultAppearanceData

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 TextField::getAppearanceValue (

string $encoding = 'UTF-8'

): string

Get the appearance value.

Parameters

$encoding : string

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

getMaxLength()

public TextField::getMaxLength (

void

): bool|int

Get the max length property if available.

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

): \SetaPDF_Core_Document_Page

getObserveTextOverflow()

public TextField::getObserveTextOverflow (

void

): bool

Get whether observing text overflow is enabled or not.

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.

getTextOverflow()

public TextField::getTextOverflow (

void

): ?int

Check if the visible text overflows the visible area.

Return Values

If text does not overflow 0 is returned. Otherwise 1 if the text overflows vertically or 2 if the text overflows horizontally. 3 for both. Null is returned if the overflow is not calculated yet.

getTooltip()

public AbstractField::getTooltip (

string $encoding = 'UTF-8'

): bool|string

Get the tooltip value.

Parameters

$encoding : string

getValue()

public TextField::getValue (

string $encoding = 'UTF-8'

): string

Get the field value.

Parameters

$encoding : string: The output encoding

See

FieldInterface::getValue()

getVisibleValue()

public TextField::getVisibleValue (

string $encoding = 'UTF-8'

): string

Returns the field specific visible value.

Parameters

$encoding : string

isCombField()

public TextField::isCombField (

void

): bool

Check if the comb field flag is set.

isDoNotScrollSet()

public TextField::isDoNotScrollSet (

void

): bool

Check if the "do not scroll" flag is set.

isDoNotSpellCheckSet()

public TextField::isDoNotSpellCheckSet (

void

): bool

Check if the "do not spell check" flag is set.

isFieldFlagSet()

public AbstractField::isFieldFlagSet (

int $flag

): bool

Checks if a specific field flag is set.

Parameters

$flag : int

isMultiline()

public TextField::isMultiline (

void

): bool

Check if the multiline flag is set.

isPasswordField()

public TextField::isPasswordField (

void

): bool

Check if the password field flag is set.

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 TextField::recreateAppearance (

void

): void

Recreate or creates the Appearance of the form field.

Exceptions

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

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

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

Throws Exception

setAlign()

public VariableTextTrait::setAlign (

string $align,
bool $recreateAppearanceOnChange = true

): void

Set the field alignment.

Parameters

$align : string: Possible values are: \setasign\SetaPDF2\Core\Text\Text ::ALIGN_LEFT, \setasign\SetaPDF2\Core\Text\Text ::ALIGN_CENTER, \setasign\SetaPDF2\Core\Text\Text ::ALIGN_RIGHT.
$recreateAppearanceOnChange : bool

Exceptions

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 TextField::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

setCombField()

public TextField::setCombField (

bool $comb = true

): void

Set the comb field flag.

Changing this flag will re-create the field appearance.

Parameters

$comb : bool

Exceptions

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

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

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

Throws Exception

setDefaultValue()

public TextField::setDefaultValue (

?string $value,
string $encoding = 'UTF-8'

): void

Set the default value of the field.

Parameters

$value : ?string
$encoding : string

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

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

setDoNotScroll()

public TextField::setDoNotScroll (

bool $doNotScroll = true

): void

Set the "do not scroll" flag.

Parameters

$doNotScroll : bool

setDoNotSpellCheck()

public TextField::setDoNotSpellCheck (

bool $doNotSpellCheck = true

): void

Set the "do not spell check" flag.

Parameters

$doNotSpellCheck : bool

Exceptions

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

setMaxLength()

public TextField::setMaxLength (

int $maxLength

): void

Set the max length property.

Changing this flag will reset the value to a value that fits into the given maximal length.

Parameters

$maxLength : int

Exceptions

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

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

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

Throws Exception

setMultiline()

public TextField::setMultiline (

bool|true $multiline = true

): void

Set the multiline flag.

Changing this flag will re-create the field appearance.

Parameters

$multiline : bool|true

Exceptions

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

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

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

Throws Exception

setNoExport()

public AbstractField::setNoExport (

bool $noExport = true

): void

Set the no-export flag.

Parameters

$noExport : bool

setObserveTextOverflow()

public TextField::setObserveTextOverflow (

bool $observeTextOverflow

): void

Set whether observing text overflow is enabled or not.

Parameters

$observeTextOverflow : bool

setPasswordField()

public TextField::setPasswordField (

bool $password = true

): void

Set the password field flag.

Changing this flag will re-create the field appearance.

Parameters

$password : bool

Exceptions

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

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

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

Throws Exception

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

Throws \setasign\SetaPDF2\Exception

setRequired()

public AbstractField::setRequired (

bool $required = true

): void

Sets the required flag.

Parameters

$required : bool

setTextTranslate()

public TextField::setTextTranslate (

int $x = 0,
int $y = 0

): void

Set translate data for the text appearance.

Parameters

$x : int: The value by which the text should be translated on the abscissa.
$y : int: The value by which the text should be translated on the ordinate.

setTooltip()

public AbstractField::setTooltip (

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

): void

Set the tooltip value.

Parameters

$value : string|false
$encoding : string

setValue()

public TextField::setValue (

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

): void

Set the field value.

If the fields multiline flag is set (see isMultiline()) the method accepts a string of several lines.

All common line delimiters are possible: \r\n, \n or \r

Internally they get normalized. So if you need to compare a value of the getValue() method keep this in mind.

Parameters

$value : string: The text field value
$encoding : string: The input encoding

Exceptions

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

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

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