org.apache.pdfbox.pdmodel.interactive.form

Class PDListBox

java.lang.Object

org.apache.pdfbox.pdmodel.interactive.form.PDField

org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField

org.apache.pdfbox.pdmodel.interactive.form.PDVariableText

org.apache.pdfbox.pdmodel.interactive.form.PDChoice

org.apache.pdfbox.pdmodel.interactive.form.PDListBox

All Implemented Interfaces:

COSObjectable

public final class PDListBox
extends PDChoice

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

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

QUADDING_CENTERED, QUADDING_LEFT, QUADDING_RIGHT

Constructor Summary

Constructors

Constructor and Description
PDListBox(PDAcroForm acroForm)

Method Summary

Modifier and Type	Method and Description
int	getTopIndex() This will get the top index "TI" value.
void	setTopIndex(Integer topIndex) This will set top index "TI" value.

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDChoice

getDefaultValue, getOptions, getOptionsDisplayValues, getOptionsExportValues, getSelectedOptionsIndex, getValue, getValueAsString, isCombo, isCommitOnSelChange, isDoNotSpellCheck, isMultiSelect, isSort, setCombo, setCommitOnSelChange, setDefaultValue, setDoNotSpellCheck, setMultiSelect, setOptions, setOptions, setSelectedOptionsIndex, setSort, setValue, setValue

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

getDefaultAppearance, getDefaultStyleString, getQ, getRichTextValue, getStringOrStream, setDefaultAppearance, setDefaultStyleString, setQ, setRichTextValue

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField

applyChange, getFieldFlags, getFieldType, getWidget, getWidgets, importFDF, setActions, setWidgets

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

getAcroForm, getActions, getAlternateFieldName, getCOSObject, getFullyQualifiedName, getInheritableAttribute, getMappingName, getParent, getPartialName, isNoExport, isReadOnly, isRequired, setAlternateFieldName, setFieldFlags, setMappingName, setNoExport, setPartialName, setReadOnly, setRequired, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PDListBox

public PDListBox(PDAcroForm acroForm)

Parameters:

acroForm - The acroform.

See Also:

PDField.PDField(PDAcroForm)

Method Detail

getTopIndex

public int getTopIndex()

This will get the top index "TI" value.

Returns:

the top index, default value 0.

setTopIndex

public void setTopIndex(Integer topIndex)

This will set top index "TI" value.

Parameters:

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