Package com.itextpdf.forms.fields
Class PushButtonFormFieldBuilder
- java.lang.Object
-
- com.itextpdf.forms.fields.FormFieldBuilder<T>
-
- 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 java.lang.String
caption
-
Constructor Summary
Constructors Constructor Description PushButtonFormFieldBuilder(PdfDocument document, java.lang.String formFieldName)
Creates builder forPdfButtonFormField
creation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PdfButtonFormField
createPushButton()
Creates push button form field base on provided parameters.java.lang.String
getCaption()
Gets caption for button form field creation.protected PushButtonFormFieldBuilder
getThis()
Returns this builder object.PushButtonFormFieldBuilder
setCaption(java.lang.String caption)
Sets caption for button form field creation.-
Methods inherited from class com.itextpdf.forms.fields.TerminalFormFieldBuilder
getFont, getPage, getWidgetRectangle, setFont, setPage, setPage, setPageToField, setPageToField, setWidgetRectangle
-
Methods inherited from class com.itextpdf.forms.fields.FormFieldBuilder
getConformance, getDocument, getFormFieldName, setConformance
-
-
-
-
Constructor Detail
-
PushButtonFormFieldBuilder
public PushButtonFormFieldBuilder(PdfDocument document, java.lang.String formFieldName)
Creates builder forPdfButtonFormField
creation.- Parameters:
document
- document to be used for form field creationformFieldName
- name of the form field
-
-
Method Detail
-
getCaption
public java.lang.String getCaption()
Gets caption for button form field creation.- Returns:
- caption value to be used for form field creation
-
setCaption
public PushButtonFormFieldBuilder setCaption(java.lang.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 classFormFieldBuilder<PushButtonFormFieldBuilder>
- Returns:
- this builder
-
-