|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lowagie.text.pdf.AcroFields
public class AcroFields
Query and change fields in existing documents either by method calls or by FDF merging.
Nested Class Summary | |
---|---|
static class |
AcroFields.Item
The field representations for retrieval and modification. |
Field Summary | |
---|---|
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 | |
---|---|
void |
addSubstitutionFont(BaseFont font)
Adds a substitution font to the list. |
void |
exportAsFdf(FdfWriter writer)
Export the fields as a FDF. |
InputStream |
extractRevision(String field)
Extracts a revision from the document. |
String[] |
getAppearanceStates(String fieldName)
Gets the list of appearance names. |
ArrayList |
getBlankSignatureNames()
Gets the field names that have blank signatures. |
String |
getField(String name)
Gets the field value. |
HashMap |
getFieldCache()
Gets the appearances cache. |
AcroFields.Item |
getFieldItem(String name)
Gets the field structure. |
float[] |
getFieldPositions(String name)
Gets the field box positions in the document. |
HashMap |
getFields()
Gets all the fields. |
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. |
int |
getRevision(String field)
Gets this field revision. |
PdfDictionary |
getSignatureDictionary(String name)
Gets the signature dictionary, the one keyed by /V. |
ArrayList |
getSignatureNames()
Gets the field names that have signatures and are signed. |
ArrayList |
getSubstitutionFonts()
Gets the list of substitution fonts. |
int |
getTotalRevisions()
Gets the total number of revisions this document has. |
boolean |
isGenerateAppearances()
Gets the property generateAppearances. |
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. |
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(HashMap 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(XfdfReader xfdf)
Sets the fields by XFDF merging. |
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. |
void |
setSubstitutionFonts(ArrayList substitutionFonts)
Sets a list of substitution fonts. |
boolean |
signatureCoversWholeDocument(String name)
Checks is the signature covers the entire document or just part of it. |
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 |
---|
public static final int FIELD_TYPE_NONE
public static final int FIELD_TYPE_PUSHBUTTON
public static final int FIELD_TYPE_CHECKBOX
public static final int FIELD_TYPE_RADIOBUTTON
public static final int FIELD_TYPE_TEXT
public static final int FIELD_TYPE_LIST
public static final int FIELD_TYPE_COMBO
public static final int FIELD_TYPE_SIGNATURE
Method Detail |
---|
public String[] getAppearanceStates(String fieldName)
fieldName
- the fully qualified field name
null
if the field does not existpublic String[] getListOptionExport(String fieldName)
null
.
fieldName
- the field name
public String[] getListOptionDisplay(String fieldName)
null
.
fieldName
- the field name
public boolean setListOption(String fieldName, String[] exportValues, String[] displayValues)
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();
fieldName
- the field nameexportValues
- the export valuesdisplayValues
- the display values
true
if the operation succeeded, false
otherwisepublic int getFieldType(String fieldName)
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
.
fieldName
- the field name
public void exportAsFdf(FdfWriter writer)
writer
- the FDF writerpublic boolean renameField(String oldName, String newName)
oldName
- the old field namenewName
- the new field name
true
if the renaming was successful, false
otherwisepublic String getField(String name)
name
- the fully qualified field name
public boolean setFieldProperty(String field, String name, Object value, int[] inst)
BaseFont
.java.awt.Color
.Float
.
java.awt.Color
.
If null
removes the background.java.awt.Color
.
If null
removes the border.
field
- the field namename
- the property namevalue
- the property valueinst
- an array of int
indexing into AcroField.Item.merged
elements to process.
Set to null
to process all
true
if the property exists, false
otherwisepublic boolean setFieldProperty(String field, String name, int value, int[] inst)
field
- the field namename
- the property namevalue
- the property valueinst
- an array of int
indexing into AcroField.Item.merged
elements to process.
Set to null
to process all
true
if the property exists, false
otherwisepublic void setFields(FdfReader fdf) throws IOException, DocumentException
fdf
- the FDF form
IOException
- on error
DocumentException
- on errorpublic void setFields(XfdfReader xfdf) throws IOException, DocumentException
xfdf
- the XFDF form
IOException
- on error
DocumentException
- on errorpublic boolean setField(String name, String value) throws IOException, DocumentException
name
- the fully qualified field namevalue
- the field value
true
if the field was found and changed,
false
otherwise
IOException
- on error
DocumentException
- on errorpublic boolean setField(String name, String value, String display) throws IOException, DocumentException
name
- the fully qualified field namevalue
- the field valuedisplay
- the string that is used for the appearance
true
if the field was found and changed,
false
otherwise
IOException
- on error
DocumentException
- on errorpublic HashMap getFields()
AcroFields.Item
.
public AcroFields.Item getFieldItem(String name)
name
- the name of the field
null
if the field
does not existpublic float[] getFieldPositions(String name)
float
multiple of 5. For each of this groups the values are: [page, llx, lly, urx,
ury].
name
- the field name
null
if field does not existpublic boolean removeFieldsFromPage(int page)
page
.
page
- the page to remove the fields from
true
if any field was removed, false otherwise
public boolean removeField(String name, int page)
name
are removed from the document otherwise only the fields in
that particular page are removed.
name
- the field namepage
- the page to remove the field from or -1 to remove it from all the pages
true
if the field exists, false otherwise
public boolean removeField(String name)
name
- the field name
true
if the field exists, false otherwise
public boolean isGenerateAppearances()
public void setGenerateAppearances(boolean generateAppearances)
true
.
generateAppearances
- the option to generate appearancespublic ArrayList getSignatureNames()
public ArrayList getBlankSignatureNames()
public PdfDictionary getSignatureDictionary(String name)
name
- the field name
null
if the field is not
a signaturepublic boolean signatureCoversWholeDocument(String name)
name
- the signature field name
true
if the signature covers the entire document,
false
otherwisepublic PdfPKCS7 verifySignature(String name)
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]); }
name
- the signature field name
PdfPKCS7
class to continue the verificationpublic PdfPKCS7 verifySignature(String name, String provider)
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]); }
name
- the signature field nameprovider
- the provider or null
for the default provider
PdfPKCS7
class to continue the verificationpublic int getTotalRevisions()
public int getRevision(String field)
field
revision.
field
- the signature field name
public InputStream extractRevision(String field) throws IOException
field
- the signature field name
InputStream
covering the revision. Returns null
if
it's not a signature field
IOException
- on errorpublic HashMap getFieldCache()
public void setFieldCache(HashMap fieldCache)
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(); }
fieldCache
- an HasMap that will carry the cached appearancespublic void setExtraMargin(float extraMarginLeft, float extraMarginTop)
extraMarginLeft
- the extra marging leftextraMarginTop
- the extra margin toppublic void addSubstitutionFont(BaseFont font)
font
- the fontpublic ArrayList getSubstitutionFonts()
BaseFont
and can be null
. The fonts in this list will be used if the original
font doesn't contain the needed glyphs.
public void setSubstitutionFonts(ArrayList substitutionFonts)
BaseFont
and can also be null
. The fonts in this list will be used if the original
font doesn't contain the needed glyphs.
substitutionFonts
- the list
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |