SetaPDF_Merger_Collection_Schema_Field Class representing a field in a schema.

File: /SetaPDF/Merger/Collection/Schema/Field.php

Class hierarchy

Summary

Properties


Static Methods

create()

static public SetaPDF_Merger_Collection_Schema_Field SetaPDF_Merger_Collection_Schema_Field::create ( string $fieldName, string $dataType [, string $encoding = 'UTF-8' ] )

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

Get the data type.

getDictionary()

getName()

public string SetaPDF_Merger_Collection_Schema_Field::getName ( [ string $encoding = 'UTF-8' ] )

Get the textual field name that shall be presented to the user by the interactive PDF processor.

Parameters
$encoding : string
 

getOrder()

public integer|null SetaPDF_Merger_Collection_Schema_Field::getOrder ( void )

Get the relative order of the field name in the user interface.

getVisibility()

Get the initial visibility of the field in the user interface.

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

public SetaPDF_Merger_Collection_Schema_Field SetaPDF_Merger_Collection_Schema_Field::setName ( string $name [, string $encoding = 'UTF-8' ] )

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