Package com.itextpdf.forms.fields
Class CheckBoxFormFieldBuilder
- java.lang.Object
-
- com.itextpdf.forms.fields.FormFieldBuilder<T>
-
- com.itextpdf.forms.fields.TerminalFormFieldBuilder<CheckBoxFormFieldBuilder>
-
- com.itextpdf.forms.fields.CheckBoxFormFieldBuilder
-
public class CheckBoxFormFieldBuilder extends TerminalFormFieldBuilder<CheckBoxFormFieldBuilder>
Builder for checkbox form field.
-
-
Field Summary
Fields Modifier and Type Field Description private CheckBoxType
checkType
-
Constructor Summary
Constructors Constructor Description CheckBoxFormFieldBuilder(PdfDocument document, java.lang.String formFieldName)
Creates builder forPdfButtonFormField
creation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PdfButtonFormField
createCheckBox()
Creates checkbox form field based on provided parameters.CheckBoxType
getCheckType()
Gets check type for checkbox form field.protected CheckBoxFormFieldBuilder
getThis()
Returns this builder object.CheckBoxFormFieldBuilder
setCheckType(CheckBoxType checkType)
Sets check type for checkbox form field.-
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
getConformanceLevel, getDocument, getFormFieldName, getGenericConformanceLevel, setConformanceLevel, setGenericConformanceLevel
-
-
-
-
Field Detail
-
checkType
private CheckBoxType checkType
-
-
Constructor Detail
-
CheckBoxFormFieldBuilder
public CheckBoxFormFieldBuilder(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
-
getCheckType
public CheckBoxType getCheckType()
Gets check type for checkbox form field.- Returns:
- check type to be set for checkbox form field
-
setCheckType
public CheckBoxFormFieldBuilder setCheckType(CheckBoxType checkType)
Sets check type for checkbox form field. Default value isCheckBoxType.CROSS
.- Parameters:
checkType
- check type to be set for checkbox form field- Returns:
- this builder
-
createCheckBox
public PdfButtonFormField createCheckBox()
Creates checkbox form field based on provided parameters.- Returns:
- new
PdfButtonFormField
instance
-
getThis
protected CheckBoxFormFieldBuilder getThis()
Returns this builder object. Required for superclass methods.- Specified by:
getThis
in classFormFieldBuilder<CheckBoxFormFieldBuilder>
- Returns:
- this builder
-
-