SetaPDF v2 API Reference

Throws SetaPDF_Core_Type_IndirectReference_Exception

_checkPermission()

protected SetaPDF_FormFiller_Field_AbstractField::_checkPermission (

[ integer $permission = SetaPDF_Core_SecHandler ::PERM_FILL_FORM ]

): void

Checks for form-filling permissions.

Parameters

$permission : integer

Exceptions

): SetaPDF_Core_Type_IndirectReference

_getAppearanceReference()

protected SetaPDF_FormFiller_Field_AbstractField::_getAppearanceReference (

void

Get the reference to the normal appearance stream object.

_getBorderWidthAndStyle()

protected SetaPDF_FormFiller_Field_AbstractField::_getBorderWidthAndStyle (

void

): array

Resolve the border width and style

Exceptions

_getCurrentOptionIndices()

protected SetaPDF_FormFiller_Field_List::_getCurrentOptionIndices (

void

): array

Gets the indices of the currently selected options.

Exceptions

): SetaPDF_Core_Type_Dictionary_Entry

See

SetaPDF_FormFiller_Field_List::recreateAppearance()

_getFontRelation()

protected SetaPDF_FormFiller_Field_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

_getTDictionary()

protected SetaPDF_FormFiller_Field_AbstractField::_getTDictionary (

void

): bool|SetaPDF_Core_Type_Dictionary

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

_postDelete()

protected SetaPDF_FormFiller_Field_AbstractField::_postDelete (

void

): void

A method called after deleting a field.

This method forwards the deletion info to the fields instance.

_preDelete()

protected SetaPDF_FormFiller_Field_AbstractField::_preDelete (

void

): void

A method called before deleting a field.

This method forwards the deletion info to the fields instance.

Exceptions

_preFlatten()

protected SetaPDF_FormFiller_Field_AbstractField::_preFlatten (

void

): void

A method called before flattening a field.

This method forwards the flatten info to the fields instance.

Exceptions

_recreateAppearance()

protected SetaPDF_FormFiller_Field_AbstractField::_recreateAppearance (

[ bool $circle = false [, null|SetaPDF_Core_Canvas $canvas = null ]]

): SetaPDF_Core_Canvas

Recreate or creates the background appearance of the form field.

Parameters

$circle : bool
$canvas : null|SetaPDF_Core_Canvas

Exceptions

cleanUp()

public SetaPDF_FormFiller_Field_Choice_AbstractChoice::cleanUp (

void

): void

Release cycled references and release memory.

delete()

public SetaPDF_FormFiller_Field_AbstractField::delete (

void

): void

Delete the field.

Exceptions

flatten()

public SetaPDF_FormFiller_Field_AbstractField::flatten (

[ boolean $recreateAppearanceIfNeedAppearancesIsSet = false ]

): void

Flatten the field to the pages content stream.

Parameters

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

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

): SetaPDF_FormFiller_Field_AdditionalActions

See

SetaPDF_FormFiller_Field_AbstractField::delete()

getAdditionalActions()

public SetaPDF_FormFiller_Field_Choice_AbstractChoice::getAdditionalActions (

void

Gets the additional actions object instance for this field.

getAnnotation()

public SetaPDF_FormFiller_Field_AbstractField::getAnnotation (

void

): SetaPDF_Core_Document_Page_Annotation_Widget

Get the widget annotation object from this field.

Exceptions

getAppearanceCanvas()

public SetaPDF_FormFiller_Field_AbstractField::getAppearanceCanvas (

void

): SetaPDF_Core_Canvas

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

Exceptions

): SetaPDF_Core_Font_FontInterface

getAppearanceFont()

public SetaPDF_FormFiller_Field_AbstractField::getAppearanceFont (

void

Get the appearance font object.

Exceptions

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Type_IndirectReference_Exception

getAppearanceFontSize()

public SetaPDF_FormFiller_Field_AbstractField::getAppearanceFontSize (

void

): float|null

Get the appearance font size.

Exceptions

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

): SetaPDF_Core_DataStructure_Color

getAppearanceTextColor()

public SetaPDF_FormFiller_Field_AbstractField::getAppearanceTextColor (

void

Get the individual appearance text color.

Exceptions

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

): SetaPDF_FormFiller_Field_DefaultAppearanceData

getAppearanceTextColorSpace()

public SetaPDF_FormFiller_Field_AbstractField::getAppearanceTextColorSpace (

void

): null|SetaPDF_Core_ColorSpace

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

getDefaultAppearanceData()

public SetaPDF_FormFiller_Field_AbstractField::getDefaultAppearanceData (

void

Get the default appearance data of the DA value.

Exceptions

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

getDefaultValue()

public SetaPDF_FormFiller_Field_List::getDefaultValue (

[ string $encoding = 'UTF-8' ]

): null|array|string

Returns the default value(s) of the field.

This value is used if the form is reset

Parameters

$encoding : string: The output encoding

Exceptions

): SetaPDF_Core_Type_Dictionary

See

SetaPDF_FormFiller_Field_FieldInterface::getDefaultValue()

getFieldDictionary()

public SetaPDF_FormFiller_Field_AbstractField::getFieldDictionary (

void

Get the field dictionary.

getFieldFlags()

public SetaPDF_FormFiller_Field_AbstractField::getFieldFlags (

void

): integer

Returns the current field flags.

getFieldObject()

public SetaPDF_FormFiller_Field_AbstractField::getFieldObject (

void

): SetaPDF_Core_Type_IndirectObject

Get the indirect object of the form field.

getFields()

public SetaPDF_FormFiller_Field_AbstractField::getFields (

void

): SetaPDF_FormFiller_Fields

Get the fields instance.

getLineHeightFactor()

public SetaPDF_FormFiller_Field_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 SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Type_IndirectReference_Exception

): SetaPDF_Core_Type_IndirectObject

See

SetaPDF_FormFiller_Field_AbstractField::setLineHeightFactor()

getName()

public SetaPDF_FormFiller_Field_AbstractField::getName (

void

): string

Alias for getQualifiedName().

See

SetaPDF_FormFiller_Field_AbstractField::getQualifiedName()

getNoExport()

public SetaPDF_FormFiller_Field_AbstractField::getNoExport (

void

): boolean

Checks if the no-export flag is set.

getNormalAppearanceObject()

public SetaPDF_FormFiller_Field_AbstractField::getNormalAppearanceObject (

[ boolean $createNew = false ]

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

Parameters

$createNew : boolean: Pass true to force a recreation

Exceptions

getOptions()

public SetaPDF_FormFiller_Field_Choice_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

getOriginalQualifiedName()

public SetaPDF_FormFiller_Field_AbstractField::getOriginalQualifiedName (

void

): string

Get the original qualified name (without suffix).

getPage()

public SetaPDF_FormFiller_Field_AbstractField::getPage (

void

): SetaPDF_Core_Document_Page

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

Exceptions

getPageNumber()

public SetaPDF_FormFiller_Field_AbstractField::getPageNumber (

void

): integer

Get the page number on which the field appears.

Exceptions

Throws SetaPDF_Core_Document_ObjectNotDefinedException

Throws SetaPDF_Core_Document_ObjectNotFoundException

getQualifiedName()

public SetaPDF_FormFiller_Field_AbstractField::getQualifiedName (

void

): string

Returns the qualified name.

getTooltip()

public SetaPDF_FormFiller_Field_AbstractField::getTooltip (

[ string $encoding = 'UTF-8' ]

): bool|string

Get the tooltip value.

Parameters

$encoding : string

getValue()

public SetaPDF_FormFiller_Field_List::getValue (

[ string $encoding = 'UTF-8' ]

): string|array|null

Get the current value(s).

If the field is a multi select field, this method will return an array. If not it will return a string

Parameters

$encoding : string: The output encoding

Return Values

If no option is selected and the multi select flag is not set the method will return null. If the flag is set an empty array. Otherwise, the active value or the active values in an array.

Exceptions

getVisibleValue()

public SetaPDF_FormFiller_Field_List::getVisibleValue (

[ string $encoding = 'UTF-8' ]

): string|array

Get the current visible value(s).

If the field is a multi select field, this method will return an array. If not it will return a string

Parameters

$encoding : string: The output encoding

Exceptions

isFieldFlagSet()

public SetaPDF_FormFiller_Field_AbstractField::isFieldFlagSet (

integer $flag

): boolean

Checks if a specific field flag is set.

Parameters

$flag : integer

isMultiSelect()

public SetaPDF_FormFiller_Field_List::isMultiSelect (

void

): boolean

Checks if the field is a multi select field.

isReadOnly()

public SetaPDF_FormFiller_Field_AbstractField::isReadOnly (

void

): boolean

Checks if the field is set to read-only.

isRequired()

public SetaPDF_FormFiller_Field_AbstractField::isRequired (

void

): boolean

Checks if the field is set to be required.

recreateAppearance()

public SetaPDF_FormFiller_Field_List::recreateAppearance (

void

): void

Recreate or creates the Appearance of the form field.

Exceptions

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Type_IndirectReference_Exception

See

SetaPDF_FormFiller_Field_FieldInterface::recreateAppearance()

setAppearanceFont()

public SetaPDF_FormFiller_Field_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 SetaPDF_FormFiller_Field_AbstractField::setAppearanceFontSize (

float|null $fontSize

): void

Set an individual font size.

Parameters

$fontSize : float|null

setAppearanceTextColor()

public SetaPDF_FormFiller_Field_AbstractField::setAppearanceTextColor (

[ SetaPDF_Core_DataStructure_Color $textColor = null ]

): void

Set an individual appearance text color.

Parameters

$textColor : SetaPDF_Core_DataStructure_Color

setAppearanceTextColorSpace()

public SetaPDF_FormFiller_Field_AbstractField::setAppearanceTextColorSpace (

[ SetaPDF_Core_ColorSpace|null $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|null

setDefaultValue()

public SetaPDF_FormFiller_Field_List::setDefaultValue (

mixed $value [, string $encoding = 'UTF-8' ]

): void

Set the default value.

Parameters

$value : mixed
$encoding : string

Exceptions

setFieldFlags()

public SetaPDF_FormFiller_Field_AbstractField::setFieldFlags (

integer $flags [, boolean|null $add = true ]

): void

Sets a field flag.

Parameters

$flags : integer
$add : boolean|null: Add = true, remove = false, set = null

setLineHeightFactor()

public SetaPDF_FormFiller_Field_AbstractField::setLineHeightFactor (

null|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 : null|float

See

SetaPDF_FormFiller_Field_AbstractField::getLineHeightFactor()

setMultiSelect()

public SetaPDF_FormFiller_Field_List::setMultiSelect (

[ boolean $multiSelect = true ]

): void

Sets if the field is a multi select field.

Parameters

$multiSelect : boolean

Exceptions

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Type_IndirectReference_Exception

setNoExport()

public SetaPDF_FormFiller_Field_AbstractField::setNoExport (

[ boolean $noExport = true ]

): void

Set the no-export flag.

Parameters

$noExport : boolean

setReadOnly()

public SetaPDF_FormFiller_Field_AbstractField::setReadOnly (

[ boolean $readOnly = true ]

): void

Sets the read-only flag.

Parameters

$readOnly : boolean

Exceptions

Throws DOMException

Throws SetaPDF_Exception

setRequired()

public SetaPDF_FormFiller_Field_AbstractField::setRequired (

[ boolean $required = true ]

): void

Sets the required flag.

Parameters

$required : boolean

setTooltip()

public SetaPDF_FormFiller_Field_AbstractField::setTooltip (

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

): void

Set the tooltip value.

Parameters

$value : string|false
$encoding : string

setValue()

public SetaPDF_FormFiller_Field_List::setValue (

mixed $value [, string $encoding = 'UTF-8' ]

): void

Set the fields value / Selects the options.

Parameters

$value : mixed: The value could be an export value of an option or the numeric index of an option, received by getOptions(). Also an array of this values could be passed if the field is marked as a MultiSelect field
$encoding : string: The input encoding

Exceptions

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Type_IndirectReference_Exception