org.pdfbox.pdmodel.interactive.form
Class PDChoiceField

java.lang.Object
  org.pdfbox.pdmodel.interactive.form.PDField
      org.pdfbox.pdmodel.interactive.form.PDVariableText
          org.pdfbox.pdmodel.interactive.form.PDChoiceField

All Implemented Interfaces:

COSObjectable

public class PDChoiceField
extends PDVariableText

A class for handling the PDF field as a choicefield.

Version:

$Revision: 1.7 $

Author:

sug

Field Summary

Fields inherited from class org.pdfbox.pdmodel.interactive.form.PDVariableText

FLAG_COMB, FLAG_DO_NOT_SCROLL, FLAG_DO_NOT_SPELL_CHECK, FLAG_FILE_SELECT, FLAG_MULTILINE, FLAG_PASSWORD, FLAG_RICH_TEXT, QUADDING_CENTERED, QUADDING_LEFT, QUADDING_RIGHT

Fields inherited from class org.pdfbox.pdmodel.interactive.form.PDField

FLAG_NO_EXPORT, FLAG_READ_ONLY, FLAG_REQUIRED

Constructor Summary

PDChoiceField(PDAcroForm theAcroForm, COSDictionary field)

Method Summary

void	setValue(java.lang.String optionValue) setValue sets the fields value to a given string.

Methods inherited from class org.pdfbox.pdmodel.interactive.form.PDVariableText

doNotScroll, doNotSpellCheck, getDefaultAppearance, getQ, getValue, isFileSelect, isMultiline, isPassword, isRichText, setComb, setDoNotScroll, setDoNotSpellCheck, setFileSelect, setMultiline, setPassword, setQ, setRichText, shouldComb

Methods inherited from class org.pdfbox.pdmodel.interactive.form.PDField

findFieldType, findKid, getAcroForm, getActions, getCOSObject, getDictionary, getFieldFlags, getFieldType, getFullyQualifiedName, getKids, getParent, getPartialName, getWidget, importFDF, isNoExport, isReadonly, isRequired, setAcroForm, setActions, setFieldFlags, setKids, setNoExport, setParent, setPartialName, setReadonly, setRequired, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PDChoiceField

public PDChoiceField(PDAcroForm theAcroForm,
                     COSDictionary field)

Parameters:

theAcroForm - The acroForm for this field.

field - The field for this choice field.

See Also:

PDField.PDField(PDAcroForm,COSDictionary)

Method Detail

setValue

public void setValue(java.lang.String optionValue)
              throws java.io.IOException

Description copied from class: PDField

setValue sets the fields value to a given string.

Overrides:

setValue in class PDVariableText

Parameters:

optionValue - The new value for this text field.

Throws:

java.io.IOException - If there is an error calculating the appearance stream or the value in not one of the existing options.

See Also:

PDField.setValue(java.lang.String)