Package com.itextpdf.forms.fields

Class TerminalFormFieldBuilder<T extends TerminalFormFieldBuilder<T>>

java.lang.Object

com.itextpdf.forms.fields.FormFieldBuilder<T>

com.itextpdf.forms.fields.TerminalFormFieldBuilder<T>

Type Parameters:

T - specific terminal form field builder which extends this class.

Direct Known Subclasses:

CheckBoxFormFieldBuilder, ChoiceFormFieldBuilder, PushButtonFormFieldBuilder, RadioFormFieldBuilder, SignatureFormFieldBuilder, TextFormFieldBuilder

public abstract class TerminalFormFieldBuilder<T extends TerminalFormFieldBuilder<T>>
extends FormFieldBuilder<T>

Builder for terminal form field.

Field Summary

Fields

Modifier and Type	Field	Description
private PdfFont	font
private int	page	Page number to place widget at.
private Rectangle	widgetRectangle	Rectangle which defines widget placement.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TerminalFormFieldBuilder(PdfDocument document, java.lang.String formFieldName)	Creates builder for terminal form field creation.

Method Summary

Modifier and Type	Method	Description
PdfFont	getFont()	Get font to be used for form field creation.
int	getPage()	Gets page to be used for widget creation.
Rectangle	getWidgetRectangle()	Gets rectangle which defines widget's placement.
T	setFont(PdfFont font)	Set font to be used for form field creation.
T	setPage(int page)	Sets page to be used for widget creation.
T	setPage(PdfPage page)	Sets page to be used for widget creation.
(package private) void	setPageToField(PdfFormAnnotation field)
(package private) void	setPageToField(PdfFormField field)
T	setWidgetRectangle(Rectangle widgetRectangle)	Sets rectangle which defines widget's placement.

Methods inherited from class com.itextpdf.forms.fields.FormFieldBuilder

getConformance, getDocument, getFormFieldName, getThis, setConformance

Methods inherited from class java.lang.Object

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

Field Detail

widgetRectangle

private Rectangle widgetRectangle

Rectangle which defines widget placement.

page

private int page

Page number to place widget at.

font

private PdfFont font

Constructor Detail

TerminalFormFieldBuilder

protected TerminalFormFieldBuilder(PdfDocument document,
                                   java.lang.String formFieldName)

Creates builder for terminal form field creation.

Parameters:

document - document to be used for form field creation

formFieldName - name of the form field

Method Detail

getWidgetRectangle

public Rectangle getWidgetRectangle()

Gets rectangle which defines widget's placement.

Returns:

instance of Rectangle for widget placement

getPage

public int getPage()

Gets page to be used for widget creation.

Returns:

number of page to place widget at

setPage

public T setPage(PdfPage page)

Sets page to be used for widget creation.

Parameters:

page - instance of PdfPage. Shall belong to already provided PdfDocument

Returns:

this builder

setPage

public T setPage(int page)

Sets page to be used for widget creation.

Parameters:

page - number of page to place widget at

Returns:

this builder

setWidgetRectangle

public T setWidgetRectangle(Rectangle widgetRectangle)

Sets rectangle which defines widget's placement.

Parameters:

widgetRectangle - instance of Rectangle for widget placement

Returns:

this builder

setPageToField

void setPageToField(PdfFormField field)

setPageToField

void setPageToField(PdfFormAnnotation field)

setFont

public T setFont(PdfFont font)

Set font to be used for form field creation.

Parameters:

font - instance of PdfFont.

Returns:

this builder

getFont

public PdfFont getFont()

Get font to be used for form field creation.

Returns:

instance of PdfFont.