AcroFields (openpdf 1.3.17 API)

java.lang.Object
- com.lowagie.text.pdf.AcroFields

```
public class AcroFields
extends Object
```
Query and change fields in existing documents either by method calls or by FDF merging.

Author:

Paulo Soares (psoares@consiste.pt)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AcroFields.Item
The field representations for retrieval and modification.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AcroFields.Item` The field representations for retrieval and modification.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DA_COLOR`
`static int`	`DA_FONT`
`static int`	`DA_SIZE`
`static int`	`FIELD_TYPE_CHECKBOX` A field type.
`static int`	`FIELD_TYPE_COMBO` A field type.
`static int`	`FIELD_TYPE_LIST` A field type.
`static int`	`FIELD_TYPE_NONE` A field type invalid or not found.
`static int`	`FIELD_TYPE_PUSHBUTTON` A field type.
`static int`	`FIELD_TYPE_RADIOBUTTON` A field type.
`static int`	`FIELD_TYPE_SIGNATURE` A field type.
`static int`	`FIELD_TYPE_TEXT` A field type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addSubstitutionFont(BaseFont font)` Adds a substitution font to the list.
`void`	`decodeGenericDictionary(PdfDictionary merged, BaseField tx)`
`void`	`exportAsFdf(FdfWriter writer)` Export the fields as a FDF.
`InputStream`	`extractRevision(String field)` Extracts a revision from the document.
`Map<String,AcroFields.Item>`	`getAllFields()` Gets all the fields.
`List<BaseFont>`	`getAllSubstitutionFonts()` Gets the list of substitution fonts.
`String[]`	`getAppearanceStates(String fieldName)` Gets the list of appearance names.
`ArrayList`	`getBlankSignatureNames()` Deprecated. use `getFieldNamesWithBlankSignatures()`
`String`	`getField(String name)` Gets the field value.
`Map`	`getFieldCache()` Deprecated. use `getFieldCacheMap()`
`Map<String,BaseField>`	`getFieldCacheMap()` Gets the appearances cache.
`AcroFields.Item`	`getFieldItem(String name)` Gets the field structure.
`List<String>`	`getFieldNamesWithBlankSignatures()` Gets the field names that have blank signatures.
`float[]`	`getFieldPositions(String name)` Gets the field box positions in the document.
`HashMap`	`getFields()` Deprecated. use `getAllFields()`
`int`	`getFieldType(String fieldName)` Gets the field type.
`String[]`	`getListOptionDisplay(String fieldName)` Gets the list of display option values from fields of type list or combo.
`String[]`	`getListOptionExport(String fieldName)` Gets the list of export option values from fields of type list or combo.
`String[]`	`getListSelection(String name)` Gets the field values of a Choice field.
`PushbuttonField`	`getNewPushbuttonFromField(String field)` Creates a new pushbutton from an existing field.
`PushbuttonField`	`getNewPushbuttonFromField(String field, int order)` Creates a new pushbutton from an existing field.
`int`	`getRevision(String field)` Gets this `field` revision.
`PdfDictionary`	`getSignatureDictionary(String name)` Gets the signature dictionary, the one keyed by /V.
`ArrayList<String>`	`getSignatureNames()` Deprecated. user `getSignedFieldNames()`
`List<String>`	`getSignedFieldNames()` Gets the field names that have signatures and are signed.
`ArrayList`	`getSubstitutionFonts()` Deprecated. use `getAllSubstitutionFonts()`
`int`	`getTotalRevisions()` Gets the total number of revisions this document has.
`String`	`getTranslatedFieldName(String name)` Gets the long XFA translated name.
`XfaForm`	`getXfa()` Gets the XFA form processor.
`boolean`	`isGenerateAppearances()` Gets the property generateAppearances.
`void`	`mergeXfaData(Node n)` Merges an XML data structure into this form.
`boolean`	`regenerateField(String name)` Regenerates the field appearance.
`boolean`	`removeField(String name)` Removes a field from the document.
`boolean`	`removeField(String name, int page)` Removes a field from the document.
`boolean`	`removeFieldsFromPage(int page)` Removes all the fields from `page`.
`boolean`	`renameField(String oldName, String newName)` Renames a field.
`boolean`	`replacePushbuttonField(String field, PdfFormField button)` Replaces the first field with a new pushbutton.
`boolean`	`replacePushbuttonField(String field, PdfFormField button, int order)` Replaces the designated field with a new pushbutton.
`void`	`setAllSubstitutionFonts(List<BaseFont> substitutionFonts)` Sets a list of substitution fonts.
`void`	`setExtraMargin(float extraMarginLeft, float extraMarginTop)` Sets extra margins in text fields to better mimic the Acrobat layout.
`boolean`	`setField(String name, String value)` Sets the field value.
`boolean`	`setField(String name, String value, String display)` Sets the field value and the display string.
`void`	`setFieldCache(Map fieldCache)` Deprecated. use `setFieldCacheMap(Map)`
`void`	`setFieldCacheMap(Map<String,BaseField> fieldCache)` Sets a cache for field appearances.
`boolean`	`setFieldProperty(String field, String name, int value, int[] inst)` Sets a field property.
`boolean`	`setFieldProperty(String field, String name, Object value, int[] inst)` Sets a field property.
`void`	`setFields(FdfReader fdf)` Sets the fields by FDF merging.
`void`	`setFields(FieldReader fieldReader)` Allows merging the fields by a field reader.
`void`	`setFields(XfdfReader fieldReader)` Allows merging the fields by a field reader.
`void`	`setGenerateAppearances(boolean generateAppearances)` Sets the option to generate appearances.
`boolean`	`setListOption(String fieldName, String[] exportValues, String[] displayValues)` Sets the option list for fields of type list or combo.
`boolean`	`setListSelection(String name, String[] value)` Sets different values in a list selection.
`void`	`setSubstitutionFonts(ArrayList substitutionFonts)` Deprecated. use `setAllSubstitutionFonts(List)`
`boolean`	`signatureCoversWholeDocument(String name)` Checks is the signature covers the entire document or just part of it.
`static Object[]`	`splitDAelements(String da)`
`PdfPKCS7`	`verifySignature(String name)` Verifies a signature.
`PdfPKCS7`	`verifySignature(String name, String provider)` Verifies a signature.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DA_FONT
```
public static final int DA_FONT
```
    See Also:
    
    Constant Field Values
  - DA_SIZE
```
public static final int DA_SIZE
```
    See Also:
    
    Constant Field Values
  - DA_COLOR
```
public static final int DA_COLOR
```
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_NONE
```
public static final int FIELD_TYPE_NONE
```
    A field type invalid or not found.
    
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_PUSHBUTTON
```
public static final int FIELD_TYPE_PUSHBUTTON
```
    A field type.
    
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_CHECKBOX
```
public static final int FIELD_TYPE_CHECKBOX
```
    A field type.
    
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_RADIOBUTTON
```
public static final int FIELD_TYPE_RADIOBUTTON
```
    A field type.
    
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_TEXT
```
public static final int FIELD_TYPE_TEXT
```
    A field type.
    
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_LIST
```
public static final int FIELD_TYPE_LIST
```
    A field type.
    
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_COMBO
```
public static final int FIELD_TYPE_COMBO
```
    A field type.
    
    See Also:
    
    Constant Field Values
  - FIELD_TYPE_SIGNATURE
```
public static final int FIELD_TYPE_SIGNATURE
```
    A field type.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAppearanceStates
```
public String[] getAppearanceStates(String fieldName)
```
    Gets the list of appearance names. Use it to get the names allowed with radio and checkbox fields. If the /Opt key exists the values will also be included. The name 'Off' may also be valid even if not returned in the list.
    
    Parameters:
    
    fieldName - the fully qualified field name
    
    Returns:
    
    the list of names or null if the field does not exist
  - getListOptionExport
```
public String[] getListOptionExport(String fieldName)
```
    Gets the list of export option values from fields of type list or combo. If the field doesn't exist or the field type is not list or combo it will return null.
    
    Parameters:
    
    fieldName - the field name
    
    Returns:
    
    the list of export option values from fields of type list or combo
  - getListOptionDisplay
```
public String[] getListOptionDisplay(String fieldName)
```
    Gets the list of display option values from fields of type list or combo. If the field doesn't exist or the field type is not list or combo it will return null.
    
    Parameters:
    
    fieldName - the field name
    
    Returns:
    
    the list of export option values from fields of type list or combo
  - setListOption
```
public boolean setListOption(String fieldName,
                             String[] exportValues,
                             String[] displayValues)
```
    Sets the option list for fields of type list or combo. One of exportValues or displayValues may be null but not both. This method will only set the list but will not set the value or appearance. For that, calling setField() is required.
    An example:
```
 PdfReader pdf = new PdfReader("input.pdf"); PdfStamper stp = new PdfStamper(pdf, new FileOutputStream("output.pdf")); AcroFields af =
 stp.getAcroFields(); af.setListOption("ComboBox", new String[]{"a", "b", "c"}, new String[]{"first", "second", "third"});
 af.setField("ComboBox", "b"); stp.close();
 
```
    Parameters:
    
    fieldName - the field name
    
    exportValues - the export values
    
    displayValues - the display values
    
    Returns:
    
    true if the operation succeeded, false otherwise
  - getFieldType
```
public int getFieldType(String fieldName)
```
    Gets the field type. The type can be one of: FIELD_TYPE_PUSHBUTTON, FIELD_TYPE_CHECKBOX, FIELD_TYPE_RADIOBUTTON, FIELD_TYPE_TEXT, FIELD_TYPE_LIST, FIELD_TYPE_COMBO or FIELD_TYPE_SIGNATURE.
    If the field does not exist or is invalid it returns FIELD_TYPE_NONE.
    
    Parameters:
    
    fieldName - the field name
    
    Returns:
    
    the field type
  - exportAsFdf
```
public void exportAsFdf(FdfWriter writer)
```
    Export the fields as a FDF.
    
    Parameters:
    
    writer - the FDF writer
  - renameField
```
public boolean renameField(String oldName,
                           String newName)
```
    Renames a field. Only the last part of the name can be renamed. For example, if the original field is "ab.cd.ef" only the "ef" part can be renamed.
    
    Parameters:
    
    oldName - the old field name
    
    newName - the new field name
    
    Returns:
    
    true if the renaming was successful, false otherwise
  - splitDAelements
```
public static Object[] splitDAelements(String da)
```
  - decodeGenericDictionary
```
public void decodeGenericDictionary(PdfDictionary merged,
                                    BaseField tx)
                             throws DocumentException
```
    Throws:
    
    DocumentException
  - getField
```
public String getField(String name)
```
    Gets the field value.
    
    Parameters:
    
    name - the fully qualified field name
    
    Returns:
    
    the field value
  - getListSelection
```
public String[] getListSelection(String name)
```
    Gets the field values of a Choice field.
    
    Parameters:
    
    name - the fully qualified field name
    
    Returns:
    
    the field value
    
    Since:
    
    2.1.3
  - setFieldProperty
```
public boolean setFieldProperty(String field,
                                String name,
                                Object value,
                                int[] inst)
```
    Sets a field property. Valid property names are:
    - textfont - sets the text font. The value for this entry is a BaseFont.
    - textcolor - sets the text color. The value for this entry is a java.awt.Color.
    - textsize - sets the text size. The value for this entry is a Float.
    - bgcolor - sets the background color. The value for this entry is a java.awt.Color. If null removes the background.
    - bordercolor - sets the border color. The value for this entry is a java.awt.Color. If null removes the border.
    Parameters:
    
    field - the field name
    
    name - the property name
    
    value - the property value
    
    inst - an array of int indexing into AcroField.Item.merged elements to process. Set to null to process all
    
    Returns:
    
    true if the property exists, false otherwise
  - setFieldProperty
```
public boolean setFieldProperty(String field,
                                String name,
                                int value,
                                int[] inst)
```
    Sets a field property. Valid property names are:
    - flags - a set of flags specifying various characteristics of the field's widget annotation. The value of this entry replaces that of the F entry in the form's corresponding annotation dictionary.
    - setflags - a set of flags to be set (turned on) in the F entry of the form's corresponding widget annotation dictionary. Bits equal to 1 cause the corresponding bits in F to be set to 1.
    - clrflags - a set of flags to be cleared (turned off) in the F entry of the form's corresponding widget annotation dictionary. Bits equal to 1 cause the corresponding bits in F to be set to 0.
    - fflags - a set of flags specifying various characteristics of the field. The value of this entry replaces that of the Ff entry in the form's corresponding field dictionary.
    - setfflags - a set of flags to be set (turned on) in the Ff entry of the form's corresponding field dictionary. Bits equal to 1 cause the corresponding bits in Ff to be set to 1.
    - clrfflags - a set of flags to be cleared (turned off) in the Ff entry of the form's corresponding field dictionary. Bits equal to 1 cause the corresponding bits in Ff to be set to 0.
    Parameters:
    
    field - the field name
    
    name - the property name
    
    value - the property value
    
    inst - an array of int indexing into AcroField.Item.merged elements to process. Set to null to process all
    
    Returns:
    
    true if the property exists, false otherwise
  - mergeXfaData
```
public void mergeXfaData(Node n)
                  throws IOException,
                         DocumentException
```
    Merges an XML data structure into this form.
    
    Parameters:
    
    n - the top node of the data structure
    
    Throws:
    
    IOException - on error
    
    DocumentException - o error
  - setFields
```
public void setFields(FdfReader fdf)
               throws IOException,
                      DocumentException
```
    Sets the fields by FDF merging.
    
    Parameters:
    
    fdf - the FDF form
    
    Throws:
    
    IOException - on error
    
    DocumentException - on error
  - setFields
```
public void setFields(XfdfReader fieldReader)
               throws IOException,
                      DocumentException
```
    Allows merging the fields by a field reader. One use would be to set the fields by XFDF merging.
    
    Parameters:
    
    fieldReader - The fields to merge.
    
    Throws:
    
    IOException - on error
    
    DocumentException - on error
  - setFields
```
public void setFields(FieldReader fieldReader)
               throws IOException,
                      DocumentException
```
    Allows merging the fields by a field reader. One use would be to set the fields by XFDF merging.
    
    Parameters:
    
    fieldReader - The fields to merge.
    
    Throws:
    
    IOException - on error
    
    DocumentException - on error
  - regenerateField
```
public boolean regenerateField(String name)
                        throws IOException,
                               DocumentException
```
    Regenerates the field appearance. This is useful when you change a field property, but not its value, for instance form.setFieldProperty("f", "bgcolor", Color.BLUE, null); This won't have any effect, unless you use regenerateField("f") after changing the property.
    
    Parameters:
    
    name - the fully qualified field name or the partial name in the case of XFA forms
    
    Returns:
    
    true if the field was found and changed, false otherwise
    
    Throws:
    
    IOException - on error
    
    DocumentException - on error
  - setField
```
public boolean setField(String name,
                        String value)
                 throws IOException,
                        DocumentException
```
    Sets the field value.
    
    Parameters:
    
    name - the fully qualified field name or the partial name in the case of XFA forms
    
    value - the field value
    
    Returns:
    
    true if the field was found and changed, false otherwise
    
    Throws:
    
    IOException - on error
    
    DocumentException - on error
  - setField
```
public boolean setField(String name,
                        String value,
                        String display)
                 throws IOException,
                        DocumentException
```
    Sets the field value and the display string. The display string is used to build the appearance in the cases where the value is modified by Acrobat with JavaScript and the algorithm is known.
    
    Parameters:
    
    name - the fully qualified field name or the partial name in the case of XFA forms
    
    value - the field value
    
    display - the string that is used for the appearance. If null the value parameter will be used
    
    Returns:
    
    true if the field was found and changed, false otherwise
    
    Throws:
    
    IOException - on error
    
    DocumentException - on error
  - setListSelection
```
public boolean setListSelection(String name,
                                String[] value)
                         throws IOException,
                                DocumentException
```
    Sets different values in a list selection. No appearance is generated yet; nor does the code check if multiple select is allowed.
    
    Parameters:
    
    name - the name of the field
    
    value - an array with values that need to be selected
    
    Returns:
    
    true only if the field value was changed
    
    Throws:
    
    IOException - on error
    
    DocumentException - on error
    
    Since:
    
    2.1.4
  - getFields
```
@Deprecated
public HashMap getFields()
```
    Deprecated. use getAllFields()
    
    Gets all the fields. The fields are keyed by the fully qualified field name and the value is an instance of AcroFields.Item.
    
    Returns:
    
    all the fields
  - getAllFields
```
public Map<String,AcroFields.Item> getAllFields()
```
    Gets all the fields. The fields are keyed by the fully qualified field name and the value is an instance of AcroFields.Item.
    
    Returns:
    
    all the fields
  - getFieldItem
```
public AcroFields.Item getFieldItem(String name)
```
    Gets the field structure.
    
    Parameters:
    
    name - the name of the field
    
    Returns:
    
    the field structure or null if the field does not exist
  - getTranslatedFieldName
```
public String getTranslatedFieldName(String name)
```
    Gets the long XFA translated name.
    
    Parameters:
    
    name - the name of the field
    
    Returns:
    
    the long field name
  - getFieldPositions
```
public float[] getFieldPositions(String name)
```
    Gets the field box positions in the document. The return is an array of float multiple of 5. For each of this groups the values are: [page, llx, lly, urx, ury]. The coordinates have the page rotation in consideration.
    
    Parameters:
    
    name - the field name
    
    Returns:
    
    the positions or null if field does not exist
  - removeFieldsFromPage
```
public boolean removeFieldsFromPage(int page)
```
    Removes all the fields from page.
    
    Parameters:
    
    page - the page to remove the fields from
    
    Returns:
    
    true if any field was removed, false otherwise
  - removeField
```
public boolean removeField(String name,
                           int page)
```
    Removes a field from the document. If page equals -1 all the fields with this name are removed from the document otherwise only the fields in that particular page are removed.
    
    Parameters:
    
    name - the field name
    
    page - the page to remove the field from or -1 to remove it from all the pages
    
    Returns:
    
    true if the field exists, false otherwise
  - removeField
```
public boolean removeField(String name)
```
    Removes a field from the document.
    
    Parameters:
    
    name - the field name
    
    Returns:
    
    true if the field exists, false otherwise
  - isGenerateAppearances
```
public boolean isGenerateAppearances()
```
    Gets the property generateAppearances.
    
    Returns:
    
    the property generateAppearances
  - setGenerateAppearances
```
public void setGenerateAppearances(boolean generateAppearances)
```
    Sets the option to generate appearances. Not generating appearances will speed-up form filling but the results can be unexpected in Acrobat. Don't use it unless your environment is well controlled. The default is true.
    
    Parameters:
    
    generateAppearances - the option to generate appearances
  - getSignatureNames
```
@Deprecated
public ArrayList<String> getSignatureNames()
```
    Deprecated. user getSignedFieldNames()
    
    Gets the field names that have signatures and are signed.
    
    Returns:
    
    the field names that have signatures and are signed
  - getSignedFieldNames
```
public List<String> getSignedFieldNames()
```
    Gets the field names that have signatures and are signed.
    
    Returns:
    
    the field names that have signatures and are signed
  - getBlankSignatureNames
```
@Deprecated
public ArrayList getBlankSignatureNames()
```
    Deprecated. use getFieldNamesWithBlankSignatures()
    
    Gets the field names that have blank signatures.
    
    Returns:
    
    the field names that have blank signatures
  - getFieldNamesWithBlankSignatures
```
public List<String> getFieldNamesWithBlankSignatures()
```
    Gets the field names that have blank signatures.
    
    Returns:
    
    the field names that have blank signatures
  - getSignatureDictionary
```
public PdfDictionary getSignatureDictionary(String name)
```
    Gets the signature dictionary, the one keyed by /V.
    
    Parameters:
    
    name - the field name
    
    Returns:
    
    the signature dictionary keyed by /V or null if the field is not a signature
  - signatureCoversWholeDocument
```
public boolean signatureCoversWholeDocument(String name)
```
    Checks is the signature covers the entire document or just part of it.
    
    Parameters:
    
    name - the signature field name
    
    Returns:
    
    true if the signature covers the entire document, false otherwise
  - verifySignature
```
public PdfPKCS7 verifySignature(String name)
```
    Verifies a signature. An example usage is:
```
 KeyStore kall = PdfPKCS7.loadCacertsKeyStore();
 PdfReader reader = new PdfReader("my_signed_doc.pdf");
 AcroFields af = reader.getAcroFields();
 ArrayList names = af.getSignatureNames();
 for (int k = 0; k < names.size(); ++k) {
    String name = (String)names.get(k);
    System.out.println("Signature name: " + name);
    System.out.println("Signature covers whole document: " + af.signatureCoversWholeDocument(name));
    PdfPKCS7 pk = af.verifySignature(name);
    Calendar cal = pk.getSignDate();
    Certificate pkc[] = pk.getCertificates();
    System.out.println("Subject: " + PdfPKCS7.getSubjectFields(pk.getSigningCertificate()));
    System.out.println("Document modified: " + !pk.verify());
    Object fails[] = PdfPKCS7.verifyCertificates(pkc, kall, null, cal);
    if (fails == null)
        System.out.println("Certificates verified against the KeyStore");
    else
        System.out.println("Certificate failed: " + fails[1]);
 }
 
```
    Parameters:
    
    name - the signature field name
    
    Returns:
    
    a PdfPKCS7 class to continue the verification
  - verifySignature
```
public PdfPKCS7 verifySignature(String name,
                                String provider)
```
    Verifies a signature. An example usage is:
```
 KeyStore kall = PdfPKCS7.loadCacertsKeyStore();
 PdfReader reader = new PdfReader("my_signed_doc.pdf");
 AcroFields af = reader.getAcroFields();
 ArrayList names = af.getSignatureNames();
 for (int k = 0; k < names.size(); ++k) {
    String name = (String)names.get(k);
    System.out.println("Signature name: " + name);
    System.out.println("Signature covers whole document: " + af.signatureCoversWholeDocument(name));
    PdfPKCS7 pk = af.verifySignature(name);
    Calendar cal = pk.getSignDate();
    Certificate pkc[] = pk.getCertificates();
    System.out.println("Subject: " + PdfPKCS7.getSubjectFields(pk.getSigningCertificate()));
    System.out.println("Document modified: " + !pk.verify());
    Object fails[] = PdfPKCS7.verifyCertificates(pkc, kall, null, cal);
    if (fails == null)
        System.out.println("Certificates verified against the KeyStore");
    else
        System.out.println("Certificate failed: " + fails[1]);
 }
 
```
    Parameters:
    
    name - the signature field name
    
    provider - the provider or null for the default provider
    
    Returns:
    
    a PdfPKCS7 class to continue the verification
  - getTotalRevisions
```
public int getTotalRevisions()
```
    Gets the total number of revisions this document has.
    
    Returns:
    
    the total number of revisions
  - getRevision
```
public int getRevision(String field)
```
    Gets this field revision.
    
    Parameters:
    
    field - the signature field name
    
    Returns:
    
    the revision or zero if it's not a signature field
  - extractRevision
```
public InputStream extractRevision(String field)
                            throws IOException
```
    Extracts a revision from the document.
    
    Parameters:
    
    field - the signature field name
    
    Returns:
    
    an InputStream covering the revision. Returns null if it's not a signature field
    
    Throws:
    
    IOException - on error
  - getFieldCache
```
@Deprecated
public Map getFieldCache()
```
    Deprecated. use getFieldCacheMap()
    
    Gets the appearances cache.
    
    Returns:
    
    the appearances cache
    
    Since:
    
    2.1.5 this method used to return a HashMap
  - getFieldCacheMap
```
public Map<String,BaseField> getFieldCacheMap()
```
    Gets the appearances cache.
    
    Returns:
    
    the appearances cache
  - setFieldCache
```
@Deprecated
public void setFieldCache(Map fieldCache)
```
    Deprecated. use setFieldCacheMap(Map)
    Sets a cache for field appearances. Parsing the existing PDF to create a new TextField is time expensive. For those tasks that repeatedly fill the same PDF with different field values the use of the cache has dramatic speed advantages. An example usage:
```
 String pdfFile = ...;// the pdf file used as template
 ArrayList xfdfFiles = ...;// the xfdf file names
 ArrayList pdfOutFiles = ...;// the output file names, one for each element in xpdfFiles
 HashMap cache = new HashMap();// the appearances cache
 PdfReader originalReader = new PdfReader(pdfFile);
 for (int k = 0; k < xfdfFiles.size(); ++k) {
    PdfReader reader = new PdfReader(originalReader);
    XfdfReader xfdf = new XfdfReader((String)xfdfFiles.get(k));
    PdfStamper stp = new PdfStamper(reader, new FileOutputStream((String)pdfOutFiles.get(k)));
    AcroFields af = stp.getAcroFields();
    af.setFieldCache(cache);
    af.setFields(xfdf);
    stp.close();
 }
 
```
    Parameters:
    
    fieldCache - a Map that will carry the cached appearances
    
    Since:
    
    2.1.5 this method used to take a HashMap as parameter
  - setFieldCacheMap
```
public void setFieldCacheMap(Map<String,BaseField> fieldCache)
```
    Sets a cache for field appearances. Parsing the existing PDF to create a new TextField is time expensive. For those tasks that repeatedly fill the same PDF with different field values the use of the cache has dramatic speed advantages. An example usage:
```
 String pdfFile = ...;// the pdf file used as template
 ArrayList xfdfFiles = ...;// the xfdf file names
 ArrayList pdfOutFiles = ...;// the output file names, one for each element in xpdfFiles
 HashMap cache = new HashMap();// the appearances cache
 PdfReader originalReader = new PdfReader(pdfFile);
 for (int k = 0; k < xfdfFiles.size(); ++k) {
    PdfReader reader = new PdfReader(originalReader);
    XfdfReader xfdf = new XfdfReader((String)xfdfFiles.get(k));
    PdfStamper stp = new PdfStamper(reader, new FileOutputStream((String)pdfOutFiles.get(k)));
    AcroFields af = stp.getAcroFields();
    af.setFieldCache(cache);
    af.setFields(xfdf);
    stp.close();
 }
 
```
    Parameters:
    
    fieldCache - a Map that will carry the cached appearances
  - setExtraMargin
```
public void setExtraMargin(float extraMarginLeft,
                           float extraMarginTop)
```
    Sets extra margins in text fields to better mimic the Acrobat layout.
    
    Parameters:
    
    extraMarginLeft - the extra margin left
    
    extraMarginTop - the extra margin top
  - addSubstitutionFont
```
public void addSubstitutionFont(BaseFont font)
```
    Adds a substitution font to the list. The fonts in this list will be used if the original font doesn't contain the needed glyphs.
    
    Parameters:
    
    font - the font
  - getSubstitutionFonts
```
@Deprecated
public ArrayList getSubstitutionFonts()
```
    Deprecated. use getAllSubstitutionFonts()
    
    Gets the list of substitution fonts. The list is composed of BaseFont and can be null. The fonts in this list will be used if the original font doesn't contain the needed glyphs.
    
    Returns:
    
    the list
  - getAllSubstitutionFonts
```
public List<BaseFont> getAllSubstitutionFonts()
```
    Gets the list of substitution fonts. The list is composed of BaseFont and can be null. The fonts in this list will be used if the original font doesn't contain the needed glyphs.
    
    Returns:
    
    the list
  - setSubstitutionFonts
```
@Deprecated
public void setSubstitutionFonts(ArrayList substitutionFonts)
```
    Deprecated. use setAllSubstitutionFonts(List)
    
    Sets a list of substitution fonts. The list is composed of BaseFont and can also be null. The fonts in this list will be used if the original font doesn't contain the needed glyphs.
    
    Parameters:
    
    substitutionFonts - the list
  - setAllSubstitutionFonts
```
public void setAllSubstitutionFonts(List<BaseFont> substitutionFonts)
```
    Sets a list of substitution fonts. The list is composed of BaseFont and can also be null. The fonts in this list will be used if the original font doesn't contain the needed glyphs.
    
    Parameters:
    
    substitutionFonts - the list
  - getXfa
```
public XfaForm getXfa()
```
    Gets the XFA form processor.
    
    Returns:
    
    the XFA form processor
  - getNewPushbuttonFromField
```
public PushbuttonField getNewPushbuttonFromField(String field)
```
    Creates a new pushbutton from an existing field. If there are several pushbuttons with the same name only the first one is used. This pushbutton can be changed and be used to replace an existing one, with the same name or other name, as long is it is in the same document. To replace an existing pushbutton call replacePushbuttonField(String, PdfFormField).
    
    Parameters:
    
    field - the field name that should be a pushbutton
    
    Returns:
    
    a new pushbutton or null if the field is not a pushbutton
  - getNewPushbuttonFromField
```
public PushbuttonField getNewPushbuttonFromField(String field,
                                                 int order)
```
    Creates a new pushbutton from an existing field. This pushbutton can be changed and be used to replace an existing one, with the same name or other name, as long is it is in the same document. To replace an existing pushbutton call replacePushbuttonField(String, PdfFormField, int).
    
    Parameters:
    
    field - the field name that should be a pushbutton
    
    order - the field order in fields with same name
    
    Returns:
    
    a new pushbutton or null if the field is not a pushbutton
    
    Since:
    
    2.0.7
  - replacePushbuttonField
```
public boolean replacePushbuttonField(String field,
                                      PdfFormField button)
```
    Replaces the first field with a new pushbutton. The pushbutton can be created with getNewPushbuttonFromField(String) from the same document or it can be a generic PdfFormField of the type pushbutton.
    
    Parameters:
    
    field - the field name
    
    button - the PdfFormField representing the pushbutton
    
    Returns:
    
    true if the field was replaced, false if the field was not a pushbutton
  - replacePushbuttonField
```
public boolean replacePushbuttonField(String field,
                                      PdfFormField button,
                                      int order)
```
    Replaces the designated field with a new pushbutton. The pushbutton can be created with getNewPushbuttonFromField(String, int) from the same document or it can be a generic PdfFormField of the type pushbutton.
    
    Parameters:
    
    field - the field name
    
    button - the PdfFormField representing the pushbutton
    
    order - the field order in fields with same name
    
    Returns:
    
    true if the field was replaced, false if the field was not a pushbutton
    
    Since:
    
    2.0.7

Class AcroFields

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DA_FONT

DA_SIZE

DA_COLOR

FIELD_TYPE_NONE

FIELD_TYPE_PUSHBUTTON

FIELD_TYPE_CHECKBOX

FIELD_TYPE_RADIOBUTTON

FIELD_TYPE_TEXT

FIELD_TYPE_LIST

FIELD_TYPE_COMBO

FIELD_TYPE_SIGNATURE

Method Detail

getAppearanceStates

getListOptionExport

getListOptionDisplay

setListOption

getFieldType

exportAsFdf

renameField

splitDAelements

decodeGenericDictionary

getField

getListSelection

setFieldProperty

setFieldProperty

mergeXfaData

setFields

setFields

setFields

regenerateField

setField

setField

setListSelection

getFields

getAllFields

getFieldItem

getTranslatedFieldName

getFieldPositions

removeFieldsFromPage

removeField

removeField

isGenerateAppearances

setGenerateAppearances

getSignatureNames

getSignedFieldNames

getBlankSignatureNames

getFieldNamesWithBlankSignatures

getSignatureDictionary

signatureCoversWholeDocument

verifySignature

verifySignature

getTotalRevisions

getRevision

extractRevision

getFieldCache

getFieldCacheMap

setFieldCache

setFieldCacheMap

setExtraMargin

addSubstitutionFont

getSubstitutionFonts

getAllSubstitutionFonts

setSubstitutionFonts

setAllSubstitutionFonts

getXfa

getNewPushbuttonFromField

getNewPushbuttonFromField

replacePushbuttonField

replacePushbuttonField