Package com.itextpdf.forms.fields

Class PdfFormCreator

java.lang.Object

com.itextpdf.forms.fields.PdfFormCreator

public final class PdfFormCreator
extends java.lang.Object

Creator which shall be used in order to create all form related instances. By default PdfFormFactory is used.

Field Summary

Fields

Modifier and Type	Field	Description
private static PdfFormFactory	factory

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PdfFormCreator()

Method Summary

Modifier and Type	Method	Description
static PdfButtonFormField	createButtonFormField(PdfWidgetAnnotation widget, PdfDocument document)	Creates a button form field as a parent of a PdfWidgetAnnotation using provided factory.
static PdfButtonFormField	createButtonFormField(PdfDictionary dictionary)	Creates a button form field as a wrapper object around a PdfDictionary using provided factory.
static PdfButtonFormField	createButtonFormField(PdfDocument document)	Create a minimal, empty PdfButtonFormField using provided factory.
static PdfChoiceFormField	createChoiceFormField(PdfWidgetAnnotation widget, PdfDocument document)	Creates a choice form field as a parent of a PdfWidgetAnnotation using provided factory.
static PdfChoiceFormField	createChoiceFormField(PdfDictionary dictionary)	Creates a choice form field as a wrapper object around a PdfDictionary using provided factory.
static PdfChoiceFormField	createChoiceFormField(PdfDocument document)	Create a minimal, empty PdfChoiceFormField using provided factory.
static PdfFormAnnotation	createFormAnnotation(PdfWidgetAnnotation widget, PdfDocument document)	Creates a form field annotation as a wrapper of a PdfWidgetAnnotation using provided factory.
static PdfFormAnnotation	createFormAnnotation(PdfDictionary dictionary)	Creates a form field annotation as a wrapper object around a PdfDictionary using provided factory.
static PdfFormField	createFormField(PdfWidgetAnnotation widget, PdfDocument document)	Creates a form field as a parent of a PdfWidgetAnnotation using provided factory.
static PdfFormField	createFormField(PdfDictionary dictionary)	Creates a form field as a wrapper object around a PdfDictionary using provided factory.
static PdfFormField	createFormField(PdfDocument document)	Create a minimal, empty PdfFormField using provided factory.
static PdfSignatureFormField	createSignatureFormField(PdfWidgetAnnotation widget, PdfDocument document)	Creates a signature form field as a parent of a PdfWidgetAnnotation using provided factory.
static PdfSignatureFormField	createSignatureFormField(PdfDictionary dictionary)	Creates a signature form field as a wrapper object around a PdfDictionary using provided factory.
static PdfSignatureFormField	createSignatureFormField(PdfDocument document)	Create a minimal, empty PdfSignatureFormField using provided factory.
static PdfTextFormField	createTextFormField(PdfWidgetAnnotation widget, PdfDocument document)	Creates a text form field as a parent of a PdfWidgetAnnotation using provided factory.
static PdfTextFormField	createTextFormField(PdfDictionary dictionary)	Creates a text form field as a wrapper object around a PdfDictionary using provided factory.
static PdfTextFormField	createTextFormField(PdfDocument document)	Create a minimal, empty PdfTextFormField using provided factory.
static PdfAcroForm	getAcroForm(PdfDocument document, boolean createIfNotExist)	Retrieves AcroForm from the document using provided factory.
static void	setFactory(PdfFormFactory factory)	Set PdfFormFactory to be used for form related instances creation.

Methods inherited from class java.lang.Object

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

Field Detail

factory

private static PdfFormFactory factory

Constructor Detail

PdfFormCreator

private PdfFormCreator()

Method Detail

setFactory

public static void setFactory(PdfFormFactory factory)

Set PdfFormFactory to be used for form related instances creation.

Parameters:

factory - PdfFormFactory to set

createFormField

public static PdfFormField createFormField(PdfDocument document)

Create a minimal, empty PdfFormField using provided factory.

Parameters:

document - The PdfDocument instance.

Returns:

created PdfFormField

createFormField

public static PdfFormField createFormField(PdfDictionary dictionary)

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

Parameters:

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

Returns:

created PdfFormField

createFormField

public static PdfFormField createFormField(PdfWidgetAnnotation widget,
                                           PdfDocument document)

Creates a form field as a parent of a PdfWidgetAnnotation using provided factory.

Parameters:

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

document - The PdfDocument instance.

Returns:

created PdfFormField

createTextFormField

public static PdfTextFormField createTextFormField(PdfDocument document)

Create a minimal, empty PdfTextFormField using provided factory.

Parameters:

document - The PdfDocument instance.

Returns:

created PdfTextFormField

createTextFormField

public static PdfTextFormField createTextFormField(PdfDictionary dictionary)

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

Parameters:

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

Returns:

created PdfTextFormField

createTextFormField

public static PdfTextFormField createTextFormField(PdfWidgetAnnotation widget,
                                                   PdfDocument document)

Creates a text form field as a parent of a PdfWidgetAnnotation using provided factory.

Parameters:

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

document - The PdfDocument instance.

Returns:

created PdfTextFormField

createButtonFormField

public static PdfButtonFormField createButtonFormField(PdfDocument document)

Create a minimal, empty PdfButtonFormField using provided factory.

Parameters:

document - The PdfDocument instance.

Returns:

created PdfButtonFormField

createButtonFormField

public static PdfButtonFormField createButtonFormField(PdfDictionary dictionary)

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

Parameters:

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

Returns:

created PdfButtonFormField

createButtonFormField

public static PdfButtonFormField createButtonFormField(PdfWidgetAnnotation widget,
                                                       PdfDocument document)

Creates a button form field as a parent of a PdfWidgetAnnotation using provided factory.

Parameters:

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

document - The PdfDocument instance.

Returns:

created PdfButtonFormField

createChoiceFormField

public static PdfChoiceFormField createChoiceFormField(PdfDocument document)

Create a minimal, empty PdfChoiceFormField using provided factory.

Parameters:

document - The PdfDocument instance.

Returns:

created PdfChoiceFormField

createChoiceFormField

public static PdfChoiceFormField createChoiceFormField(PdfDictionary dictionary)

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

Parameters:

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

Returns:

created PdfChoiceFormField

createChoiceFormField

public static PdfChoiceFormField createChoiceFormField(PdfWidgetAnnotation widget,
                                                       PdfDocument document)

Creates a choice form field as a parent of a PdfWidgetAnnotation using provided factory.

Parameters:

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

document - The PdfDocument instance.

Returns:

created PdfChoiceFormField

createSignatureFormField

public static PdfSignatureFormField createSignatureFormField(PdfDocument document)

Create a minimal, empty PdfSignatureFormField using provided factory.

Parameters:

document - The PdfDocument instance.

Returns:

created PdfSignatureFormField

createSignatureFormField

public static PdfSignatureFormField createSignatureFormField(PdfDictionary dictionary)

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

Parameters:

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

Returns:

created PdfSignatureFormField

createSignatureFormField

public static PdfSignatureFormField createSignatureFormField(PdfWidgetAnnotation widget,
                                                             PdfDocument document)

Creates a signature form field as a parent of a PdfWidgetAnnotation using provided factory.

Parameters:

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

document - The PdfDocument instance.

Returns:

created PdfSignatureFormField

createFormAnnotation

public static PdfFormAnnotation createFormAnnotation(PdfDictionary dictionary)

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

Parameters:

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

Returns:

created PdfFormAnnotation

createFormAnnotation

public static PdfFormAnnotation createFormAnnotation(PdfWidgetAnnotation widget,
                                                     PdfDocument document)

Creates a form field annotation as a wrapper of a PdfWidgetAnnotation using provided factory.

Parameters:

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

document - The PdfDocument instance.

Returns:

created PdfFormAnnotation

getAcroForm

public static PdfAcroForm getAcroForm(PdfDocument document,
                                      boolean createIfNotExist)

Retrieves AcroForm from the document using provided factory. 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.