Package com.lowagie.text.pdf
Class AcroFields
java.lang.Object
com.lowagie.text.pdf.AcroFields
Query and change fields in existing documents either by method calls or by FDF merging.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
static class
The field representations for retrieval and modification.private static class
private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private static final PdfName[]
static final int
static final int
static final int
private float
private float
static final int
A field type.static final int
A field type.static final int
A field type.static final int
A field type invalid or not found.static final int
A field type.static final int
A field type.static final int
A field type.static final int
A field type.Holds value of property fieldCache.private Map
<String, AcroFields.Item> private boolean
Holds value of property generateAppearances.private boolean
(package private) PdfReader
private HashMap
<String, SignatureType> private int
private int
Holds value of property totalRevisions.(package private) PdfWriter
private XfaForm
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addSubstitutionFont
(BaseFont font) Adds a substitution font to the list.private void
Set font encoding from DR-structure if font doesn't have this info itselfvoid
decodeGenericDictionary
(PdfDictionary merged, BaseField tx) void
exportAsFdf
(FdfWriter writer) Export the fields as a FDF.extractRevision
(String field) Extracts a revision from the document.(package private) void
fill()
Gets all the fields.Gets the list of substitution fonts.(package private) PdfAppearance
getAppearance
(PdfDictionary merged, String[] values, String fieldName) (package private) PdfAppearance
getAppearance
(PdfDictionary merged, String text, String fieldName) String[]
getAppearanceNames
(String fieldName, int idx) Returns the names of the N-appearance dictionariesString[]
getAppearanceStates
(String fieldName) Gets the list of appearance names.Gets the field value.Gets the appearances cache.getFieldItem
(String name) Gets the field structure.Gets the field names that have blank signatures.float[]
getFieldPositions
(String name) Gets the field box positions in the document.getFieldProperty
(String field, String name, int idx) Gets a field property.int
getFieldType
(String fieldName) Gets the field type.private String[]
getListOption
(String fieldName, int idx) 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.(package private) Color
getMKColor
(PdfArray ar) getNewPushbuttonFromField
(String field) Creates a new pushbutton from an existing field.getNewPushbuttonFromField
(String field, int order) Creates a new pushbutton from an existing field.int
getRevision
(String field) Gets thisfield
revision.getSignatureDictionary
(String name) Gets the signature dictionary, the one keyed by /V.Method to differentiate the signed signatures types contained in a document.Gets the field names that have signatures and are signed.int
Gets the total number of revisions this document has.getTranslatedFieldName
(String name) Gets the long XFA translated name.getXfa()
Gets the XFA form processor.boolean
isAppend()
Indicates whether the stamper is in append mode or notboolean
Gets the property generateAppearances.(package private) boolean
isInAP
(PdfDictionary dic, PdfName check) void
Indicate that a PDF object has just been added.void
mergeXfaData
(Node n) Merges an XML data structure into this form.static Color
parseColor
(PdfArray pdfColor) Parses and converts colors from PDF to standard AWT Colors.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 frompage
.private int
removeRefFromArray
(PdfArray array, PdfObject refo) void
Removes the XFA stream from the documentboolean
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
Sets the field value.boolean
Sets the field value and the display string.void
setFieldCacheMap
(Map<String, BaseField> fieldCache) Sets a cache for field appearances.boolean
setFieldProperty
(AcroFields.Item item, String name, int value, int[] inst) Sets a field property.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
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.boolean
Checks is the signature covers the entire document or just part of it.static Object[]
private void
updateByteRange
(PdfPKCS7 pkcs7, PdfDictionary v) verifySignature
(String name) Verifies a signature.verifySignature
(String name, String provider) Verifies a signature.
-
Field Details
-
DA_FONT
public static final int DA_FONT- See Also:
-
DA_SIZE
public static final int DA_SIZE- See Also:
-
DA_COLOR
public static final int DA_COLOR- See Also:
-
FIELD_TYPE_NONE
public static final int FIELD_TYPE_NONEA field type invalid or not found.- See Also:
-
FIELD_TYPE_PUSHBUTTON
public static final int FIELD_TYPE_PUSHBUTTONA field type.- See Also:
-
FIELD_TYPE_CHECKBOX
public static final int FIELD_TYPE_CHECKBOXA field type.- See Also:
-
FIELD_TYPE_RADIOBUTTON
public static final int FIELD_TYPE_RADIOBUTTONA field type.- See Also:
-
FIELD_TYPE_TEXT
public static final int FIELD_TYPE_TEXTA field type.- See Also:
-
FIELD_TYPE_LIST
public static final int FIELD_TYPE_LISTA field type.- See Also:
-
FIELD_TYPE_COMBO
public static final int FIELD_TYPE_COMBOA field type.- See Also:
-
FIELD_TYPE_SIGNATURE
public static final int FIELD_TYPE_SIGNATUREA field type.- See Also:
-
stdFieldFontNames
-
buttonRemove
-
extensionFonts
-
localFonts
-
reader
PdfReader reader -
writer
PdfWriter writer -
fields
-
topFirst
private int topFirst -
sigNames
-
sigTypes
-
append
private boolean append -
xfa
-
lastWasString
private boolean lastWasString -
generateAppearances
private boolean generateAppearancesHolds value of property generateAppearances. -
extraMarginLeft
private float extraMarginLeft -
extraMarginTop
private float extraMarginTop -
substitutionFonts
-
totalRevisions
private int totalRevisionsHolds value of property totalRevisions. -
fieldCache
Holds value of property fieldCache.- Since:
- 2.1.5 this used to be a HashMap
-
-
Constructor Details
-
AcroFields
-
-
Method Details
-
splitDAelements
-
parseColor
Parses and converts colors from PDF to standard AWT Colors.- Parameters:
pdfColor
- an array of colors- Returns:
- AWT-Color
-
fill
void fill() -
getAppearanceStates
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
-
getAppearanceNames
Returns the names of the N-appearance dictionaries- Parameters:
fieldName
- name of the form fieldidx
- widget index- Returns:
- String[] of appearance names or null if the field can not be found
-
getListOption
-
getListOptionExport
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 returnnull
.- Parameters:
fieldName
- the field name- Returns:
- the list of export option values from fields of type list or combo
-
getListOptionDisplay
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 returnnull
.- Parameters:
fieldName
- the field name- Returns:
- the list of export option values from fields of type list or combo
-
setListOption
Sets the option list for fields of type list or combo. One ofexportValues
ordisplayValues
may benull
but not both. This method will only set the list but will not set the value or appearance. For that, callingsetField()
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 nameexportValues
- the export valuesdisplayValues
- the display values- Returns:
true
if the operation succeeded,false
otherwise
-
getFieldType
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
orFIELD_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
Export the fields as a FDF.- Parameters:
writer
- the FDF writer
-
renameField
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 namenewName
- the new field name- Returns:
true
if the renaming was successful,false
otherwise
-
decodeGenericDictionary
- Throws:
DocumentException
-
getAppearance
PdfAppearance getAppearance(PdfDictionary merged, String[] values, String fieldName) throws IOException, DocumentException - Throws:
IOException
DocumentException
-
adjustFontEncoding
Set font encoding from DR-structure if font doesn't have this info itself -
getAppearance
PdfAppearance getAppearance(PdfDictionary merged, String text, String fieldName) throws IOException, DocumentException - Throws:
IOException
DocumentException
-
getMKColor
-
getField
Gets the field value.- Parameters:
name
- the fully qualified field name- Returns:
- the field value
-
getListSelection
Gets the field values of a Choice field.- Parameters:
name
- the fully qualified field name- Returns:
- the field value
- Since:
- 2.1.3
-
setFieldProperty
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
. Ifnull
removes the background.
- bordercolor - sets the border color. The value for this entry is a
java.awt.Color
. Ifnull
removes the border.
- Parameters:
field
- the field namename
- the property namevalue
- the property valueinst
- an array ofint
indexing intoAcroField.Item.merged
elements to process. Set tonull
to process all- Returns:
true
if the property exists,false
otherwise
- textfont - sets the text font. The value for this entry is a
-
getFieldProperty
Gets a field property. Valid property names are:- textfont - gets the text font. The return value for this entry is a
String
.
- textcolor - gets the text color. The return value for this entry is a
java.awt.Color
.
- textsize - gets the text size. The return value for this entry is a
Float
. - textfontsall - gets all available fonts used in the PDF. The return value for this entry is a
Set<String>
with font names. - bgcolor - gets the background color. The return value for this entry is a
java.awt.Color
. - bordercolor - gets the border color. The return value for this entry is a
java.awt.Color
.
If the property does not exist null is returned.
- Parameters:
field
- - the field namename
- - the property nameidx
- - the index of the widget- Returns:
- the above described object or null if the property is not set
- textfont - gets the text font. The return value for this entry is a
-
setFieldProperty
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 namename
- the property namevalue
- the property valueinst
- an array ofint
indexing intoAcroField.Item.merged
elements to process. Set tonull
to process all- Returns:
true
if the property exists,false
otherwise
- 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.
-
setFieldProperty
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:
item
- of the fieldname
- the property namevalue
- the property valueinst
- an array ofint
indexing intoAcroField.Item.merged
elements to process. Set tonull
to process all- Returns:
true
if the property exists,false
otherwise
- 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.
-
mergeXfaData
Merges an XML data structure into this form.- Parameters:
n
- the top node of the data structure- Throws:
IOException
- on errorDocumentException
- o error
-
setFields
Sets the fields by FDF merging.- Parameters:
fdf
- the FDF form- Throws:
IOException
- on errorDocumentException
- on error
-
setFields
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 errorDocumentException
- on error
-
setFields
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 errorDocumentException
- on error
-
regenerateField
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 errorDocumentException
- on error
-
setField
Sets the field value.- Parameters:
name
- the fully qualified field name or the partial name in the case of XFA formsvalue
- the field value- Returns:
true
if the field was found and changed,false
otherwise- Throws:
IOException
- on errorDocumentException
- 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 formsvalue
- the field valuedisplay
- the string that is used for the appearance. Ifnull
thevalue
parameter will be used- Returns:
true
if the field was found and changed,false
otherwise- Throws:
IOException
- on errorDocumentException
- on error
-
setListSelection
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 fieldvalue
- an array with values that need to be selected- Returns:
- true only if the field value was changed
- Throws:
IOException
- on errorDocumentException
- on error- Since:
- 2.1.4
-
isInAP
-
getAllFields
Gets all the fields. The fields are keyed by the fully qualified field name and the value is an instance ofAcroFields.Item
.- Returns:
- all the fields
-
getFieldItem
Gets the field structure.- Parameters:
name
- the name of the field- Returns:
- the field structure or
null
if the field does not exist
-
getTranslatedFieldName
Gets the long XFA translated name.- Parameters:
name
- the name of the field- Returns:
- the long field name
-
getFieldPositions
Gets the field box positions in the document. The return is an array offloat
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
-
removeRefFromArray
-
removeFieldsFromPage
public boolean removeFieldsFromPage(int page) Removes all the fields frompage
.- Parameters:
page
- the page to remove the fields from- Returns:
true
if any field was removed,false otherwise
-
removeField
Removes a field from the document. If page equals -1 all the fields with thisname
are removed from the document otherwise only the fields in that particular page are removed.- Parameters:
name
- the field namepage
- 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
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 istrue
.- Parameters:
generateAppearances
- the option to generate appearances
-
getSignedFieldNames
Gets the field names that have signatures and are signed.- Returns:
- the field names that have signatures and are signed
-
getSignatureTypes
Method to differentiate the signed signatures types contained in a document. Currently approval and certification signatures are supported. If a signature is not signed the type 'UNSIGNED' is used.- Returns:
HashMap<String, SignatureType>
a list of signature names with its types.
-
getFieldNamesWithBlankSignatures
Gets the field names that have blank signatures.- Returns:
- the field names that have blank signatures
-
getSignatureDictionary
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
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
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
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 nameprovider
- the provider ornull
for the default provider- Returns:
- a
PdfPKCS7
class to continue the verification
-
updateByteRange
-
markUsed
Indicate that a PDF object has just been added. If it is not in append mode the object will just be changed. In append mode a new object (with the same id) will be appended (cp. PDF incremental update).- Parameters:
obj
- which should be marked as 'used' (=dirty)
-
getTotalRevisions
public int getTotalRevisions()Gets the total number of revisions this document has.- Returns:
- the total number of revisions
-
getRevision
Gets thisfield
revision.- Parameters:
field
- the signature field name- Returns:
- the revision or zero if it's not a signature field
-
extractRevision
Extracts a revision from the document.- Parameters:
field
- the signature field name- Returns:
- an
InputStream
covering the revision. Returnsnull
if it's not a signature field - Throws:
IOException
- on error
-
isAppend
public boolean isAppend()Indicates whether the stamper is in append mode or not- Returns:
- true when everything is done in the append mode otherwise false
-
getFieldCacheMap
Gets the appearances cache.- Returns:
- the appearances cache
-
setFieldCacheMap
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 leftextraMarginTop
- the extra margin top
-
addSubstitutionFont
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
-
getAllSubstitutionFonts
Gets the list of substitution fonts. The list is composed ofBaseFont
and can benull
. The fonts in this list will be used if the original font doesn't contain the needed glyphs.- Returns:
- the list
-
setAllSubstitutionFonts
Sets a list of substitution fonts. The list is composed ofBaseFont
and can also benull
. The fonts in this list will be used if the original font doesn't contain the needed glyphs.- Parameters:
substitutionFonts
- the list
-
getXfa
Gets the XFA form processor.- Returns:
- the XFA form processor
-
removeXfa
public void removeXfa()Removes the XFA stream from the document -
getNewPushbuttonFromField
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 callreplacePushbuttonField(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
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 callreplacePushbuttonField(String, PdfFormField, int)
.- Parameters:
field
- the field name that should be a pushbuttonorder
- 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
Replaces the first field with a new pushbutton. The pushbutton can be created withgetNewPushbuttonFromField(String)
from the same document or it can be a generic PdfFormField of the type pushbutton.- Parameters:
field
- the field namebutton
- thePdfFormField
representing the pushbutton- Returns:
true
if the field was replaced,false
if the field was not a pushbutton
-
replacePushbuttonField
Replaces the designated field with a new pushbutton. The pushbutton can be created withgetNewPushbuttonFromField(String, int)
from the same document or it can be a generic PdfFormField of the type pushbutton.- Parameters:
field
- the field namebutton
- thePdfFormField
representing the pushbuttonorder
- 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
-