org.icepdf.core.pobjects.acroform

Class InteractiveForm

java.lang.Object

org.icepdf.core.pobjects.Dictionary

org.icepdf.core.pobjects.acroform.InteractiveForm

public class InteractiveForm
extends Dictionary

An interactive form (PDF 1.2)—sometimes referred to as an AcroForm is a collection of fields for gathering information interactively from the user. A PDF document may contain any number of fields appearing on any combination of pages, all of which make up a single, global interactive form spanning the entire document.

Each field in a document’s interactive form shall be defined by a field dictionary (see 12.7.3, “Field Dictionaries”). For purposes of definition and naming, the fields can be organized hierarchically and can inherit attributes from their ancestors in the field hierarchy. A field’s children in the hierarchy may also include widget annotations (see 12.5.6.19, “Widget Annotations”) that define its appearance on the page. A field that has children that are fields is called a non-terminal field. A field that does not have children that are fields is called a terminal field.

The contents and properties of a document’s interactive form shall be defined by an interactive form dictionary that shall be referenced from the AcroForm entry in the document catalogue (see 7.7.2, “Document Catalog”).

Since:

5.1

Field Summary

Fields

Modifier and Type	Field and Description
static Name	CO_KEY (Required if any fields in the document have additional-actions dictionaries containing a C entry; PDF 1.3) An array of indirect references to field dictionaries with calculation actions, defining the calculation order in which their values will be recalculated when the value of any field changes (see 12.6.3, “Trigger Events”).
static Name	DA_KEY (Optional) A document-wide default value for the DA attribute of variable text fields (see 12.7.3.3, “Variable Text”).
static Name	DR_KEY (Optional) A resource dictionary (see 7.8.3, “Resource Dictionaries”) containing default resources (such as fonts, patterns, or colour spaces) that shall be used by form field appearance streams.
static Name	FIELDS_KEY (Required) An array of references to the document’s root fields(those with no ancestors in the field hierarchy).
static Name	NEEDS_APPEARANCES_KEY (Optional) A flag specifying whether to construct appearance streams and appearance dictionaries for all widget annotations in the document (see 12.7.3.3, “Variable Text”).
static Name	Q_KEY (Optional) A document-wide default value for the Q attribute of variable text fields (see 12.7.3.3, “Variable Text”).
static int	SIG_FLAGS_APPEND_ONLY If set, the document contains signatures that may be invalidated if the file is saved (written) in a way that alters its previous contents, as opposed to an incremental update.
static Name	SIG_FLAGS_KEY (Optional; PDF 1.3) A set of flags specifying various document-level characteristics related to signature fields (see Table 219, and 12.7.4.5, “Signature Fields”).
static int	SIG_FLAGS_SIGNATURES_EXIST If set, the document contains at least one signature field.

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

Method Summary

Modifier and Type	Method and Description
java.util.List<Reference>	getCalculationOrder() Gets a list of indirect references to fields that have calculation actions, defining the calculation order in which values should be calculated when the value of any field changes.
java.lang.String	getDefaultVariableTextDAField() Gest the default variable text DA entry which can be helpful for rebuilding field data appearance streams.
int	getDefaultVariableTextQField() Ges the default variable text quadding rule.
java.util.ArrayList<java.lang.Object>	getFields() Gets the fields associated with this form.
Resources	getResources() Get the resources associated with the child widgets.
void	init() Initiate the Dictionary.
boolean	needAppearances() A flag specifying whether to construct appearance streams and appearance dictionaries for all widget annotations in the document.
boolean	signatureAppendOnly() If set, the document contains signatures that may be invalidated if the file is saved (written) in a way that alters its previous contents, as opposed to an incremental update
boolean	signatureExists() A set of flags specifying various document-level characteristics related to signature fields

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

getEntries, getFloat, getInt, getLibrary, getNumber, getObject, getPObjectReference, 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

FIELDS_KEY

public static final Name FIELDS_KEY

(Required) An array of references to the document’s root fields(those with no ancestors in the field hierarchy).

NEEDS_APPEARANCES_KEY

public static final Name NEEDS_APPEARANCES_KEY

(Optional) A flag specifying whether to construct appearance streams and appearance dictionaries for all widget annotations in the document (see 12.7.3.3, “Variable Text”). Default value: false.

SIG_FLAGS_KEY

public static final Name SIG_FLAGS_KEY

(Optional; PDF 1.3) A set of flags specifying various document-level characteristics related to signature fields (see Table 219, and 12.7.4.5, “Signature Fields”). Default value: 0.

CO_KEY

public static final Name CO_KEY

(Required if any fields in the document have additional-actions dictionaries containing a C entry; PDF 1.3) An array of indirect references to field dictionaries with calculation actions, defining the calculation order in which their values will be recalculated when the value of any field changes (see 12.6.3, “Trigger Events”).

DR_KEY

public static final Name DR_KEY

(Optional) A resource dictionary (see 7.8.3, “Resource Dictionaries”) containing default resources (such as fonts, patterns, or colour spaces) that shall be used by form field appearance streams. At a minimum, this dictionary shall contain a Font entry specifying the resource name and font dictionary of the default font for displaying text.

DA_KEY

public static final Name DA_KEY

(Optional) A document-wide default value for the DA attribute of variable text fields (see 12.7.3.3, “Variable Text”).

Q_KEY

public static final Name Q_KEY

(Optional) A document-wide default value for the Q attribute of variable text fields (see 12.7.3.3, “Variable Text”).

SIG_FLAGS_SIGNATURES_EXIST

public static final int SIG_FLAGS_SIGNATURES_EXIST

If set, the document contains at least one signature field. This flag allows a conforming reader to enable user interface items (such as menu items or pushbuttons) related to signature processing without having to scan the entire document for the presence of signature fields.

See Also:

Constant Field Values

SIG_FLAGS_APPEND_ONLY

public static final int SIG_FLAGS_APPEND_ONLY

If set, the document contains signatures that may be invalidated if the file is saved (written) in a way that alters its previous contents, as opposed to an incremental update. Merely updating the file by appending new information to the end of the previous version is safe (see H.7, “Updating Example”). Conforming readers may use this flag to inform a user requesting a full save that signatures will be invalidated and require explicit confirmation before continuing with the operation.

See Also:

Constant Field Values

Constructor Detail

InteractiveForm

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

Method Detail

init

public void init()

Description copied from class: Dictionary

Initiate the Dictionary. Retrieve any needed attributes.

Overrides:

init in class Dictionary

getFields

public java.util.ArrayList<java.lang.Object> getFields()

Gets the fields associated with this form.

Returns:

array of fields.

signatureExists

public boolean signatureExists()

A set of flags specifying various document-level characteristics related to signature fields

Returns:

true if enabled, false otherwise.

signatureAppendOnly

public boolean signatureAppendOnly()

If set, the document contains signatures that may be invalidated if the file is saved (written) in a way that alters its previous contents, as opposed to an incremental update

Returns:

true if enabled, false otherwise.

needAppearances

public boolean needAppearances()

A flag specifying whether to construct appearance streams and appearance dictionaries for all widget annotations in the document. Default value: false.

Returns:

true if appearance streams need to be generated, otherwise false.

getCalculationOrder

public java.util.List<Reference> getCalculationOrder()

Gets a list of indirect references to fields that have calculation actions, defining the calculation order in which values should be calculated when the value of any field changes.

Returns:

list of indirect references if present, otherwise null;

getResources

public Resources getResources()

Get the resources associated with the child widgets.

Returns:

common resources to all child widgets. Can be null.

getDefaultVariableTextDAField

public java.lang.String getDefaultVariableTextDAField()

Gest the default variable text DA entry which can be helpful for rebuilding field data appearance streams.

Returns:

default da values, null if not present.

getDefaultVariableTextQField

public int getDefaultVariableTextQField()

Ges the default variable text quadding rule.

Returns:

integer represented by VariableTextFieldDictionary.QUADDING_LEFT_JUSTIFIED, VariableTextFieldDictionary.QUADDING_CENTERED or VariableTextFieldDictionary.QUADDING_RIGHT_JUSTIFIED.