java.lang.Object
- com.lowagie.text.pdf.PdfObject
- - com.lowagie.text.pdf.PdfDictionary
  - - com.lowagie.text.pdf.PdfAcroForm

public class PdfAcroForm
extends PdfDictionary

Each PDF document can contain maximum 1 AcroForm.

Field Summary
- Fields inherited from class com.lowagie.text.pdf.PdfDictionary
  CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES
- Fields inherited from class com.lowagie.text.pdf.PdfObject
  ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, 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 Deprecated Methods
Modifier and Type	Method	Description
`void`	`addCalculationOrder(PdfFormField formField)`	Adds an object to the calculationOrder.
`PdfFormField`	`addCheckBox(String name, String value, boolean status, float llx, float lly, float urx, float ury)`
`PdfFormField`	`addComboBox(String name, String[][] options, String defaultValue, boolean editable, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`PdfFormField`	`addComboBox(String name, String[] options, String defaultValue, boolean editable, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`void`	`addDocumentField(PdfIndirectReference ref)`	Adds documentFields.
`void`	`addFieldTemplates(HashMap ft)`	Deprecated. use `addFieldTemplates(Map)`
`void`	`addFieldTemplates(Map<PdfTemplate,Object> ft)`	Adds fieldTemplates.
`void`	`addFormField(PdfFormField formField)`	Adds a formfield to the AcroForm.
`PdfFormField`	`addHiddenField(String name, String value)`
`PdfFormField`	`addHtmlPostButton(String name, String caption, String value, String url, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`PdfFormField`	`addMap(String name, String value, String url, PdfContentByte appearance, float llx, float lly, float urx, float ury)`
`PdfFormField`	`addMultiLineTextField(String name, String text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`PdfFormField`	`addRadioButton(PdfFormField radiogroup, String value, float llx, float lly, float urx, float ury)`
`void`	`addRadioGroup(PdfFormField radiogroup)`
`PdfFormField`	`addResetButton(String name, String caption, String value, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`PdfFormField`	`addSelectList(String name, String[][] options, String defaultValue, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`PdfFormField`	`addSelectList(String name, String[] options, String defaultValue, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`PdfFormField`	`addSignature(String name, float llx, float lly, float urx, float ury)`
`PdfFormField`	`addSingleLinePasswordField(String name, String text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`PdfFormField`	`addSingleLineTextField(String name, String text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`void`	`drawButton(PdfFormField button, String caption, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`void`	`drawCheckBoxAppearences(PdfFormField field, String value, float llx, float lly, float urx, float ury)`
`void`	`drawMultiLineOfText(PdfFormField field, String text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`void`	`drawRadioAppearences(PdfFormField field, String value, float llx, float lly, float urx, float ury)`
`void`	`drawSignatureAppearences(PdfFormField field, float llx, float lly, float urx, float ury)`
`void`	`drawSingleLineOfText(PdfFormField field, String text, BaseFont font, float fontSize, float llx, float lly, float urx, float ury)`
`PdfFormField`	`getRadioGroup(String name, String defaultValue, boolean noToggleToOff)`
`boolean`	`isValid()`	Checks if the Acroform is valid
`void`	`setButtonParams(PdfFormField button, int characteristics, String name, String value)`
`void`	`setCheckBoxParams(PdfFormField field, String name, String value, boolean status, float llx, float lly, float urx, float ury)`
`void`	`setChoiceParams(PdfFormField field, String name, String defaultValue, float llx, float lly, float urx, float ury)`
`void`	`setNeedAppearances(boolean value)`
`void`	`setSigFlags(int f)`	Sets the signature flags.
`void`	`setSignatureParams(PdfFormField field, String name, float llx, float lly, float urx, float ury)`
`void`	`setTextFieldParams(PdfFormField field, String text, String name, float llx, float lly, float urx, float ury)`

Methods inherited from class com.lowagie.text.pdf.PdfDictionary
contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString

Methods inherited from class com.lowagie.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type

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

Constructor Detail
- PdfAcroForm
```
public PdfAcroForm(PdfWriter writer)
```
  Creates new PdfAcroForm
  
  Parameters:
  
  writer - PdfWriter

Method Detail

setNeedAppearances

public void setNeedAppearances(boolean value)

addFieldTemplates
```
@Deprecated
public void addFieldTemplates(HashMap ft)
```
Deprecated.
use addFieldTemplates(Map)

Adds fieldTemplates.

Parameters:

ft - field templates

addFieldTemplates
```
public void addFieldTemplates(Map<PdfTemplate,Object> ft)
```
Adds fieldTemplates.

Parameters:

ft - field templates

addDocumentField
```
public void addDocumentField(PdfIndirectReference ref)
```
Adds documentFields.

Parameters:

ref - an object of PdfIndirectReference

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 - an object of PdfFormField

setSigFlags
```
public void setSigFlags(int f)
```
Sets the signature flags.

Parameters:

f - signature flag

addFormField
```
public void addFormField(PdfFormField formField)
```
Adds a formfield to the AcroForm.

Parameters:

formField - an object of PdfFormField

addHtmlPostButton

public PdfFormField addHtmlPostButton(String name,
                                      String caption,
                                      String value,
                                      String url,
                                      BaseFont font,
                                      float fontSize,
                                      float llx,
                                      float lly,
                                      float urx,
                                      float ury)

Parameters:: name - name of the field; value - value of the field; url - url for the action; caption - caption; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

addResetButton

public PdfFormField addResetButton(String name,
                                   String caption,
                                   String value,
                                   BaseFont font,
                                   float fontSize,
                                   float llx,
                                   float lly,
                                   float urx,
                                   float ury)

Parameters:: name - name of the field; value - value of the field; caption - caption; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

addMap

public PdfFormField addMap(String name,
                           String value,
                           String url,
                           PdfContentByte appearance,
                           float llx,
                           float lly,
                           float urx,
                           float ury)

Parameters:: name - name of the field; value - value of the field; url - url of the action; appearance - an object of PdfContentByte; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

setButtonParams

public void setButtonParams(PdfFormField button,
                            int characteristics,
                            String name,
                            String value)

Parameters:: button - an object of PdfFormField; characteristics - characteristics; name - name of the field; value - value of the field

drawButton

public void drawButton(PdfFormField button,
                       String caption,
                       BaseFont font,
                       float fontSize,
                       float llx,
                       float lly,
                       float urx,
                       float ury)

Parameters:: button - an object of PdfFormField; caption - caption; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y

addHiddenField

public PdfFormField addHiddenField(String name,
                                   String value)

Parameters:: name - name of the field; value - value of the field
Returns:: a PdfFormField

addSingleLineTextField

public PdfFormField addSingleLineTextField(String name,
                                           String text,
                                           BaseFont font,
                                           float fontSize,
                                           float llx,
                                           float lly,
                                           float urx,
                                           float ury)

Parameters:: name - name of the field; text - value for field; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

addMultiLineTextField

public PdfFormField addMultiLineTextField(String name,
                                          String text,
                                          BaseFont font,
                                          float fontSize,
                                          float llx,
                                          float lly,
                                          float urx,
                                          float ury)

Parameters:: name - name of the field; text - value for field; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

addSingleLinePasswordField

public PdfFormField addSingleLinePasswordField(String name,
                                               String text,
                                               BaseFont font,
                                               float fontSize,
                                               float llx,
                                               float lly,
                                               float urx,
                                               float ury)

Parameters:: name - name of the field; text - text for the field; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: PdfFormField

setTextFieldParams

public void setTextFieldParams(PdfFormField field,
                               String text,
                               String name,
                               float llx,
                               float lly,
                               float urx,
                               float ury)

Parameters:: field - an object of PdfFormField; text - text for the field; name - name of the field; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y

drawSingleLineOfText

public void drawSingleLineOfText(PdfFormField field,
                                 String text,
                                 BaseFont font,
                                 float fontSize,
                                 float llx,
                                 float lly,
                                 float urx,
                                 float ury)

Parameters:: field - field; text - text for the field; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y

drawMultiLineOfText

public void drawMultiLineOfText(PdfFormField field,
                                String text,
                                BaseFont font,
                                float fontSize,
                                float llx,
                                float lly,
                                float urx,
                                float ury)

Parameters:: field - field, an object of PdfFormField; text - text for field; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y

addCheckBox

public PdfFormField addCheckBox(String name,
                                String value,
                                boolean status,
                                float llx,
                                float lly,
                                float urx,
                                float ury)

Parameters:: name - field name; status - status; value - value of the field; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

setCheckBoxParams

public void setCheckBoxParams(PdfFormField field,
                              String name,
                              String value,
                              boolean status,
                              float llx,
                              float lly,
                              float urx,
                              float ury)

Parameters:: name - field name; status - status; field - field, an object of PdfFormField; value - value of the field; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y

drawCheckBoxAppearences

public void drawCheckBoxAppearences(PdfFormField field,
                                    String value,
                                    float llx,
                                    float lly,
                                    float urx,
                                    float ury)

Parameters:: field - field, an object of PdfFormField; value - value of the field; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y

getRadioGroup

public PdfFormField getRadioGroup(String name,
                                  String defaultValue,
                                  boolean noToggleToOff)

Parameters:: name - name of the field; defaultValue - default value; noToggleToOff - noToggleToOff
Returns:: a PdfFormField

addRadioGroup

public void addRadioGroup(PdfFormField radiogroup)

Parameters:: radiogroup - field

addRadioButton

public PdfFormField addRadioButton(PdfFormField radiogroup,
                                   String value,
                                   float llx,
                                   float lly,
                                   float urx,
                                   float ury)

Parameters:: radiogroup - radio group field; value - value of the field; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

drawRadioAppearences

public void drawRadioAppearences(PdfFormField field,
                                 String value,
                                 float llx,
                                 float lly,
                                 float urx,
                                 float ury)

Parameters:: field - field, an object of PdfFormField; value - value; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y

addSelectList

public PdfFormField addSelectList(String name,
                                  String[] options,
                                  String defaultValue,
                                  BaseFont font,
                                  float fontSize,
                                  float llx,
                                  float lly,
                                  float urx,
                                  float ury)

Parameters:: name - name of the field; options - options; defaultValue - default value; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

addSelectList

public PdfFormField addSelectList(String name,
                                  String[][] options,
                                  String defaultValue,
                                  BaseFont font,
                                  float fontSize,
                                  float llx,
                                  float lly,
                                  float urx,
                                  float ury)

Parameters:: name - name of the field; options - options; defaultValue - default value; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

addComboBox

public PdfFormField addComboBox(String name,
                                String[] options,
                                String defaultValue,
                                boolean editable,
                                BaseFont font,
                                float fontSize,
                                float llx,
                                float lly,
                                float urx,
                                float ury)

Parameters:: name - name of the field; options - options; defaultValue - default value; editable - if field is editable, true or false; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

addComboBox

public PdfFormField addComboBox(String name,
                                String[][] options,
                                String defaultValue,
                                boolean editable,
                                BaseFont font,
                                float fontSize,
                                float llx,
                                float lly,
                                float urx,
                                float ury)

Parameters:: name - name of the field; options - options; defaultValue - default value; editable - if field is editable, true or false; font - an object of BaseFont; fontSize - font size; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

setChoiceParams

public void setChoiceParams(PdfFormField field,
                            String name,
                            String defaultValue,
                            float llx,
                            float lly,
                            float urx,
                            float ury)

Parameters:: field - field, an object of PdfFormField; name - field name; defaultValue - default calue; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y

addSignature

public PdfFormField addSignature(String name,
                                 float llx,
                                 float lly,
                                 float urx,
                                 float ury)

Parameters:: name - field name; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y
Returns:: a PdfFormField

setSignatureParams

public void setSignatureParams(PdfFormField field,
                               String name,
                               float llx,
                               float lly,
                               float urx,
                               float ury)

Parameters:: name - field name; field - field, an object of PdfFormField; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y

drawSignatureAppearences

public void drawSignatureAppearences(PdfFormField field,
                                     float llx,
                                     float lly,
                                     float urx,
                                     float ury)

Parameters:: field - field, an object of PdfFormField; llx - lower-left-x; lly - lower-left-y; urx - upper-right-x; ury - upper-right-y

Class PdfAcroForm

Field Summary

Fields inherited from class com.lowagie.text.pdf.PdfDictionary

Fields inherited from class com.lowagie.text.pdf.PdfObject

Constructor Summary

Method Summary

Methods inherited from class com.lowagie.text.pdf.PdfDictionary

Methods inherited from class com.lowagie.text.pdf.PdfObject

Methods inherited from class java.lang.Object

Constructor Detail

PdfAcroForm

Method Detail

setNeedAppearances

addFieldTemplates

addFieldTemplates

addDocumentField

isValid

addCalculationOrder

setSigFlags

addFormField

addHtmlPostButton

addResetButton

addMap

setButtonParams

drawButton

addHiddenField

addSingleLineTextField

addMultiLineTextField

addSingleLinePasswordField

setTextFieldParams

drawSingleLineOfText

drawMultiLineOfText

addCheckBox

setCheckBoxParams

drawCheckBoxAppearences

getRadioGroup

addRadioGroup

addRadioButton

drawRadioAppearences

addSelectList

addSelectList

addComboBox

addComboBox

setChoiceParams

addSignature

setSignatureParams

drawSignatureAppearences