SetaPDF_Merger_Collection_Schema_Field Class representing a field in a schema.
File: /SetaPDF v2/Merger/Collection/Schema/Field.php
Class hierarchy
Summary
Properties
Static Methods
create()
Create a schema field by a name and data type.
Parameters
- $fieldName : string
- $dataType : string
- $encoding : string
Methods
__construct()
The constructor.
Parameters
- $dictionary : SetaPDF_Core_Type_Dictionary
getAllowEdit()
Get a flag indicating whether the interactive PDF processor should provide support for editing the field value.
getDataType()
getName()
Get the textual field name that shall be presented to the user by the interactive PDF processor.
Parameters
- $encoding : string
Exceptions
Throws SetaPDF_Core_Type_Exception
setAllowEdit()
Set a flag indicating whether the interactive PDF processor should provide support for editing the field value.
Parameters
- $allowEdit : boolean
setDataType()
Set the data type.
Parameters
- $dataType : string
setName()
Set the textual field name that shall be presented to the user by the interactive PDF processor.
Parameters
- $name : string
- $encoding : string
setOrder()
Set the relative order of the field name in the user interface.
If you set it, you should set this in all fields. Otherwise you will get an unexpected result in different PDF viewers.
Parameters
- $order : integer
setVisibility()
Set the initial visibility of the field in the user interface.
Parameters
- $visibility : boolean