org.icepdf.core.pobjects.acroform

Class TextFieldDictionary

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.TextFieldDictionary

public class TextFieldDictionary
extends VariableTextFieldDictionary

Text field (field type Tx) is a box or space for text fill-in data typically entered from a keyboard. The text may be restricted to a single line or may be permitted to span multiple lines, depending on the setting of the Multi line flag in the field dictionary’s Ff entry. Table 228 shows the flags pertaining to this type of field. A text field shall have a field type of Tx. A conforming PDF file, and a conforming processor shall obey the usage guidelines as defined by the big flags below.

The field’s text shall be held in a text string (or, beginning with PDF 1.5, a stream) in the V (value) entry of the field dictionary. The contents of this text string or stream shall be used to construct an appearance stream for displaying the field, as described under 12.7.3.3, “Variable Text.” The text shall be presented in a single style (font, size, colour, and so forth), as specified by the DA (default appearance) string.

If the FileSelect flag (PDF 1.4) is set, the field shall function as a file-select control. In this case, the field’s text represents the pathname of a file whose contents shall be submitted as the field’s value:

• For fields submitted in HTML Form format, the submission shall use the MIME content type multipart/form-data, as described in Internet RFC 2045, Multipurpose Internet Mail Extensions (MIME), Part One: Format of Internet Message Bodies (see the Bibliography).
• For Forms Data Format (FDF) submission, the value of the V entry in the FDF field dictionary (see FDF Fields in 12.7.7.3, “FDF Catalog”) shall be a file specification (7.11, “File Specifications”) identifying the selected file.
• XML format is not supported for file-select controls; therefore, no value shall be submitted in this case.

Besides the usual entries common to all fields (see Table 220) and to fields containing variable text (see Table 222), the field dictionary for a text field may contain the additional entry shown in Table 229.

Since:

5.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextFieldDictionary.TextFieldType

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	COMB_BIT_FLAG (PDF 1.5) May be set only if the MaxLen entry is present in the text field dictionary (see Table 229) and if the Multiline, Password, and FileSelect flags are clear.
static int	DO_NOT_SCROLL_BIT_FLAG (PDF 1.4) If set, the field shall not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle.
static int	FILE_SELECT_BIT_FLAG (PDF 1.4) If set, the text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field.
static Name	MAX_LENGTH_KEY The maximum length of the fields text, in characters.
protected int	maxLength
static int	MULTILINE_BIT_FLAG (Radio buttons only) If set, exactly one radio button shall be selected at all times; selecting the currently selected button has no effect.
static int	PASSWORD_BIT_FLAG should not be echoed visibly to the screen.
static int	RICH_TEXT_BIT_FLAG (PDF 1.5) If set, the value of this field shall be a rich text string (see 12.7.3.4, “Rich Text Strings”).
static int	TEXT_DO_NOT_SPELL_CHECK_BIT_FLAG (PDF 1.4) If set, text entered in the field shall not be spell-checked.
protected TextFieldDictionary.TextFieldType	textFieldType

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
TextFieldDictionary(Library library, java.util.HashMap entries)

Method Summary

Modifier and Type	Method and Description
int	getMaxLength()
TextFieldDictionary.TextFieldType	getTextFieldType()
boolean	isComb() May be set only if the MaxLen entry is present in the text field dictionary (see Table 229) and if the Multiline, Password, and FileSelect flags are clear.
boolean	isDoNotScroll() If set, the field shall not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle.
boolean	isFileSelect() Filed is a file select component.
boolean	isMultiLine() Field may container multiple lines of text.
boolean	isRichText() If set, the value of this field shall be a rich text string (see 12.7.3.4, “Rich Text Strings”).

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, setFieldValue

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

MAX_LENGTH_KEY

public static final Name MAX_LENGTH_KEY

The maximum length of the fields text, in characters.

MULTILINE_BIT_FLAG

public static final int MULTILINE_BIT_FLAG

(Radio buttons only) If set, exactly one radio button shall be selected at all times; selecting the currently selected button has no effect. If clear, clicking the selected button deselects it, leaving no button selected.

See Also:

Constant Field Values

PASSWORD_BIT_FLAG

public static final int PASSWORD_BIT_FLAG

should not be echoed visibly to the screen. Characters typed from the keyboard shall instead be echoed in some unreadable form, such as asterisks or bullet characters. NOTE: To protect password confidentiality, readers should never store the value of the text field in the PDF file if this flag is set.

See Also:

Constant Field Values

FILE_SELECT_BIT_FLAG

public static final int FILE_SELECT_BIT_FLAG

(PDF 1.4) If set, the text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field.

See Also:

Constant Field Values

TEXT_DO_NOT_SPELL_CHECK_BIT_FLAG

public static final int TEXT_DO_NOT_SPELL_CHECK_BIT_FLAG

(PDF 1.4) If set, text entered in the field shall not be spell-checked.

See Also:

Constant Field Values

DO_NOT_SCROLL_BIT_FLAG

public static final int DO_NOT_SCROLL_BIT_FLAG

(PDF 1.4) If set, the field shall not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text shall be accepted for interactive form filling; for non-interactive form filling, the filler should take care not to add more character than will visibly fit in the defined area.

See Also:

Constant Field Values

COMB_BIT_FLAG

public static final int COMB_BIT_FLAG

(PDF 1.5) May be set only if the MaxLen entry is present in the text field dictionary (see Table 229) and if the Multiline, Password, and FileSelect flags are clear. If set, the field shall be automatically divided into as many equally spaced positions, or combs, as the value of MaxLen, and the text is laid out into those combs.

See Also:

Constant Field Values

RICH_TEXT_BIT_FLAG

public static final int RICH_TEXT_BIT_FLAG

(PDF 1.5) If set, the value of this field shall be a rich text string (see 12.7.3.4, “Rich Text Strings”). If the field has a value, the RV entry of the field dictionary (Table 222) shall specify the rich text string.

See Also:

Constant Field Values

textFieldType

protected TextFieldDictionary.TextFieldType textFieldType

maxLength

protected int maxLength

Constructor Detail

TextFieldDictionary

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

Method Detail

getMaxLength

public int getMaxLength()

getTextFieldType

public TextFieldDictionary.TextFieldType getTextFieldType()

isMultiLine

public boolean isMultiLine()

Field may container multiple lines of text.

Returns:

true if multiline text, otherwise false.

isFileSelect

public boolean isFileSelect()

Filed is a file select component.

Returns:

true if file select, otherwise false.

isDoNotScroll

public boolean isDoNotScroll()

If set, the field shall not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text shall be accepted for interactive form filling; for non-interactive form filling, the filler should take care not to add more character than will visibly fit in the defined area.

Returns:

true if do not scroll is enabled, otherwise false.

isComb

public boolean isComb()

May be set only if the MaxLen entry is present in the text field dictionary (see Table 229) and if the Multiline, Password, and FileSelect flags are clear. If set, the field shall be automatically divided into as many equally spaced positions, or combs, as the value of MaxLen, and the text is laid out into those combs.

Returns:

true if comb is enabled, otherwise false.

isRichText

public boolean isRichText()

If set, the value of this field shall be a rich text string (see 12.7.3.4, “Rich Text Strings”). If the field has a value, the RV entry of the field dictionary (Table 222) shall specify the rich text string.

Returns:

true if file select, otherwise false.