Package com.itextpdf.forms.fields

Class CheckBoxFormFieldBuilder

java.lang.Object

com.itextpdf.forms.fields.FormFieldBuilder

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

com.itextpdf.forms.fields.CheckBoxFormFieldBuilder

 public class CheckBoxFormFieldBuilder extends TerminalFormFieldBuilder<CheckBoxFormFieldBuilder> 
      

Builder for checkbox form field.

Constructor Summary

Constructors

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

Method Summary

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

getPage, getWidgetRectangle, setPage, setPage, setWidgetRectangle

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

getConformanceLevel, getDocument, getFormFieldName, setConformanceLevel

Methods inherited from class java.lang.Object

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

Constructor Details

CheckBoxFormFieldBuilder

 public CheckBoxFormFieldBuilder 
             (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

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 is CheckBoxType.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 class FormFieldBuilder<CheckBoxFormFieldBuilder>

Returns:

this builder