Package com.itextpdf.forms.fields

Class PdfFormFactory

java.lang.Object

com.itextpdf.forms.fields.PdfFormFactory

public class PdfFormFactory
extends java.lang.Object

Default factory for form related instances creation.

Constructor Summary

Constructors

Constructor	Description
PdfFormFactory()	Create PdfFormFactory instance.

Method Summary

Modifier and Type	Method	Description
PdfButtonFormField	createButtonFormField(PdfWidgetAnnotation widget, PdfDocument document)	Creates a button form field as a parent of a PdfWidgetAnnotation.
PdfButtonFormField	createButtonFormField(PdfDictionary dictionary)	Creates a button form field as a wrapper object around a PdfDictionary.
PdfButtonFormField	createButtonFormField(PdfDocument document)	Create a minimal, empty PdfButtonFormField.
PdfChoiceFormField	createChoiceFormField(PdfWidgetAnnotation widget, PdfDocument document)	Creates a choice form field as a parent of a PdfWidgetAnnotation.
PdfChoiceFormField	createChoiceFormField(PdfDictionary dictionary)	Creates a choice form field as a wrapper object around a PdfDictionary.
PdfChoiceFormField	createChoiceFormField(PdfDocument document)	Create a minimal, empty PdfChoiceFormField.
PdfFormAnnotation	createFormAnnotation(PdfWidgetAnnotation widget, PdfDocument document)	Creates a form field annotation as a wrapper of a PdfWidgetAnnotation.
PdfFormAnnotation	createFormAnnotation(PdfDictionary dictionary)	Creates a form field annotation as a wrapper object around a PdfDictionary.
PdfFormField	createFormField(PdfWidgetAnnotation widget, PdfDocument document)	Creates a form field as a parent of a PdfWidgetAnnotation.
PdfFormField	createFormField(PdfDictionary dictionary)	Creates a form field as a wrapper object around a PdfDictionary.
PdfFormField	createFormField(PdfDocument document)	Create a minimal, empty PdfFormField.
PdfSignatureFormField	createSignatureFormField(PdfWidgetAnnotation widget, PdfDocument document)	Creates a signature form field as a parent of a PdfWidgetAnnotation.
PdfSignatureFormField	createSignatureFormField(PdfDictionary dictionary)	Creates a signature form field as a wrapper object around a PdfDictionary.
PdfSignatureFormField	createSignatureFormField(PdfDocument document)	Create a minimal, empty PdfSignatureFormField.
PdfTextFormField	createTextFormField(PdfWidgetAnnotation widget, PdfDocument document)	Creates a text form field as a parent of a PdfWidgetAnnotation.
PdfTextFormField	createTextFormField(PdfDictionary dictionary)	Creates a text form field as a wrapper object around a PdfDictionary.
PdfTextFormField	createTextFormField(PdfDocument document)	Create a minimal, empty PdfTextFormField.
PdfAcroForm	getAcroForm(PdfDocument document, boolean createIfNotExist)	Retrieves AcroForm from the document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PdfFormFactory

public PdfFormFactory()

Create PdfFormFactory instance.

Method Detail

createFormField

public PdfFormField createFormField(PdfDocument document)

Create a minimal, empty PdfFormField.

Parameters:

document - The PdfDocument instance.

Returns:

created PdfFormField

createFormField

public PdfFormField createFormField(PdfDictionary dictionary)

Creates a form field as a wrapper object around a PdfDictionary. This PdfDictionary must be an indirect object.

Parameters:

dictionary - the dictionary to be wrapped, must have an indirect reference.

Returns:

created PdfFormField

createFormField

public PdfFormField createFormField(PdfWidgetAnnotation widget,
                                    PdfDocument document)

Creates a form field as a parent of a PdfWidgetAnnotation.

Parameters:

widget - The widget which will be a kid of the PdfFormField.

document - The PdfDocument instance.

Returns:

created PdfFormField

createTextFormField

public PdfTextFormField createTextFormField(PdfDocument document)

Create a minimal, empty PdfTextFormField.

Parameters:

document - The PdfDocument instance.

Returns:

created PdfTextFormField

createTextFormField

public PdfTextFormField createTextFormField(PdfDictionary dictionary)

Creates a text form field as a wrapper object around a PdfDictionary. This PdfDictionary must be an indirect object.

Parameters:

dictionary - the dictionary to be wrapped, must have an indirect reference.

Returns:

created PdfTextFormField

createTextFormField

public PdfTextFormField createTextFormField(PdfWidgetAnnotation widget,
                                            PdfDocument document)

Creates a text form field as a parent of a PdfWidgetAnnotation.

Parameters:

widget - The widget which will be a kid of the PdfTextFormField.

document - The PdfDocument instance.

Returns:

created PdfTextFormField

createButtonFormField

public PdfButtonFormField createButtonFormField(PdfDocument document)

Create a minimal, empty PdfButtonFormField.

Parameters:

document - The PdfDocument instance.

Returns:

created PdfButtonFormField

createButtonFormField

public PdfButtonFormField createButtonFormField(PdfDictionary dictionary)

Creates a button form field as a wrapper object around a PdfDictionary. This PdfDictionary must be an indirect object.

Parameters:

dictionary - the dictionary to be wrapped, must have an indirect reference.

Returns:

created PdfButtonFormField

createButtonFormField

public PdfButtonFormField createButtonFormField(PdfWidgetAnnotation widget,
                                                PdfDocument document)

Creates a button form field as a parent of a PdfWidgetAnnotation.

Parameters:

widget - The widget which will be a kid of the PdfButtonFormField.

document - The PdfDocument instance.

Returns:

created PdfButtonFormField

createChoiceFormField

public PdfChoiceFormField createChoiceFormField(PdfDocument document)

Create a minimal, empty PdfChoiceFormField.

Parameters:

document - The PdfDocument instance.

Returns:

created PdfChoiceFormField

createChoiceFormField

public PdfChoiceFormField createChoiceFormField(PdfDictionary dictionary)

Creates a choice form field as a wrapper object around a PdfDictionary. This PdfDictionary must be an indirect object.

Parameters:

dictionary - the dictionary to be wrapped, must have an indirect reference.

Returns:

created PdfChoiceFormField

createChoiceFormField

public PdfChoiceFormField createChoiceFormField(PdfWidgetAnnotation widget,
                                                PdfDocument document)

Creates a choice form field as a parent of a PdfWidgetAnnotation.

Parameters:

widget - The widget which will be a kid of the PdfChoiceFormField.

document - The PdfDocument instance.

Returns:

created PdfChoiceFormField

createSignatureFormField

public PdfSignatureFormField createSignatureFormField(PdfDocument document)

Create a minimal, empty PdfSignatureFormField.

Parameters:

document - The PdfDocument instance.

Returns:

created PdfSignatureFormField

createSignatureFormField

public PdfSignatureFormField createSignatureFormField(PdfDictionary dictionary)

Creates a signature form field as a wrapper object around a PdfDictionary. This PdfDictionary must be an indirect object.

Parameters:

dictionary - the dictionary to be wrapped, must have an indirect reference.

Returns:

created PdfSignatureFormField

createSignatureFormField

public PdfSignatureFormField createSignatureFormField(PdfWidgetAnnotation widget,
                                                      PdfDocument document)

Creates a signature form field as a parent of a PdfWidgetAnnotation.

Parameters:

widget - The widget which will be a kid of the PdfSignatureFormField.

document - The PdfDocument instance.

Returns:

created PdfSignatureFormField

createFormAnnotation

public PdfFormAnnotation createFormAnnotation(PdfDictionary dictionary)

Creates a form field annotation as a wrapper object around a PdfDictionary. This PdfDictionary must be an indirect object.

Parameters:

dictionary - the dictionary to be wrapped, must have an indirect reference.

Returns:

created PdfFormAnnotation

createFormAnnotation

public PdfFormAnnotation createFormAnnotation(PdfWidgetAnnotation widget,
                                              PdfDocument document)

Creates a form field annotation as a wrapper of a PdfWidgetAnnotation.

Parameters:

widget - The widget which will be a kid of the PdfFormField

document - The PdfDocument instance.

Returns:

created PdfFormAnnotation

getAcroForm

public PdfAcroForm getAcroForm(PdfDocument document,
                               boolean createIfNotExist)

Retrieves AcroForm from the document. If there is no AcroForm in the document Catalog and createIfNotExist flag is true then the AcroForm dictionary will be created and added to the document.

Parameters:

document - the document to retrieve the PdfAcroForm from

createIfNotExist - when true, this method will create a PdfAcroForm if none exists for this document

Returns:

the document's AcroForm, or a new one provided that createIfNotExist parameter is true, otherwise null.