Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.form

public final Class PDComboBox

extends PDChoice
Class Inheritance
Imports
java.io.IOException, java.util.List, org.apache.pdfbox.cos.COSDictionary, .COSName
A combo box consisting of a drop-down list. May be accompanied by an editable text box in which non-predefined values may be entered.
Author
John Hewson

Field Summary

Modifier and TypeField and Description
private static final int
FLAG_EDIT

Inherited from org.apache.pdfbox.pdmodel.interactive.form.PDChoice:
FLAG_COMBO

Constructor Summary

AccessConstructor and Description
public
PDComboBox(PDAcroForm
The acroform.
acroForm)

pack-priv
PDComboBox(PDAcroForm
The form that this field is part of.
acroForm, COSDictionary
the PDF object to represent as a field.
field, PDNonTerminalField
the parent node of the node
parent)

Constructor.

Method Summary

Modifier and TypeMethod and Description
pack-priv void
constructAppearances()

Implements abstract org.apache.pdfbox.pdmodel.interactive.form.PDChoice.constructAppearances.

Constructs appearance streams and appearance dictionaries for all widget annotations.

public boolean

Returns:

true if the combo box shall include an editable text box as well as a drop-down list.
isEdit()

Determines if Edit is set.

public void
setEdit(boolean
The value for Edit.
edit)

Set the Edit bit.

Inherited from org.apache.pdfbox.pdmodel.interactive.form.PDChoice:
getDefaultValuegetOptionsgetOptionsDisplayValuesgetOptionsExportValuesgetSelectedOptionsIndexgetValuegetValueAsStringisComboisCommitOnSelChangeisDoNotSpellCheckisMultiSelectisSortsetCombosetCommitOnSelChangesetDefaultValuesetDoNotSpellChecksetMultiSelectsetOptionssetOptionssetSelectedOptionsIndexsetSortsetValuesetValue

Field Detail

FLAG_EDITback to summary
private static final int FLAG_EDIT

Constructor Detail

PDComboBoxback to summary
public PDComboBox(PDAcroForm acroForm)
Parameters
acroForm:PDAcroForm

The acroform.

See Also
PDField#PDField(PDAcroForm)
PDComboBoxback to summary
pack-priv PDComboBox(PDAcroForm acroForm, COSDictionary field, PDNonTerminalField parent)

Constructor.

Parameters
acroForm:PDAcroForm

The form that this field is part of.

field:COSDictionary

the PDF object to represent as a field.

parent:PDNonTerminalField

the parent node of the node

Method Detail

constructAppearancesback to summary
pack-priv void constructAppearances() throws IOException

Implements abstract org.apache.pdfbox.pdmodel.interactive.form.PDChoice.constructAppearances.

Doc from org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField.constructAppearances.

Constructs appearance streams and appearance dictionaries for all widget annotations. Subclasses should not call this method directly but via applyChange().

Annotations
@Override
Exceptions
IOException:
if the appearance couldn't be generated
isEditback to summary
public boolean isEdit()

Determines if Edit is set.

Returns:boolean

true if the combo box shall include an editable text box as well as a drop-down list.

setEditback to summary
public void setEdit(boolean edit)

Set the Edit bit.

Parameters
edit:boolean

The value for Edit.