Package com.itextpdf.forms.fields

Class ChoiceFormFieldBuilder

java.lang.Object

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

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

com.itextpdf.forms.fields.ChoiceFormFieldBuilder

public class ChoiceFormFieldBuilder
extends TerminalFormFieldBuilder<ChoiceFormFieldBuilder>

Builder for choice form field.

Field Summary

Fields

Modifier and Type	Field	Description
private PdfArray	options

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private PdfChoiceFormField	createChoice(int flags)
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.
private static PdfArray	processOptions(java.lang.String[] options)	Convert String array of combo box or list options to PdfArray.
private static PdfArray	processOptions(java.lang.String[][] options)	Convert String multidimensional array of combo box or list options to PdfArray.
ChoiceFormFieldBuilder	setOptions(PdfArray options)	Sets options for choice form field.
ChoiceFormFieldBuilder	setOptions(java.lang.String[] options)	Sets options for choice form field.
ChoiceFormFieldBuilder	setOptions(java.lang.String[][] options)	Sets options for choice form field.
private static void	verifyOptions(PdfArray options)

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

Methods inherited from class java.lang.Object

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

Field Detail

options

private PdfArray options

Constructor Detail

ChoiceFormFieldBuilder

public ChoiceFormFieldBuilder(PdfDocument document,
                              java.lang.String formFieldName)

Creates builder for PdfChoiceFormField creation.

Parameters:

document - document to be used for form field creation

formFieldName - name of the form field

Method Detail

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(java.lang.String[] options)

Sets options for choice form field.

Parameters:

options - array of String options

Returns:

this builder

setOptions

public ChoiceFormFieldBuilder setOptions(java.lang.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

createChoice

private PdfChoiceFormField createChoice(int flags)

processOptions

private static PdfArray processOptions(java.lang.String[][] options)

Convert String multidimensional array of combo box or list options to PdfArray.

Parameters:

options - Two-dimensional array of options.

Returns:

a PdfArray that contains all the options.

verifyOptions

private static void verifyOptions(PdfArray options)

processOptions

private static PdfArray processOptions(java.lang.String[] options)

Convert String array of combo box or list options to PdfArray.

Parameters:

options - array of options.

Returns:

a PdfArray that contains all the options.