|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.itextpdf.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.FieldPosition
A class representing a field position |
static class |
AcroFields.Item
The field representations for retrieval and modification. |
| Field Summary | |
|---|---|
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 | |
|---|---|
void |
addSubstitutionFont(BaseFont font)
Adds a substitution font to the list. |
boolean |
clearSignatureField(java.lang.String name)
Clears a signed field. |
void |
decodeGenericDictionary(PdfDictionary merged,
BaseField tx)
|
void |
exportAsFdf(FdfWriter writer)
Export the fields as a FDF. |
java.io.InputStream |
extractRevision(java.lang.String field)
Extracts a revision from the document. |
java.lang.String[] |
getAppearanceStates(java.lang.String fieldName)
Gets the list of appearance names. |
java.util.ArrayList<java.lang.String> |
getBlankSignatureNames()
Gets the field names that have blank signatures. |
java.lang.String |
getField(java.lang.String name)
Gets the field value. |
java.util.Map<java.lang.String,TextField> |
getFieldCache()
Gets the appearances cache. |
AcroFields.Item |
getFieldItem(java.lang.String name)
Gets the field structure. |
java.util.List<AcroFields.FieldPosition> |
getFieldPositions(java.lang.String name)
Gets the field box positions in the document. |
java.lang.String |
getFieldRichValue(java.lang.String name)
Retrieve the rich value for the given field |
java.util.Map<java.lang.String,AcroFields.Item> |
getFields()
Gets all the fields. |
int |
getFieldType(java.lang.String fieldName)
Gets the field type. |
java.lang.String[] |
getListOptionDisplay(java.lang.String fieldName)
Gets the list of display option values from fields of type list or combo. |
java.lang.String[] |
getListOptionExport(java.lang.String fieldName)
Gets the list of export option values from fields of type list or combo. |
java.lang.String[] |
getListSelection(java.lang.String name)
Gets the field values of a Choice field. |
PushbuttonField |
getNewPushbuttonFromField(java.lang.String field)
Creates a new pushbutton from an existing field. |
PushbuttonField |
getNewPushbuttonFromField(java.lang.String field,
int order)
Creates a new pushbutton from an existing field. |
int |
getRevision(java.lang.String field)
Gets this field revision. |
PdfDictionary |
getSignatureDictionary(java.lang.String name)
Gets the signature dictionary, the one keyed by /V. |
java.util.ArrayList<java.lang.String> |
getSignatureNames()
Gets the field names that have signatures and are signed. |
java.util.ArrayList<BaseFont> |
getSubstitutionFonts()
Gets the list of substitution fonts. |
int |
getTotalRevisions()
Gets the total number of revisions this document has. |
java.lang.String |
getTranslatedFieldName(java.lang.String name)
Gets the long XFA translated name. |
XfaForm |
getXfa()
Gets the XFA form processor. |
boolean |
isGenerateAppearances()
Gets the property generateAppearances. |
void |
mergeXfaData(org.w3c.dom.Node n)
Merges an XML data structure into this form. |
boolean |
regenerateField(java.lang.String name)
Regenerates the field appearance. |
boolean |
removeField(java.lang.String name)
Removes a field from the document. |
boolean |
removeField(java.lang.String name,
int page)
Removes a field from the document. |
boolean |
removeFieldsFromPage(int page)
Removes all the fields from page. |
void |
removeXfa()
Removes the XFA stream from the document. |
boolean |
renameField(java.lang.String oldName,
java.lang.String newName)
Renames a field. |
boolean |
replacePushbuttonField(java.lang.String field,
PdfFormField button)
Replaces the first field with a new pushbutton. |
boolean |
replacePushbuttonField(java.lang.String field,
PdfFormField button,
int order)
Replaces the designated field with a new pushbutton. |
void |
setExtraMargin(float extraMarginLeft,
float extraMarginTop)
Sets extra margins in text fields to better mimic the Acrobat layout. |
boolean |
setField(java.lang.String name,
java.lang.String value)
Sets the field value. |
boolean |
setField(java.lang.String name,
java.lang.String value,
java.lang.String display)
Sets the field value and the display string. |
void |
setFieldCache(java.util.Map<java.lang.String,TextField> fieldCache)
Sets a cache for field appearances. |
boolean |
setFieldProperty(java.lang.String field,
java.lang.String name,
int value,
int[] inst)
Sets a field property. |
boolean |
setFieldProperty(java.lang.String field,
java.lang.String name,
java.lang.Object value,
int[] inst)
Sets a field property. |
boolean |
setFieldRichValue(java.lang.String name,
java.lang.String richValue)
Sets the rich value for the given field. |
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(java.lang.String fieldName,
java.lang.String[] exportValues,
java.lang.String[] displayValues)
Sets the option list for fields of type list or combo. |
boolean |
setListSelection(java.lang.String name,
java.lang.String[] value)
Sets different values in a list selection. |
void |
setSubstitutionFonts(java.util.ArrayList<BaseFont> substitutionFonts)
Sets a list of substitution fonts. |
boolean |
signatureCoversWholeDocument(java.lang.String name)
Checks is the signature covers the entire document or just part of it. |
static java.lang.Object[] |
splitDAelements(java.lang.String da)
|
PdfPKCS7 |
verifySignature(java.lang.String name)
Verifies a signature. |
PdfPKCS7 |
verifySignature(java.lang.String name,
java.lang.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 DA_FONT
public static final int DA_SIZE
public static final int DA_COLOR
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 java.lang.String[] getAppearanceStates(java.lang.String fieldName)
fieldName - the fully qualified field name
null if the field does not existpublic java.lang.String[] getListOptionExport(java.lang.String fieldName)
null.
fieldName - the field name
public java.lang.String[] getListOptionDisplay(java.lang.String fieldName)
null.
fieldName - the field name
public boolean setListOption(java.lang.String fieldName,
java.lang.String[] exportValues,
java.lang.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(java.lang.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 writer
public boolean renameField(java.lang.String oldName,
java.lang.String newName)
oldName - the old field namenewName - the new field name
true if the renaming was successful, false
otherwisepublic static java.lang.Object[] splitDAelements(java.lang.String da)
public void decodeGenericDictionary(PdfDictionary merged,
BaseField tx)
throws java.io.IOException,
DocumentException
java.io.IOException
DocumentExceptionpublic java.lang.String getFieldRichValue(java.lang.String name)
name -
public java.lang.String getField(java.lang.String name)
name - the fully qualified field name
public java.lang.String[] getListSelection(java.lang.String name)
name - the fully qualified field name
public boolean setFieldProperty(java.lang.String field,
java.lang.String name,
java.lang.Object value,
int[] inst)
BaseFont.BaseColor.Float.
BaseColor.
If null removes the background.BaseColor.
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 otherwise
public boolean setFieldProperty(java.lang.String field,
java.lang.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 otherwise
public void mergeXfaData(org.w3c.dom.Node n)
throws java.io.IOException,
DocumentException
n - the top node of the data structure
java.io.IOException - on error
DocumentException - o error
public void setFields(FdfReader fdf)
throws java.io.IOException,
DocumentException
fdf - the FDF form
java.io.IOException - on error
DocumentException - on error
public void setFields(XfdfReader xfdf)
throws java.io.IOException,
DocumentException
xfdf - the XFDF form
java.io.IOException - on error
DocumentException - on error
public boolean regenerateField(java.lang.String name)
throws java.io.IOException,
DocumentException
name - the fully qualified field name or the partial name in the case of XFA forms
true if the field was found and changed,
false otherwise
java.io.IOException - on error
DocumentException - on error
public boolean setField(java.lang.String name,
java.lang.String value)
throws java.io.IOException,
DocumentException
name - the fully qualified field name or the partial name in the case of XFA formsvalue - the field value
true if the field was found and changed,
false otherwise
java.io.IOException - on error
DocumentException - on error
public boolean setFieldRichValue(java.lang.String name,
java.lang.String richValue)
throws DocumentException,
java.io.IOException
name - Field namerichValue - html markup
DocumentException
java.io.IOException
public boolean setField(java.lang.String name,
java.lang.String value,
java.lang.String display)
throws java.io.IOException,
DocumentException
name - the fully qualified field name or the partial name in the case of XFA formsvalue - the field valuedisplay - the string that is used for the appearance. If null
the value parameter will be used
true if the field was found and changed,
false otherwise
java.io.IOException - on error
DocumentException - on error
public boolean setListSelection(java.lang.String name,
java.lang.String[] value)
throws java.io.IOException,
DocumentException
name - the name of the fieldvalue - an array with values that need to be selected
java.io.IOException
DocumentExceptionpublic java.util.Map<java.lang.String,AcroFields.Item> getFields()
AcroFields.Item.
public AcroFields.Item getFieldItem(java.lang.String name)
name - the name of the field
null if the field
does not existpublic java.lang.String getTranslatedFieldName(java.lang.String name)
name - the name of the field
public java.util.List<AcroFields.FieldPosition> getFieldPositions(java.lang.String name)
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.
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(java.lang.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 otherwisepublic boolean removeField(java.lang.String name)
name - the field name
true if the field exists, false otherwisepublic boolean isGenerateAppearances()
public void setGenerateAppearances(boolean generateAppearances)
true.
generateAppearances - the option to generate appearancespublic boolean clearSignatureField(java.lang.String name)
name - the field name
public java.util.ArrayList<java.lang.String> getSignatureNames()
public java.util.ArrayList<java.lang.String> getBlankSignatureNames()
public PdfDictionary getSignatureDictionary(java.lang.String name)
name - the field name
null if the field is not
a signaturepublic boolean signatureCoversWholeDocument(java.lang.String name)
name - the signature field name
true if the signature covers the entire document,
false otherwisepublic PdfPKCS7 verifySignature(java.lang.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 verification
public PdfPKCS7 verifySignature(java.lang.String name,
java.lang.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(java.lang.String field)
field revision.
field - the signature field name
public java.io.InputStream extractRevision(java.lang.String field)
throws java.io.IOException
field - the signature field name
InputStream covering the revision. Returns null if
it's not a signature field
java.io.IOException - on errorpublic java.util.Map<java.lang.String,TextField> getFieldCache()
public void setFieldCache(java.util.Map<java.lang.String,TextField> 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 - a Map that will carry the cached appearances
public void setExtraMargin(float extraMarginLeft,
float extraMarginTop)
extraMarginLeft - the extra margin leftextraMarginTop - the extra margin toppublic void addSubstitutionFont(BaseFont font)
font - the fontpublic java.util.ArrayList<BaseFont> 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(java.util.ArrayList<BaseFont> 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 listpublic XfaForm getXfa()
public void removeXfa()
public PushbuttonField getNewPushbuttonFromField(java.lang.String field)
replacePushbuttonField(String,PdfFormField).
field - the field name that should be a pushbutton
null if the field is not a pushbutton
public PushbuttonField getNewPushbuttonFromField(java.lang.String field,
int order)
replacePushbuttonField(String,PdfFormField,int).
field - the field name that should be a pushbuttonorder - the field order in fields with same name
null if the field is not a pushbutton
public boolean replacePushbuttonField(java.lang.String field,
PdfFormField button)
getNewPushbuttonFromField(String) from the same document or it can be a
generic PdfFormField of the type pushbutton.
field - the field namebutton - the PdfFormField representing the pushbutton
true if the field was replaced, false if the field
was not a pushbutton
public boolean replacePushbuttonField(java.lang.String field,
PdfFormField button,
int order)
getNewPushbuttonFromField(String,int) from the same document or it can be a
generic PdfFormField of the type pushbutton.
field - the field namebutton - the PdfFormField representing the pushbuttonorder - the field order in fields with same name
true if the field was replaced, false if the field
was not a pushbutton
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||