Package com.aowagie.text.pdf
Class PdfAcroForm
- java.lang.Object
-
- com.aowagie.text.pdf.PdfObject
-
- com.aowagie.text.pdf.PdfDictionary
-
- com.aowagie.text.pdf.PdfAcroForm
-
public class PdfAcroForm extends PdfDictionary
Each PDF document can contain maximum 1 AcroForm.
-
-
Field Summary
Fields Modifier and Type Field Description private PdfArray
calculationOrder
This is an array containing the calculationorder of the fields.private PdfArray
documentFields
This is an array containing DocumentFields.private java.util.HashMap
fieldTemplates
This is a map containing FieldTemplates.private int
sigFlags
Contains the signature flags.private PdfWriter
writer
-
Fields inherited from class com.aowagie.text.pdf.PdfDictionary
CATALOG, hashMap, OUTLINES, PAGE
-
Fields inherited from class com.aowagie.text.pdf.PdfObject
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type
-
-
Constructor Summary
Constructors Constructor Description PdfAcroForm(PdfWriter writer)
Creates new PdfAcroForm
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addCalculationOrder(PdfFormField formField)
Adds an object to the calculationOrder.void
addDocumentField(PdfIndirectReference ref)
Adds documentFields.void
addFieldTemplates(java.util.HashMap ft)
Adds fieldTemplates.private void
addFormField(PdfFormField formField)
Adds a formfield to the AcroForm.private void
drawButton(PdfFormField button, java.lang.String caption, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
private void
drawCheckBoxAppearences(PdfFormField field, java.lang.String value, float llx, float lly, float urx, float ury)
private void
drawMultiLineOfText(PdfFormField field, java.lang.String text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
private void
drawRadioAppearences(PdfFormField field, java.lang.String value, float llx, float lly, float urx, float ury)
private void
drawSingleLineOfText(PdfFormField field, java.lang.String text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
boolean
isValid()
Checks if the Acroform is validprivate void
setButtonParams(PdfFormField button, int characteristics, java.lang.String name, java.lang.String value)
private void
setCheckBoxParams(PdfFormField field, java.lang.String name, java.lang.String value, boolean status, float llx, float lly, float urx, float ury)
private void
setChoiceParams(PdfFormField field, java.lang.String name, java.lang.String defaultValue, float llx, float lly, float urx, float ury)
void
setNeedAppearances(boolean value)
void
setSigFlags(int f)
Sets the signature flags.private void
setTextFieldParams(PdfFormField field, java.lang.String text, java.lang.String name, float llx, float lly, float urx, float ury)
-
Methods inherited from class com.aowagie.text.pdf.PdfDictionary
contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, remove, size, toPdf, toString
-
Methods inherited from class com.aowagie.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, setContent, setIndRef, type
-
-
-
-
Field Detail
-
writer
private final PdfWriter writer
-
fieldTemplates
private final java.util.HashMap fieldTemplates
This is a map containing FieldTemplates.
-
documentFields
private final PdfArray documentFields
This is an array containing DocumentFields.
-
calculationOrder
private final PdfArray calculationOrder
This is an array containing the calculationorder of the fields.
-
sigFlags
private int sigFlags
Contains the signature flags.
-
-
Constructor Detail
-
PdfAcroForm
public PdfAcroForm(PdfWriter writer)
Creates new PdfAcroForm- Parameters:
writer
- Writer to create
-
-
Method Detail
-
setNeedAppearances
public void setNeedAppearances(boolean value)
-
addFieldTemplates
public void addFieldTemplates(java.util.HashMap ft)
Adds fieldTemplates.- Parameters:
ft
- Map to set
-
addDocumentField
public void addDocumentField(PdfIndirectReference ref)
Adds documentFields.- Parameters:
ref
- Reference to set
-
isValid
public boolean isValid()
Checks if the Acroform is valid- Returns:
- true if the Acroform is valid
-
addCalculationOrder
public void addCalculationOrder(PdfFormField formField)
Adds an object to the calculationOrder.- Parameters:
formField
- FormField to set
-
setSigFlags
public void setSigFlags(int f)
Sets the signature flags.- Parameters:
f
- Flags to set
-
addFormField
private void addFormField(PdfFormField formField)
Adds a formfield to the AcroForm.- Parameters:
formField
-
-
setButtonParams
private void setButtonParams(PdfFormField button, int characteristics, java.lang.String name, java.lang.String value)
- Parameters:
button
-characteristics
-name
-value
-
-
drawButton
private void drawButton(PdfFormField button, java.lang.String caption, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
- Parameters:
button
-caption
-font
-fontSize
-llx
-lly
-urx
-ury
-
-
setTextFieldParams
private void setTextFieldParams(PdfFormField field, java.lang.String text, java.lang.String name, float llx, float lly, float urx, float ury)
- Parameters:
field
-text
-name
-llx
-lly
-urx
-ury
-
-
drawSingleLineOfText
private void drawSingleLineOfText(PdfFormField field, java.lang.String text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
- Parameters:
field
-text
-font
-fontSize
-llx
-lly
-urx
-ury
-
-
drawMultiLineOfText
private void drawMultiLineOfText(PdfFormField field, java.lang.String text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)
- Parameters:
field
-text
-font
-fontSize
-llx
-lly
-urx
-ury
-
-
setCheckBoxParams
private void setCheckBoxParams(PdfFormField field, java.lang.String name, java.lang.String value, boolean status, float llx, float lly, float urx, float ury)
- Parameters:
field
-name
-value
-status
-llx
-lly
-urx
-ury
-
-
drawCheckBoxAppearences
private void drawCheckBoxAppearences(PdfFormField field, java.lang.String value, float llx, float lly, float urx, float ury)
- Parameters:
field
-value
-llx
-lly
-urx
-ury
-
-
drawRadioAppearences
private void drawRadioAppearences(PdfFormField field, java.lang.String value, float llx, float lly, float urx, float ury)
- Parameters:
field
-value
-llx
-lly
-urx
-ury
-
-
setChoiceParams
private void setChoiceParams(PdfFormField field, java.lang.String name, java.lang.String defaultValue, float llx, float lly, float urx, float ury)
- Parameters:
field
-name
-defaultValue
-llx
-lly
-urx
-ury
-
-
-