com.lowagie.text.pdf

Class PdfAcroForm

public class PdfAcroForm extends PdfDictionary

Each PDF document can contain maximum 1 AcroForm.

Field Summary
PdfArray	calculationOrder This is an array containing the calculationorder of the fields.
PdfArray	documentFields This is an array containing DocumentFields.
HashMap	fieldTemplates This is a map containing FieldTemplates.
int	sigFlags Contains the signature flags.
PdfWriter	writer

Constructor Summary
	PdfAcroForm(PdfWriter writer) Creates new PdfAcroForm

Method Summary
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) 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)

Field Detail

calculationOrder

private PdfArray calculationOrder

This is an array containing the calculationorder of the fields.

documentFields

private PdfArray documentFields

This is an array containing DocumentFields.

fieldTemplates

private HashMap fieldTemplates

This is a map containing FieldTemplates.

sigFlags

private int sigFlags

Contains the signature flags.

writer

private PdfWriter writer

Constructor Detail

PdfAcroForm

public PdfAcroForm(PdfWriter writer)

Creates new PdfAcroForm

Parameters: writer

Method Detail

addCalculationOrder

public void addCalculationOrder(PdfFormField formField)

Adds an object to the calculationOrder.

Parameters: formField

addCheckBox

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

Parameters: name value status llx lly urx ury

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 options defaultValue editable font fontSize llx lly urx ury

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 options defaultValue editable font fontSize llx lly urx ury

Returns: a PdfFormField

addDocumentField

public void addDocumentField(PdfIndirectReference ref)

Adds documentFields.

Parameters: ref

addFieldTemplates

public void addFieldTemplates(HashMap ft)

Adds fieldTemplates.

Parameters: ft

addFormField

public void addFormField(PdfFormField formField)

Adds a formfield to the AcroForm.

Parameters: formField

addHiddenField

public PdfFormField addHiddenField(String name, String value)

Parameters: name value

Returns: a 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 caption value url font fontSize llx lly urx ury

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 value url appearance llx lly urx ury

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 text font fontSize llx lly urx ury

Returns: a PdfFormField

addRadioButton

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

Parameters: radiogroup value llx lly urx ury

Returns: a PdfFormField

addRadioGroup

public void addRadioGroup(PdfFormField radiogroup)

Parameters: radiogroup

addResetButton

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

Parameters: name caption value font fontSize llx lly urx ury

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 options defaultValue font fontSize llx lly urx ury

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 options defaultValue font fontSize llx lly urx ury

Returns: a PdfFormField

addSignature

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

Parameters: name llx lly urx ury

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 text font fontSize llx lly urx ury

Returns: PdfFormField

addSingleLineTextField

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

Parameters: name text font fontSize llx lly urx ury

Returns: a PdfFormField

drawButton

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

Parameters: button caption font fontSize llx lly urx ury

drawCheckBoxAppearences

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

Parameters: field value llx lly urx ury

drawMultiLineOfText

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

Parameters: field text font fontSize llx lly urx ury

drawRadioAppearences

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

Parameters: field value llx lly urx ury

drawSignatureAppearences

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

Parameters: field llx lly urx ury

drawSingleLineOfText

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

Parameters: field text font fontSize llx lly urx ury

getRadioGroup

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

Parameters: name defaultValue noToggleToOff

Returns: a PdfFormField

isValid

public boolean isValid()

Checks if the Acroform is valid

Returns: true if the Acroform is valid

setButtonParams

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

Parameters: button characteristics name value

setCheckBoxParams

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

Parameters: field name value status llx lly urx ury

setChoiceParams

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

Parameters: field name defaultValue llx lly urx ury

setNeedAppearances

public void setNeedAppearances(boolean value)

setSigFlags

public void setSigFlags(int f)

Sets the signature flags.

Parameters: f

setSignatureParams

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

Parameters: field name llx lly urx ury

setTextFieldParams

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

Parameters: field text name llx lly urx ury