org.icepdf.core.pobjects.acroform

Class ChoiceFieldDictionary

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.acroform.FieldDictionary

org.icepdf.core.pobjects.acroform.VariableTextFieldDictionary

org.icepdf.core.pobjects.acroform.ChoiceFieldDictionary

public class ChoiceFieldDictionary
extends VariableTextFieldDictionary

The ChoiceFieldDictionary contains all the dictionary entries specific to the choice widget.

Since:

5.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChoiceFieldDictionary.ChoiceFieldType
class	ChoiceFieldDictionary.ChoiceOption

Nested classes/interfaces inherited from class org.icepdf.core.pobjects.acroform.VariableTextFieldDictionary

VariableTextFieldDictionary.Quadding

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHOICE_DO_NOT_SPELL_CHECK_BIT_FLAG (PDF 1.4) If set, text entered in the field shall not be spell-checked.
protected ChoiceFieldDictionary.ChoiceFieldType	choiceFieldType
static int	COMBO_BIT_FLAG If set, the field is a combo box; if clear, the field is a list box.
static int	COMMIT_ON_SEL_CHANGE_BIT_FLAG (PDF 1.5) If set, the new value shall be committed as soon as a selection is made (commonly with the pointing device).
static int	EDIT_BIT_FLAG If set, the combo box shall include an editable text box as well as a drop-down list; if clear, it shall include only a drop-down list.
static Name	I_KEY (Sometimes required, otherwise optional; PDF 1.4) For choice fields that allow multiple selection (MultiSelect flag set), an array of integers, sorted in ascending order, representing the zero-based indices in the Opt array of the currently selected option items.
protected java.util.ArrayList<java.lang.Integer>	indexes
static int	MULTI_SELECT_BIT_FLAG (PDF 1.4) If set, more than one of the field’s option items may be selected simultaneously; if clear, at most one item shall be selected.
static Name	OPT_KEY (Optional) An array of options that shall be presented to the user.
protected java.util.ArrayList<ChoiceFieldDictionary.ChoiceOption>	options
static int	SORT_BIT_FLAG If set, the field’s option items shall be sorted alphabetically.
static Name	TI_KEY (Optional) For scrollable list boxes, the top index (the index in the Opt array of the first option visible in the list).
protected int	topIndex

Fields inherited from class org.icepdf.core.pobjects.acroform.VariableTextFieldDictionary

color, DA_KEY, DS_KEY, fontName, Q_KEY, quadding, RV_KEY, size

Fields inherited from class org.icepdf.core.pobjects.acroform.FieldDictionary

AA_KEY, additionalActionsDictionary, alternativeFieldName, defaultFieldValue, DV_KEY, exportMappingName, Ff_KEY, fieldType, fieldValue, FT_KEY, kids, KIDS_KEY, NO_EXPORT_BIT_FLAG, PARENT_KEY, parentField, partialFieldName, READ_ONLY_BIT_FLAG, REQUIRED_BIT_FLAG, T_KEY, TM_KEY, TU_KEY, V_KEY

Fields inherited from class org.icepdf.core.pobjects.Dictionary

entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY

Constructor Summary

Constructors

Constructor and Description
ChoiceFieldDictionary(Library library, java.util.HashMap entries)

Method Summary

Modifier and Type	Method and Description
ChoiceFieldDictionary.ChoiceOption	buildChoiceOption(java.lang.String label, java.lang.String value)
ChoiceFieldDictionary.ChoiceFieldType	getChoiceFieldType()
java.util.ArrayList<java.lang.Integer>	getIndexes()
java.util.ArrayList<ChoiceFieldDictionary.ChoiceOption>	getOptions() An array of options that shall be presented to the user.
int	getTopIndex() For scrollable list boxes, the top index (the index in the Opt array of the first option visible in the list).
boolean	isCommitOnSetChange() If set, the new value shall be committed as soon as a selection is made (commonly with the pointing device).
boolean	isMultiSelect() If set, more than one of the field’s option items may be selected simultaneously; if clear, at most one item shall be selected.
boolean	isSortFields() If set, the field’s option items shall be sorted alphabetically.
void	setFieldValue(java.lang.Object fieldValue, Reference parentReference) Regular field value writing takes place as well as the update of the I (indexes) entry in the dictionary.
void	setIndexes(java.util.ArrayList<java.lang.Integer> indexes) For choice fields that allow multiple selection (MultiSelect flag set), an array of integers, sorted in ascending order, representing the zero-based indices in the Opt array of the currently selected option items.
void	setOptions(java.util.ArrayList<ChoiceFieldDictionary.ChoiceOption> options)
void	setTopIndex(int topIndex)

Methods inherited from class org.icepdf.core.pobjects.acroform.VariableTextFieldDictionary

getColor, getDefaultAppearance, getDefaultRichText, getDefaultStyle, getFontName, getQuadding, getSize, setFontName, setSize

Methods inherited from class org.icepdf.core.pobjects.acroform.FieldDictionary

getAdditionalActionsDictionary, getAlternativeFieldName, getDefaultFieldValue, getExportMappingName, getFieldType, getFieldValue, getFlags, getFullyQualifiedFieldName, getKids, getParent, getPartialFieldName, hasDefaultValue, hasFieldValue, isNoExport, isReadOnly, isRequired

Methods inherited from class org.icepdf.core.pobjects.Dictionary

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toString

Methods inherited from class java.lang.Object

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

Field Detail

OPT_KEY

public static final Name OPT_KEY

(Optional) An array of options that shall be presented to the user. Each element of the array is either a text string representing one of the available options or an array consisting of two text strings: the option’s export value and the text that shall be displayed as the name of the option.

If this entry is not present, no choices should be presented to the user.

TI_KEY

public static final Name TI_KEY

(Optional) For scrollable list boxes, the top index (the index in the Opt array of the first option visible in the list). Default value: 0.

I_KEY

public static final Name I_KEY

(Sometimes required, otherwise optional; PDF 1.4) For choice fields that allow multiple selection (MultiSelect flag set), an array of integers, sorted in ascending order, representing the zero-based indices in the Opt array of the currently selected option items. This entry shall be used when two or more elements in the Opt array have different names but the same export value or when the value of the choice field is an array. This entry should not be used for choice fields that do not allow multiple selection. If the items identified by this entry differ from those in the V entry of the field dictionary (see discussion following this Table), the V entry shall be used.

COMBO_BIT_FLAG

public static final int COMBO_BIT_FLAG

If set, the field is a combo box; if clear, the field is a list box.

See Also:

Constant Field Values

EDIT_BIT_FLAG

public static final int EDIT_BIT_FLAG

If set, the combo box shall include an editable text box as well as a drop-down list; if clear, it shall include only a drop-down list. This flag shall be used only if the Combo flag is set.

See Also:

Constant Field Values

SORT_BIT_FLAG

public static final int SORT_BIT_FLAG

If set, the field’s option items shall be sorted alphabetically. This flag is intended for use by writers, not by readers. Conforming readers shall display the options in the order in which they occur in the Opt array (see Table 231).

See Also:

Constant Field Values

MULTI_SELECT_BIT_FLAG

public static final int MULTI_SELECT_BIT_FLAG

(PDF 1.4) If set, more than one of the field’s option items may be selected simultaneously; if clear, at most one item shall be selected.

See Also:

Constant Field Values

CHOICE_DO_NOT_SPELL_CHECK_BIT_FLAG

public static final int CHOICE_DO_NOT_SPELL_CHECK_BIT_FLAG

(PDF 1.4) If set, text entered in the field shall not be spell-checked. This flag shall not be used unless the Combo and Edit flags are both set.

See Also:

Constant Field Values

COMMIT_ON_SEL_CHANGE_BIT_FLAG

public static final int COMMIT_ON_SEL_CHANGE_BIT_FLAG

(PDF 1.5) If set, the new value shall be committed as soon as a selection is made (commonly with the pointing device). In this case, supplying a value for a field involves three actions: selecting the field for fill-in, selecting a choice for the fill-in value, and leaving that field, which finalizes or “commits” the data choice and triggers any actions associated with the entry or changing of this data. If this flag is on, then processing does not wait for leaving the field action to occur, but immediately proceeds to the third step.

This option enables applications to perform an action once a selection is made, without requiring the user to exit the field. If clear, the new value is not committed until the user exits the field.

See Also:

Constant Field Values

choiceFieldType

protected ChoiceFieldDictionary.ChoiceFieldType choiceFieldType

options

protected java.util.ArrayList<ChoiceFieldDictionary.ChoiceOption> options

topIndex

protected int topIndex

indexes

protected java.util.ArrayList<java.lang.Integer> indexes

Constructor Detail

ChoiceFieldDictionary

public ChoiceFieldDictionary(Library library,
                             java.util.HashMap entries)

Method Detail

setFieldValue

public void setFieldValue(java.lang.Object fieldValue,
                          Reference parentReference)

Regular field value writing takes place as well as the update of the I (indexes) entry in the dictionary. TODO: Further work is needed to fully support multiSelect values.

Overrides:

setFieldValue in class FieldDictionary

Parameters:

fieldValue - value to write.

parentReference - parent reference.

buildChoiceOption

public ChoiceFieldDictionary.ChoiceOption buildChoiceOption(java.lang.String label,
                                                            java.lang.String value)

getChoiceFieldType

public ChoiceFieldDictionary.ChoiceFieldType getChoiceFieldType()

getTopIndex

public int getTopIndex()

For scrollable list boxes, the top index (the index in the Opt array of the first option visible in the list). Default value: 0.

Returns:

the top index of a scrollable list boxes.

setTopIndex

public void setTopIndex(int topIndex)

getIndexes

public java.util.ArrayList<java.lang.Integer> getIndexes()

setIndexes

public void setIndexes(java.util.ArrayList<java.lang.Integer> indexes)

For choice fields that allow multiple selection (MultiSelect flag set), an array of integers, sorted in ascending order, representing the zero-based indices in the Opt array of the currently selected option items. This entry shall be used when two or more elements in the Opt array have different names but the same export value or when the value of the choice field is an array. This entry should not be used for choice fields that do not allow multiple selection. If the items identified by this entry differ from those in the V entry of the field dictionary (see discussion following this Table), the V entry shall be used.

Parameters:

indexes - list of selected indexes for multiple selection.

getOptions

public java.util.ArrayList<ChoiceFieldDictionary.ChoiceOption> getOptions()

An array of options that shall be presented to the user. Each element of the array is either a text string representing one of the available options or an array consisting of two text strings: the option’s export value and the text that shall be displayed as the name of the option.

If this entry is not present, no choices should be presented to the user.

Returns:

choice options.

setOptions

public void setOptions(java.util.ArrayList<ChoiceFieldDictionary.ChoiceOption> options)

isSortFields

public boolean isSortFields()

If set, the field’s option items shall be sorted alphabetically. This flag is intended for use by writers, not by readers. Conforming readers shall display the options in the order in which they occur in the Opt array.

Returns:

true if field items are to be sorted.

isMultiSelect

public boolean isMultiSelect()

If set, more than one of the field’s option items may be selected simultaneously; if clear, at most one item shall be selected.

Returns:

true if more then one field can be selected, otherwise false.

isCommitOnSetChange

public boolean isCommitOnSetChange()

If set, the new value shall be committed as soon as a selection is made (commonly with the pointing device). In this case, supplying a value for a field involves three actions: selecting the field for fill-in, selecting a choice for the fill-in value, and leaving that field, which finalizes or “commits” the data choice and triggers any actions associated with the entry or changing of this data. If this flag is on, then processing does not wait for leaving the field action to occur, but immediately proceeds to the third step.

This option enables applications to perform an action once a selection is made, without requiring the user to exit the field. If clear, the new value is not committed until the user exits the field.

Returns:

true if commit on set change, otherwise false.