Package com.itextpdf.forms.fields

Class ChoiceFormFieldBuilder

java.lang.Object
com.itextpdf.forms.fields.FormFieldBuilder<ChoiceFormFieldBuilder>
com.itextpdf.forms.fields.TerminalFormFieldBuilder<ChoiceFormFieldBuilder>
com.itextpdf.forms.fields.ChoiceFormFieldBuilder
public class ChoiceFormFieldBuilder extends TerminalFormFieldBuilder<ChoiceFormFieldBuilder>
Builder for choice form field.

  • Field Details

  • 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

    • createChoice

      private PdfChoiceFormField createChoice(int flags)

    • processOptions

      private static PdfArray processOptions(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(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.