Index

  1. \SetaPDF
    1. FormFiller
    2. FormFiller
      1. Field
        1. Choice
        2. AbstractField
        3. AdditionalActions
        4. AppearanceValueCallbackInterface
        5. Button
        6. ButtonGroup
        7. Combo
        8. DefaultAppearanceData
        9. Exception
        10. FieldInterface
        11. Flags
        12. Formatter
        13. List
        14. PushButton
        15. Signature
        16. Text

SetaPDF_FormFiller_Field_FieldInterface Field interface

File: /SetaPDF v2/FormFiller/Field/FieldInterface.php

Implemented in

Summary

Methods

Methods

cleanUp()

abstract public SetaPDF_FormFiller_Field_FieldInterface::cleanUp (
void
): void

Release cycled references and release memory.

delete()

abstract public SetaPDF_FormFiller_Field_FieldInterface::delete (
void
): void

Delete the form field.

flatten()

abstract public SetaPDF_FormFiller_Field_FieldInterface::flatten (
[ boolean $recreateAppearanceIfNeedAppearancesIsSet = false ]
): void

Flatten the form fields appearance to the pages content.

Parameters
$recreateAppearanceIfNeedAppearancesIsSet : boolean

Defines whether the field appearance is re-created if the NeedAppearances flag is set.

getDefaultValue()

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

getNoExport()

abstract public SetaPDF_FormFiller_Field_FieldInterface::getNoExport (
void
): boolean

Get the info, if the field is marked as "no export".

This flag is not gettable or settable with Acrobat!

getOriginalQualifiedName()

abstract public SetaPDF_FormFiller_Field_FieldInterface::getOriginalQualifiedName (
void
): string

Returns the original qualified name of the field (without suffix #n).

getQualifiedName()

abstract public SetaPDF_FormFiller_Field_FieldInterface::getQualifiedName (
void
): string

Returns the qualified name of the field.

getValue()

abstract public SetaPDF_FormFiller_Field_FieldInterface::getValue (
void
): mixed

Returns the field specific value.

isReadOnly()

abstract public SetaPDF_FormFiller_Field_FieldInterface::isReadOnly (
void
): boolean

Checks if a field is marked as read-only.

isRequired()

abstract public SetaPDF_FormFiller_Field_FieldInterface::isRequired (
void
): boolean

Checks if a field is marked as required.

recreateAppearance()

abstract public SetaPDF_FormFiller_Field_FieldInterface::recreateAppearance (
void
): void

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

setDefaultValue()

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

Set the default value of the field.

Parameters
$value : mixed
 
$encoding : string
 

setNoExport()

abstract public SetaPDF_FormFiller_Field_FieldInterface::setNoExport (
[ boolean $noExport = true ]
): void

Sets the "no export" flag.

This flag is not gettable or settable with Acrobat!

If you remove this flag, the element could be still not exported due to a definition in a FormSubmit actions Fields array.

Parameters
$noExport : boolean
 

setReadOnly()

abstract public SetaPDF_FormFiller_Field_FieldInterface::setReadOnly (
[ boolean $readOnly = true ]
): void

Sets a field to read-only or not.

Parameters
$readOnly : boolean
 

setRequired()

abstract public SetaPDF_FormFiller_Field_FieldInterface::setRequired (
[ boolean $required = true ]
): void

Sets a field to be required or not.

Parameters
$required : boolean
 

setValue()

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

Sets the fields value.

Parameters
$value : mixed
 

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