public class FieldDictionary extends Dictionary
| Modifier and Type | Field and Description |
|---|---|
static Name |
AA_KEY
(Optional; PDF 1.2) An additional-actions dictionary defining the field’s
behaviour in response to various trigger events (see 12.6.3, “Trigger Events”).
|
protected AdditionalActionsDictionary |
additionalActionsDictionary |
protected java.lang.String |
alternativeFieldName |
protected java.lang.Object |
defaultFieldValue |
static Name |
DV_KEY
(Optional; inheritable) The default value to which the field reverts when
a reset-form action is executed (see 12.7.5.3, “Reset-Form Action”).
|
protected java.lang.String |
exportMappingName |
static Name |
Ff_KEY
(Optional; inheritable) A set of flags specifying various characteristics
of the field (see Table 221).
|
protected Name |
fieldType |
protected java.lang.Object |
fieldValue |
static Name |
FT_KEY
Required for terminal fields; inheritable) The type of field that this
dictionary describes:
Button -> Button (see 12.7.4.2, “Button Fields”)
Text -> Text (see 12.7.4.3, “Text Fields”)
Choice -> Choice (see 12.7.4.4, “Choice Fields”)
Signature(PDF 1.3) -> Signature (see 12.7.4.5, “Signature Fields”)
This entry may be present in a non-terminal field (one whose descendants
are fields) to provide an inheritable FT value.
|
protected java.util.ArrayList<java.lang.Object> |
kids |
static Name |
KIDS_KEY
(Sometimes required, as described below) An array of indirect references
to the immediate children of this field.
|
static int |
NO_EXPORT_BIT_FLAG
If set, the field shall not be exported by a submit-form action (see 12.7.5.2, “Submit-Form Action”).
|
static Name |
PARENT_KEY
(Required if this field is the child of another in the field hierarchy;
absent otherwise) The field that is the immediate parent of this one (the
field, if any, whose Kids array includes this field).
|
protected FieldDictionary |
parentField |
protected java.lang.String |
partialFieldName |
static int |
READ_ONLY_BIT_FLAG
If set, the user may not change the value of the field.
|
static int |
REQUIRED_BIT_FLAG
If set, the field shall have a value at the time it is exported by a
submit-form action (see 12.7.5.2, “Submit-Form Action”).
|
static Name |
T_KEY
(Optional) The partial field name (see 12.7.3.2, “Field Names”).
|
static Name |
TM_KEY
(Optional; PDF 1.3) The mapping name that shall be used when exporting
interactive form field data from the document.
|
static Name |
TU_KEY
(Optional; PDF 1.3) An alternate field name that shall be used in place
of the actual field name wherever the field shall be identified in the
user interface (such as in error or status messages referring to the field).
|
static Name |
V_KEY
(Optional; inheritable) The field’s value, whose format varies depending
on the field type.
|
entries, FORM_TYPE_KEY, inited, isDeleted, isNew, LENGTH_KEY, library, SUBTYPE_KEY, TYPE_KEY| Constructor and Description |
|---|
FieldDictionary(Library library,
java.util.HashMap entries) |
| Modifier and Type | Method and Description |
|---|---|
AdditionalActionsDictionary |
getAdditionalActionsDictionary() |
java.lang.String |
getAlternativeFieldName() |
java.lang.Object |
getDefaultFieldValue() |
java.lang.String |
getExportMappingName() |
Name |
getFieldType() |
java.lang.Object |
getFieldValue() |
int |
getFlags() |
java.lang.String |
getFullyQualifiedFieldName()
The T entry in the field dictionary (see Table 220) holds a text string defining the field’s partial field name.
|
java.util.ArrayList<java.lang.Object> |
getKids()
Gets the kids of of terminal and non terminal fields.
|
FieldDictionary |
getParent() |
java.lang.String |
getPartialFieldName() |
boolean |
hasDefaultValue() |
boolean |
hasFieldValue() |
boolean |
isNoExport()
If set, the field shall not be exported by a submit-form action.
|
boolean |
isReadOnly()
If set, the user may not change the value of the field.
|
boolean |
isRequired()
If set, the field shall have a value at the time it is exported by a submit-form action
|
void |
setFieldValue(java.lang.Object fieldValue,
Reference parentReference)
Set the value field of the field dictionary (/V).
|
getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, init, isDeleted, isNew, setDeleted, setNew, setPObjectReference, toStringpublic static final Name FT_KEY
public static final Name KIDS_KEY
public static final Name PARENT_KEY
public static final Name T_KEY
public static final Name TU_KEY
public static final Name TM_KEY
public static final Name Ff_KEY
public static final Name V_KEY
public static final Name DV_KEY
public static final Name AA_KEY
public static final int READ_ONLY_BIT_FLAG
public static final int REQUIRED_BIT_FLAG
public static final int NO_EXPORT_BIT_FLAG
protected Name fieldType
protected FieldDictionary parentField
protected java.util.ArrayList<java.lang.Object> kids
protected java.lang.String partialFieldName
protected java.lang.String alternativeFieldName
protected java.lang.String exportMappingName
protected java.lang.Object fieldValue
protected java.lang.Object defaultFieldValue
protected AdditionalActionsDictionary additionalActionsDictionary
public FieldDictionary(Library library, java.util.HashMap entries)
public java.util.ArrayList<java.lang.Object> getKids()
public FieldDictionary getParent()
public Name getFieldType()
public int getFlags()
public java.lang.String getPartialFieldName()
public java.lang.String getAlternativeFieldName()
public java.lang.String getExportMappingName()
public boolean isReadOnly()
public boolean isRequired()
public boolean isNoExport()
public java.lang.String getFullyQualifiedFieldName()
public java.lang.Object getFieldValue()
public boolean hasFieldValue()
public boolean hasDefaultValue()
public void setFieldValue(java.lang.Object fieldValue,
Reference parentReference)
fieldValue - value to write.parentReference - parent reference.public java.lang.Object getDefaultFieldValue()
public AdditionalActionsDictionary getAdditionalActionsDictionary()