Module org.sejda.sambox

Package org.sejda.sambox.pdmodel.interactive.form

Class PDListBox

java.lang.Object

org.sejda.sambox.pdmodel.common.PDDictionaryWrapper

org.sejda.sambox.pdmodel.interactive.form.PDField

org.sejda.sambox.pdmodel.interactive.form.PDTerminalField

org.sejda.sambox.pdmodel.interactive.form.PDVariableText

org.sejda.sambox.pdmodel.interactive.form.PDChoice

org.sejda.sambox.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.

Field Summary

Fields inherited from class org.sejda.sambox.pdmodel.interactive.form.PDChoice

FLAG_COMBO

Fields inherited from class org.sejda.sambox.pdmodel.interactive.form.PDVariableText

QUADDING_CENTERED, QUADDING_LEFT, QUADDING_RIGHT

Constructor Summary

Constructors

Constructor	Description
PDListBox(PDAcroForm acroForm)
PDListBox(PDAcroForm acroForm, COSDictionary field, PDNonTerminalField parent)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) void	constructAppearances()	Constructs appearance streams and appearance dictionaries for all widget annotations.
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.sejda.sambox.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.sejda.sambox.pdmodel.interactive.form.PDVariableText

getAppearanceFont, getAppearanceOverrideFont, getDefaultAppearance, getDefaultAppearanceString, getDefaultStyleString, getQ, getRichTextValue, getStringOrStream, setAppearanceOverrideFont, setDefaultAppearance, setDefaultStyleString, setQ, setRichTextValue

Methods inherited from class org.sejda.sambox.pdmodel.interactive.form.PDTerminalField

addWidgetIfMissing, applyChange, getFieldFlags, getFieldType, getWidgets, isTerminal, removeWidget, setActions, setWidgets

Methods inherited from class org.sejda.sambox.pdmodel.interactive.form.PDField

findKid, fromDictionary, getAcroForm, getActions, getAlternateFieldName, getFullyQualifiedName, getInheritableAttribute, getMappingName, getParent, getPartialName, isNoExport, isReadonly, isRequired, setAlternateFieldName, setFieldFlags, setMappingName, setNoExport, setPartialName, setReadonly, setRequired, toString

Methods inherited from class org.sejda.sambox.pdmodel.common.PDDictionaryWrapper

equals, getCOSObject, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PDListBox

public PDListBox(PDAcroForm acroForm)

Parameters:

acroForm - The acroform.

See Also:

• PDField(PDAcroForm)

PDListBox

PDListBox(PDAcroForm acroForm,
 COSDictionary field,
 PDNonTerminalField parent)

Constructor.

Parameters:

acroForm - The form that this field is part of.

field - the PDF object to represent as a field.

parent - the parent node of the node

Method Details

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.

constructAppearances

void constructAppearances()
                   throws IOException

Description copied from class: PDTerminalField

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

Specified by:

constructAppearances in class PDChoice

Throws:

IOException - if the appearance couldn't be generated