Class SetaPDF_Merger_Collection_Schema_Field in SetaPDF v2 API Reference

Index

\SetaPDF
1. Merger
2. Merger
  1. Collection
  2. Collection
    1. Schema
    2. Schema
      1. Field

SetaPDF_Merger_Collection_Schema_Field Class representing a field in a schema.

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

Class hierarchy

SetaPDF_Merger_Collection_Schema_Field

Summary

Properties

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Merger_Collection_Schema_Field::$_dictionary

The fields dictionary.

Static Methods

create()

public static SetaPDF_Merger_Collection_Schema_Field::create (

string $fieldName, string $dataType [, string $encoding = 'UTF-8' ]

): SetaPDF_Merger_Collection_Schema_Field

Create a schema field by a name and data type.

Parameters

$fieldName : string
$dataType : string
$encoding : string

Methods

__construct()

public SetaPDF_Merger_Collection_Schema_Field::__construct (

SetaPDF_Core_Type_Dictionary $dictionary

)

The constructor.

Parameters

$dictionary : SetaPDF_Core_Type_Dictionary

getAllowEdit()

public SetaPDF_Merger_Collection_Schema_Field::getAllowEdit (

void

): boolean

Get a flag indicating whether the interactive PDF processor should provide support for editing the field value.

getDataType()

public SetaPDF_Merger_Collection_Schema_Field::getDataType (

void

): string

Get the data type.

getDictionary()

public SetaPDF_Merger_Collection_Schema_Field::getDictionary (

void

): SetaPDF_Core_Type_Dictionary

Get the fields dictionary.

getName()

public SetaPDF_Merger_Collection_Schema_Field::getName (

[ string $encoding = 'UTF-8' ]

): string

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

Parameters

$encoding : string

getOrder()

public SetaPDF_Merger_Collection_Schema_Field::getOrder (

void

): integer|null

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

getVisibility()

public SetaPDF_Merger_Collection_Schema_Field::getVisibility (

void

): boolean

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

setAllowEdit()

public SetaPDF_Merger_Collection_Schema_Field::setAllowEdit (

boolean $allowEdit

): SetaPDF_Merger_Collection_Schema_Field

Set a flag indicating whether the interactive PDF processor should provide support for editing the field value.

Parameters

$allowEdit : boolean

setDataType()

public SetaPDF_Merger_Collection_Schema_Field::setDataType (

string $dataType

): SetaPDF_Merger_Collection_Schema_Field

Set the data type.

Parameters

$dataType : string

setName()

public SetaPDF_Merger_Collection_Schema_Field::setName (

string $name [, string $encoding = 'UTF-8' ]

): SetaPDF_Merger_Collection_Schema_Field

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

Parameters

$name : string
$encoding : string

setOrder()

public SetaPDF_Merger_Collection_Schema_Field::setOrder (

integer $order

): SetaPDF_Merger_Collection_Schema_Field

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

public SetaPDF_Merger_Collection_Schema_Field::setVisibility (

boolean $visibility

): SetaPDF_Merger_Collection_Schema_Field

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

Parameters

$visibility : boolean