Class PushButtonFormFieldBuilder

java.lang.Object

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

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

com.itextpdf.forms.fields.PushButtonFormFieldBuilder

public class PushButtonFormFieldBuilder
extends TerminalFormFieldBuilder<PushButtonFormFieldBuilder>

Builder for push button form field.

Field Summary

Fields

Modifier and Type	Field	Description
private String	caption

Constructor Summary

Constructors

Constructor	Description
PushButtonFormFieldBuilder(PdfDocument document, String formFieldName)	Creates builder for PdfButtonFormField creation.

Method Summary

Modifier and Type	Method	Description
PdfButtonFormField	createPushButton()	Creates push button form field base on provided parameters.
String	getCaption()	Gets caption for button form field creation.
protected PushButtonFormFieldBuilder	getThis()	Returns this builder object.
PushButtonFormFieldBuilder	setCaption(String caption)	Sets caption for button form field creation.

Methods inherited from class TerminalFormFieldBuilder

getFont, getPage, getWidgetRectangle, setFont, setPage, setPage, setPageToField, setPageToField, setWidgetRectangle

Methods inherited from class FormFieldBuilder

getConformance, getDocument, getFormFieldName, setConformance

Methods inherited from class Object

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

Field Details

caption

private String caption

Constructor Details

PushButtonFormFieldBuilder

public PushButtonFormFieldBuilder(PdfDocument document,
 String formFieldName)

Creates builder for PdfButtonFormField creation.

Parameters:

document - document to be used for form field creation

formFieldName - name of the form field

Method Details

getCaption

public String getCaption()

Gets caption for button form field creation.

Returns:

caption value to be used for form field creation

setCaption

public PushButtonFormFieldBuilder setCaption(String caption)

Sets caption for button form field creation.

Parameters:

caption - caption value to be used for form field creation

Returns:

this builder

createPushButton

public PdfButtonFormField createPushButton()

Creates push button form field base on provided parameters.

Returns:

new PdfButtonFormField instance

getThis

protected PushButtonFormFieldBuilder getThis()

Returns this builder object. Required for superclass methods.

Specified by:

getThis in class FormFieldBuilder<PushButtonFormFieldBuilder>

Returns:

this builder