SetaPDF_FormFiller_Field_FieldInterface Field interface

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

Implemented in

Summary

Methods

cleanUp()

abstract public void SetaPDF_FormFiller_Field_FieldInterface::cleanUp ( void )

Release cycled references and release memory.

delete()

abstract public void SetaPDF_FormFiller_Field_FieldInterface::delete ( void )

Delete the form field.

flatten()

abstract public void SetaPDF_FormFiller_Field_FieldInterface::flatten ( void )

Flatten the form fields appearance to the pages content.

getDefaultValue()

abstract public mixed SetaPDF_FormFiller_Field_FieldInterface::getDefaultValue ( [ string $encoding = 'UTF-8' ] )

Returns the default value of the field.

This value is used if the form is reset

Parameters
$encoding : string
 

getNoExport()

abstract public boolean SetaPDF_FormFiller_Field_FieldInterface::getNoExport ( void )

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

This flag is not gettable or settable with Acrobat!

getOriginalQualifiedName()

abstract public string SetaPDF_FormFiller_Field_FieldInterface::getOriginalQualifiedName ( void )

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

getQualifiedName()

abstract public string SetaPDF_FormFiller_Field_FieldInterface::getQualifiedName ( void )

Returns the qualified name of the field.

getValue()

abstract public mixed SetaPDF_FormFiller_Field_FieldInterface::getValue ( void )

Returns the field specific value.

isReadOnly()

abstract public boolean SetaPDF_FormFiller_Field_FieldInterface::isReadOnly ( void )

Checks if a field is marked as read-only.

isRequired()

abstract public boolean SetaPDF_FormFiller_Field_FieldInterface::isRequired ( void )

Checks if a field is marked as required.

recreateAppearance()

abstract public void SetaPDF_FormFiller_Field_FieldInterface::recreateAppearance ( void )

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

setDefaultValue()

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

Set the default value of the field.

Parameters
$value : mixed
 
$encoding : string
 

setNoExport()

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

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 void SetaPDF_FormFiller_Field_FieldInterface::setReadOnly ( [ boolean $readOnly = true ] )

Sets a field to read-only or not.

Parameters
$readOnly : boolean
 

setRequired()

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

Sets a field to be required or not.

Parameters
$required : boolean
 

setValue()

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

Sets the fields value.

Parameters
$value : mixed