Index

  1. \setasign\SetaPDF2
    1. FormFiller
      1. Field
        1. AbstractChoice
        2. AbstractField
        3. AdditionalActions
        4. AppearanceValueCallbackInterface
        5. CheckboxButtonField
        6. ComboField
        7. DefaultAppearanceData
        8. Exception
        9. FieldInterface
        10. Flags
        11. Formatter
        12. ListField
        13. PushButtonField
        14. RadioButtonGroup
        15. SignatureField
        16. TextField
        17. VariableTextTrait

setasign\SetaPDF2\FormFiller\Field

AbstractField Abstract form field

File: /SetaPDF v2/FormFiller/Field/AbstractField.php
Old class name (alias): \SetaPDF_FormFiller_Field_AbstractField

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_annotation

protected \SetaPDF_Core_Document_Page_Annotation_Widget AbstractField::$_annotation

The annotation object of this form field

$_appearanceCanvas

protected \SetaPDF_Core_Canvas AbstractField::$_appearanceCanvas

The canvas object of the appearance

$_appearanceCreated

protected bool AbstractField::$_appearanceCreated = false

$_defaultAppearanceData

protected \SetaPDF_FormFiller_Field_DefaultAppearanceData AbstractField::$_defaultAppearanceData

$_fieldDictionary

protected \SetaPDF_Core_Type_Dictionary AbstractField::$_fieldDictionary

The main field dictionary

$_fieldObject

protected \SetaPDF_Core_Type_IndirectObject AbstractField::$_fieldObject

The fields indirect object

$_fields

protected \SetaPDF_FormFiller_Fields AbstractField::$_fields

A reference to the fields instance

$_font

protected \SetaPDF_Core_Font_FontInterface AbstractField::$_font

The font object, which should be used to create the appearance

$_fontSize

protected ?float AbstractField::$_fontSize

The font size, which should be used to create the appearance

$_lineHeightFactor

protected float AbstractField::$_lineHeightFactor

The factor to calculate the line height based on the font size

$_originalQualifiedName

protected string AbstractField::$_originalQualifiedName

The name without the suffix

$_page

protected \SetaPDF_Core_Document_Page AbstractField::$_page

The page instance on which the form field is placed

$_qualifiedName

protected string AbstractField::$_qualifiedName

The name including a suffix if needed ("Text#1")

$_textColor

protected ?\SetaPDF_Core_DataStructure_Color AbstractField::$_textColor

An individual color object which should be used for drawing the text appearance

$_textColorSpace

protected ?\SetaPDF_Core_ColorSpace AbstractField::$_textColorSpace

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


Methods

__construct()

public AbstractField::__construct (
\SetaPDF_FormFiller_Fields $fields,
string $qualifiedName,
\SetaPDF_Core_Type_IndirectObject $fieldObject,
string $originalQualifiedName = null
)

The constructor.

Parameters
$fields : \SetaPDF_FormFiller_Fields

The fields instance

$qualifiedName : string

The qualified name of the field

$fieldObject : \SetaPDF_Core_Type_IndirectObject

The indirect object holding the field dictionary (terminal field object)

$originalQualifiedName : string

The original qualified name of the field

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

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

_checkPermission()

protected AbstractField::_checkPermission (): void

Checks for form-filling permissions.

Parameters
$permission : int
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

_getAppearanceReference()

protected AbstractField::_getAppearanceReference (
void
): \SetaPDF_Core_Type_IndirectReference

Get the reference to the normal appearance stream object.

_getBorderWidthAndStyle()

protected AbstractField::_getBorderWidthAndStyle (
void
): array

Resolve the border width and style

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_getFontRelation()

protected AbstractField::_getFontRelation (
\SetaPDF_Core_Type_Dictionary $nDictionary,
string &$fontName
): \SetaPDF_Core_Type_Dictionary_Entry

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

Throws \setasign\SetaPDF2\Core\Type\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

Throws \setasign\SetaPDF2\Core\Type\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

Throws \setasign\SetaPDF2\Core\Type\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

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\NotImplementedException

cleanUp()

public AbstractField::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\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\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\Exception

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

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

See

getAnnotation()

public AbstractField::getAnnotation (
void
): \SetaPDF_Core_Document_Page_Annotation_Widget

Get the widget annotation object from this field.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getAppearanceCanvas()

public AbstractField::getAppearanceCanvas (
void
): \SetaPDF_Core_Canvas

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

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getAppearanceFont()

public AbstractField::getAppearanceFont (
void
): \SetaPDF_Core_Font_FontInterface

Get the appearance font object.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Font\Exception

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

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\FormFiller\Exception

Throws Exception

getAppearanceFontSize()

public AbstractField::getAppearanceFontSize (
void
): ?float

Get the appearance font size.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

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

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws Exception

getAppearanceTextColor()

public AbstractField::getAppearanceTextColor (
void
): \SetaPDF_Core_DataStructure_Color

Get the individual appearance text color.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

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

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\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.

getDefaultAppearanceData()

public AbstractField::getDefaultAppearanceData (
void
): \SetaPDF_FormFiller_Field_DefaultAppearanceData

Get the default appearance data of the DA value.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

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

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws Exception

getDefaultValue()

abstract public FieldInterface::getDefaultValue (
string $encoding = 'UTF-8'
): mixed

Returns the default value of the field.

This value is used if the form is reset

Parameters
$encoding : string
 

getFieldDictionary()

public AbstractField::getFieldDictionary (
void
): \SetaPDF_Core_Type_Dictionary

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:

$lineHeight = $fontSize * $lineHeightFactor

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

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Font\Exception

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

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\FormFiller\Exception

Throws Exception

See

getName()

public AbstractField::getName (
void
): string

Alias for getQualifiedName().

See

getNoExport()

public AbstractField::getNoExport (
void
): bool

Checks if the no-export flag is set.

getNormalAppearanceObject()

public AbstractField::getNormalAppearanceObject (
bool $createNew = false
): \SetaPDF_Core_Type_IndirectObject

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

Parameters
$createNew : bool

Pass true to force a recreation

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getOriginalQualifiedName()

public AbstractField::getOriginalQualifiedName (
void
): string

Get the original qualified name (without suffix).

getPage()

public AbstractField::getPage (
void
): \SetaPDF_Core_Document_Page

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

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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 \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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

abstract public FieldInterface::getValue (
void
): mixed

Returns the field specific value.

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

abstract public FieldInterface::recreateAppearance (
void
): void

Recreate or creates the appearance of the form field if needed.

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

setDefaultValue()

abstract public FieldInterface::setDefaultValue (
mixed $value,
string $encoding = 'UTF-8'
): void

Set the default value of the field.

Parameters
$value : mixed
 
$encoding : string
 

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:

$lineHeight = $fontSize * $lineHeightFactor

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

Parameters
$lineHeightFactor : ?float
 
See

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

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\FormFiller\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()

abstract public FieldInterface::setValue (
mixed $value
): void

Sets the fields value.

Parameters
$value : mixed
 

unsetFieldFlags()

public AbstractField::unsetFieldFlags (
int $flags
): void

Removes a field flag.

Parameters
$flags : int
 

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