org.icepdf.core.pobjects.acroform

Class VariableTextFieldDictionary

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.acroform.FieldDictionary

org.icepdf.core.pobjects.acroform.VariableTextFieldDictionary

Direct Known Subclasses:

ButtonFieldDictionary, ChoiceFieldDictionary, TextFieldDictionary

public class VariableTextFieldDictionary
extends FieldDictionary

When the contents and properties of a field are known in advance, its visual appearance can be specified by an appearance stream defined in the PDF file (see 12.5.5, “Appearance Streams,” and 12.5.6.19, “Widget Annotations”). In some cases, however, the field may contain text whose value is not known until viewing time.

Since:

5.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VariableTextFieldDictionary.Quadding

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Color	color
static Name	DA_KEY The default appearance string containing a sequence of valid page-content graphics or text state operators that define such properties as the field’s text size and colour.
static Name	DS_KEY A default style string, as described in 12.7.3.4, “Rich Text Strings.”
protected java.lang.String	fontName
static Name	Q_KEY A code specifying the form of quadding (justification) that shall be used in displaying the text: 0 Left-justified 1 Centered 2 Right-justified Default value: 0 (left-justified).
protected VariableTextFieldDictionary.Quadding	quadding
static Name	RV_KEY A rich text string, as described in 12.7.3.4, “Rich Text Strings.”
protected int	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
VariableTextFieldDictionary(Library library, java.util.HashMap entries)

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getColor()
java.lang.String	getDefaultAppearance()
java.lang.String	getDefaultRichText()
java.lang.String	getDefaultStyle()
java.lang.String	getFontName()
VariableTextFieldDictionary.Quadding	getQuadding()
int	getSize()
void	setFontName(java.lang.String fontName)
void	setSize(int size)

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

DA_KEY

public static final Name DA_KEY

The default appearance string containing a sequence of valid page-content graphics or text state operators that define such properties as the field’s text size and colour.

Q_KEY

public static final Name Q_KEY

A code specifying the form of quadding (justification) that shall be used in displaying the text: 0 Left-justified 1 Centered 2 Right-justified Default value: 0 (left-justified).

DS_KEY

public static final Name DS_KEY

A default style string, as described in 12.7.3.4, “Rich Text Strings.”

RV_KEY

public static final Name RV_KEY

A rich text string, as described in 12.7.3.4, “Rich Text Strings.”

quadding

protected VariableTextFieldDictionary.Quadding quadding

size

protected int size

fontName

protected java.lang.String fontName

color

protected java.awt.Color color

Constructor Detail

VariableTextFieldDictionary

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

Method Detail

getSize

public int getSize()

getFontName

public java.lang.String getFontName()

setSize

public void setSize(int size)

setFontName

public void setFontName(java.lang.String fontName)

getColor

public java.awt.Color getColor()

getQuadding

public VariableTextFieldDictionary.Quadding getQuadding()

getDefaultAppearance

public java.lang.String getDefaultAppearance()

getDefaultStyle

public java.lang.String getDefaultStyle()

getDefaultRichText

public java.lang.String getDefaultRichText()