Package com.itextpdf.forms.fields

Class ChoiceFormFieldBuilder

java.lang.Object

com.itextpdf.forms.fields.FormFieldBuilder

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

com.itextpdf.forms.fields.ChoiceFormFieldBuilder

       public class ChoiceFormFieldBuilder extends TerminalFormFieldBuilder<ChoiceFormFieldBuilder>
      

Builder for choice form field.

Constructor Summary

Constructors

Constructor	Description
ChoiceFormFieldBuilder(PdfDocument document, String formFieldName)	Creates builder for PdfChoiceFormField creation.

Method Summary

Modifier and Type	Method	Description
PdfChoiceFormField	createComboBox()	Creates combobox form field base on provided parameters.
PdfChoiceFormField	createList()	Creates list form field based on provided parameters.
PdfArray	getOptions()	Gets options for choice form field.
protected ChoiceFormFieldBuilder	getThis()	Returns this builder object.
ChoiceFormFieldBuilder	setOptions(PdfArray options)	Sets options for choice form field.
ChoiceFormFieldBuilder	setOptions(String[] options)	Sets options for choice form field.
ChoiceFormFieldBuilder	setOptions(String[][] options)	Sets options for choice form field.

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

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

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

getConformance, getDocument, getFormFieldName, setConformance

Methods inherited from class java.lang.Object

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

Constructor Details

ChoiceFormFieldBuilder

             public ChoiceFormFieldBuilder
             (PdfDocument document, String formFieldName)
            

Creates builder for PdfChoiceFormField creation.

Parameters:

document - document to be used for form field creation

formFieldName - name of the form field

Method Details

getOptions

             public PdfArray getOptions()
            

Gets options for choice form field.

Returns:

PdfArray of choice form field options

setOptions

             public ChoiceFormFieldBuilder setOptions
             (PdfArray options)
            

Sets options for choice form field.

Parameters:

options - PdfArray of choice form field options

Returns:

this builder

setOptions

             public ChoiceFormFieldBuilder setOptions
             (String[] options)
            

Sets options for choice form field.

Parameters:

options - array of String options

Returns:

this builder

setOptions

             public ChoiceFormFieldBuilder setOptions
             (String[][] options)
            

Sets options for choice form field.

Parameters:

options - two-dimensional array of String options. Every inner array shall have two elements.

Returns:

this builder

createList

             public PdfChoiceFormField createList()
            

Creates list form field based on provided parameters.

Returns:

new PdfChoiceFormField instance

createComboBox

             public PdfChoiceFormField createComboBox()
            

Creates combobox form field base on provided parameters.

Returns:

new PdfChoiceFormField instance

getThis

             protected ChoiceFormFieldBuilder getThis()
            

Returns this builder object. Required for superclass methods.

Specified by:

getThis in class FormFieldBuilder<ChoiceFormFieldBuilder>

Returns:

this builder