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

public final Class PDListBox

extends PDChoice
Class Inheritance
Imports
java.io.IOException, org.apache.pdfbox.cos.COSDictionary, .COSName
A scrollable list box. Contains several text items, one or more of which shall be selected as the field value.
Author
John Hewson

Field Summary

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

Constructor Summary

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

pack-priv
PDListBox(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 int

Returns:

the top index, default value 0.
getTopIndex()

This will get the top index "TI" value.

public void
setTopIndex(Integer
the value for the top index, null will remove the value.
topIndex)

This will set top index "TI" value.

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

Constructor Detail

PDListBoxback to summary
public PDListBox(PDAcroForm acroForm)
Parameters
acroForm:PDAcroForm

The acroform.

See Also
PDField#PDField(PDAcroForm)
PDListBoxback to summary
pack-priv PDListBox(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
getTopIndexback to summary
public int getTopIndex()

This will get the top index "TI" value.

Returns:int

the top index, default value 0.

setTopIndexback to summary
public void setTopIndex(Integer topIndex)

This will set top index "TI" value.

Parameters
topIndex:Integer

the value for the top index, null will remove the value.