SubmitFormAction (ICEpdf API)

java.lang.Object
- org.icepdf.core.pobjects.Dictionary
- - org.icepdf.core.pobjects.actions.Action
  - - org.icepdf.core.pobjects.actions.FormAction
    - - org.icepdf.core.pobjects.actions.SubmitFormAction

```
public class SubmitFormAction
extends FormAction
```
Upon invocation of a submit-form action, a conforming processor shall transmit the names and values of selected interactive form fields to a specified uniform resource locator (URL).
The main function of this class is to interpret the F value against the submit bit flags and submit the form data and other data as needed.
Note: Some flagss are not yet supported, see flag _BIT constants for more information on support flags.

Since:

5.1

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`CANONICAL_FORMAT_BIT` (PDF 1.4) If set, any submitted field values representing dates shall be converted to the standard format described in 7.9.4, “Dates.” NOTE The interpretation of a form field as a date is not specified explicitly in the field itself but only in the JavaScript code that processes it.
`int`	`EMBED_FORM_BIT` (PDF 1.5) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear).
`int`	`EXCL_F_KEY_BIT` (PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear).
`int`	`EXCL_NON_USER_ANNOTS_BIT` (PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear) and the IncludeAnnotations flag is set.
`int`	`EXPORT_FORMAT_BIT` Meaningful only if the SubmitPDF and XFDF flags are clear.
`int`	`GET_METHOD_BIT` If set, field names and values shall be submitted using an HTTP GET request.
`int`	`INCLUDE_ANNOTATIONS_BIT` (PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF a nd ExportFormat flags are clear).
`int`	`INCLUDE_APPEND_SAVES_BIT` (PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear).
`int`	`INCLUDE_EXCLUDE_BIT` If clear, the Fields array (see Table 236) specifies which fields to include in the submission.
`int`	`INCLUDE_NO_VALUE_FIELDS_BIT` If set, all fields designated by the Fields array and the Include/Exclude flag shall be submitted, regardless of whether they have a value (V entry in the field dictionary).
`int`	`SUBMIT_COORDINATES_BIT` If set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data.
`int`	`SUBMIT_PDF_BIT` (PDF 1.4) If set, the document shall be submitted as PDF, using the MIME content type application/pdf (described in Internet RFC 2045, Multipurpose Internet Mail Extensions (MIME), Part One: Format of Internet Message Bodies; see the Bibliography).
`int`	`XFDF_BIT` (PDF 1.4) shall be used only if the SubmitPDF flags are clear.

Fields inherited from class org.icepdf.core.pobjects.actions.FormAction
F_KEY, FIELDS_KEY, FLAGS_KEY

Fields inherited from class org.icepdf.core.pobjects.actions.Action
ACTION_TYPE, ACTION_TYPE_GOTO, ACTION_TYPE_GOTO_REMOTE, ACTION_TYPE_JAVA_SCRIPT, ACTION_TYPE_KEY, ACTION_TYPE_LAUNCH, ACTION_TYPE_NAMED, ACTION_TYPE_RESET_SUBMIT, ACTION_TYPE_SUBMIT_SUBMIT, ACTION_TYPE_URI, NEXT_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

SubmitFormAction(Library l, java.util.HashMap h)

Constructors
Constructor and Description
`SubmitFormAction(Library l, java.util.HashMap h)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`descendFormTree(java.lang.Object formNode, java.util.HashMap<java.lang.String,java.lang.String> params)` Dive into the hierarchy to get the name value pairs of the fields.
`int`	`executeFormAction(int x, int y)` Execute the form submission.
`java.util.List`	`getFields()` An array identifying which fields to reset or which to exclude from resetting, depending on the setting of the Include/Exclude flag in the Flags entry (see Table 239).
`FileSpecification`	`getFileSpecification()`
`boolean`	`isCanonicalFormat()`
`boolean`	`isEmbedForm()`
`boolean`	`isExcludeFKey()`
`boolean`	`isExcludeNonUserAnnots()`
`boolean`	`isExportFormat()`
`boolean`	`isGetMethod()`
`boolean`	`isIncludeAnnotations()`
`boolean`	`isIncludeAppendSaves()`
`boolean`	`isIncludeExclude()`
`boolean`	`isIncludeNoValueFields()`
`boolean`	`isSubmitCoordinates()`
`boolean`	`isSubmitPDF()`
`boolean`	`isXFDF()`

Methods inherited from class org.icepdf.core.pobjects.actions.FormAction
getFlags

Methods inherited from class org.icepdf.core.pobjects.actions.Action
buildAction, getType, similar

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
  - INCLUDE_EXCLUDE_BIT
```
public int INCLUDE_EXCLUDE_BIT
```
    If clear, the Fields array (see Table 236) specifies which fields to include in the submission. (All descendants of the specified fields in the field hierarchy shall be submitted as well.)
    If set, the Fields array tells which fields to exclude. All fields in the document’s interactive form shall be submitted except those listed in the Fields array and those whose NoExport flag (see Table 221) is set and fields with no values if the IncludeNoValueFields flag is clear.
  - INCLUDE_NO_VALUE_FIELDS_BIT
```
public int INCLUDE_NO_VALUE_FIELDS_BIT
```
    If set, all fields designated by the Fields array and the Include/Exclude flag shall be submitted, regardless of whether they have a value (V entry in the field dictionary). For fields without a value, only the field name shall be transmitted.
    If clear, fields without a value shall not be submitted.
  - EXPORT_FORMAT_BIT
```
public int EXPORT_FORMAT_BIT
```
    Meaningful only if the SubmitPDF and XFDF flags are clear. If set, field names and values shall be submitted in HTML Form format. If clear, they shall be submitted in Forms Data Format (FDF); see 12.7.7, “Forms Data Format.”
  - GET_METHOD_BIT
```
public int GET_METHOD_BIT
```
    If set, field names and values shall be submitted using an HTTP GET request. If clear, they shall be submitted using a POST request. This flag is meaningful only when the ExportFormat flag is set; if ExportFormat is clear, this flag shall also be clear.
  - SUBMIT_COORDINATES_BIT
```
public int SUBMIT_COORDINATES_BIT
```
    If set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data. The coordinate values are relative to the upper-left corner of the field’s widget annotation rectangle. They shall be represented in the data in the format
    name.x=xval&name.y=yval
    where name is the field’s mapping name (TM in the field dictionary) if present; otherwise, name is the field name. If the value of the TM entry is a single ASCII SPACE (20h) character, both the name and the ASCII PERIOD (2Eh) following it shall be suppressed, resulting in the format
    x=xval&y=yval
    This flag shall be used only when the ExportFormat flag is set. If ExportFormat is clear, this flag shall also be clear
  - XFDF_BIT
```
public int XFDF_BIT
```
    (PDF 1.4) shall be used only if the SubmitPDF flags are clear. If set, field names and values shall be submitted as XFDF.
  - INCLUDE_APPEND_SAVES_BIT
```
public int INCLUDE_APPEND_SAVES_BIT
```
    (PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear). If set, the submitted FDF file shall include the contents of all incremental updates to the underlying PDF document, as contained in the Differences entry in the FDF dictionary (see Table 243). If clear, the incremental updates shall not be included.
  - INCLUDE_ANNOTATIONS_BIT
```
public int INCLUDE_ANNOTATIONS_BIT
```
    (PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF a nd ExportFormat flags are clear). If set, the submitted FDF file shall include includes all markup annotations in the underlying PDF document (see 12.5.6.2, “Markup Annotations”). If clear, markup annotations shall not be included.
  - SUBMIT_PDF_BIT
```
public int SUBMIT_PDF_BIT
```
    (PDF 1.4) If set, the document shall be submitted as PDF, using the MIME content type application/pdf (described in Internet RFC 2045, Multipurpose Internet Mail Extensions (MIME), Part One: Format of Internet Message Bodies; see the Bibliography). If set, all other flags shall be ignored except GetMethod.
  - CANONICAL_FORMAT_BIT
```
public int CANONICAL_FORMAT_BIT
```
    (PDF 1.4) If set, any submitted field values representing dates shall be converted to the standard format described in 7.9.4, “Dates.”
    NOTE
    The interpretation of a form field as a date is not specified explicitly in the field itself but only in the JavaScript code that processes it.
  - EXCL_NON_USER_ANNOTS_BIT
```
public int EXCL_NON_USER_ANNOTS_BIT
```
    (PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear) and the IncludeAnnotations flag is set. If set, it shall include only those markup annotations whose T entry (see Table 170) matches the name of the current user, as determined by the remote server to which the form is being submitted.
    NOTE 1
    The T entry for markup annotations specifies the text label that is displayed in the title bar of the annotation’s pop-up window and is assumed to represent the name of the user authoring the annotation.
    NOTE 2
    This allows multiple users to collaborate in annotating a single remote PDF document without affecting one another’s annotations.
  - EXCL_F_KEY_BIT
```
public int EXCL_F_KEY_BIT
```
    (PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear). If set, the submitted FDF shall exclude the F entry.
  - EMBED_FORM_BIT
```
public int EMBED_FORM_BIT
```
    (PDF 1.5) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear). If set, the F entry of the submitted FDF shall be a file specification containing an embedded file stream representing the PDF file from which the FDF is being submitted.
- Constructor Detail
  - SubmitFormAction
```
public SubmitFormAction(Library l,
                        java.util.HashMap h)
```
- Method Detail
  - getFields
```
public java.util.List getFields()
```
    An array identifying which fields to reset or which to exclude from resetting, depending on the setting of the Include/Exclude flag in the Flags entry (see Table 239). Each element of the array shall be either an indirect reference to a field dictionary or (PDF 1.3) a text string representing the fully qualified name of a field. Elements of both kinds may be mixed in the same array.
    If this entry is omitted, the Include/Exclude flag shall be ignored, and all fields in the document’s interactive form shall be submitted except those whose NoExport flag (see Table 221) is set. Fields with no values may also be excluded, as dictated by the value of the IncludeNoValueFields flag; see Table 237.
    
    Returns:
    
    list of fields if present otherwise null.
  - getFileSpecification
```
public FileSpecification getFileSpecification()
```
  - executeFormAction
```
public int executeFormAction(int x,
                             int y)
```
    Execute the form submission. The following formats are currently supported:
    - HTML Form format
    - Forms Data Format(not supported)
    - XFDF(not supported)
    - PDF (not supported)
    Specified by:
    
    executeFormAction in class FormAction
    
    Parameters:
    
    x - x-coordinate of the mouse event that actuated the submit.
    
    y - y-coordinate of the mouse event that actuated the submit.
    
    Returns:
    
    value of one if submit was successful, zero if not.
  - descendFormTree
```
protected void descendFormTree(java.lang.Object formNode,
                               java.util.HashMap<java.lang.String,java.lang.String> params)
```
    Dive into the hierarchy to get the name value pairs of the fields. Currently not recursive as we don't have any example to test against.
    
    Parameters:
    
    formNode - root form node.
    
    params - name value pars of form fields.
  - isIncludeExclude
```
public boolean isIncludeExclude()
```
    See Also:
    
    INCLUDE_EXCLUDE_BIT
  - isIncludeNoValueFields
```
public boolean isIncludeNoValueFields()
```
    See Also:
    
    INCLUDE_NO_VALUE_FIELDS_BIT
  - isExportFormat
```
public boolean isExportFormat()
```
    See Also:
    
    EXPORT_FORMAT_BIT
  - isGetMethod
```
public boolean isGetMethod()
```
    See Also:
    
    GET_METHOD_BIT
  - isSubmitCoordinates
```
public boolean isSubmitCoordinates()
```
    See Also:
    
    SUBMIT_COORDINATES_BIT
  - isXFDF
```
public boolean isXFDF()
```
    See Also:
    
    SUBMIT_COORDINATES_BIT
  - isIncludeAppendSaves
```
public boolean isIncludeAppendSaves()
```
    See Also:
    
    INCLUDE_APPEND_SAVES_BIT
  - isIncludeAnnotations
```
public boolean isIncludeAnnotations()
```
    See Also:
    
    INCLUDE_ANNOTATIONS_BIT
  - isSubmitPDF
```
public boolean isSubmitPDF()
```
    See Also:
    
    SUBMIT_PDF_BIT
  - isCanonicalFormat
```
public boolean isCanonicalFormat()
```
    See Also:
    
    CANONICAL_FORMAT_BIT
  - isExcludeNonUserAnnots
```
public boolean isExcludeNonUserAnnots()
```
    See Also:
    
    EXCL_NON_USER_ANNOTS_BIT
  - isExcludeFKey
```
public boolean isExcludeFKey()
```
    See Also:
    
    EXCL_F_KEY_BIT
  - isEmbedForm
```
public boolean isEmbedForm()
```
    See Also:
    
    EMBED_FORM_BIT

Class SubmitFormAction

Field Summary

Fields inherited from class org.icepdf.core.pobjects.actions.FormAction

Fields inherited from class org.icepdf.core.pobjects.actions.Action

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

Constructor Summary

Method Summary

Methods inherited from class org.icepdf.core.pobjects.actions.FormAction

Methods inherited from class org.icepdf.core.pobjects.actions.Action

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

Methods inherited from class java.lang.Object

Field Detail

INCLUDE_EXCLUDE_BIT

INCLUDE_NO_VALUE_FIELDS_BIT

EXPORT_FORMAT_BIT

GET_METHOD_BIT

SUBMIT_COORDINATES_BIT

XFDF_BIT

INCLUDE_APPEND_SAVES_BIT

INCLUDE_ANNOTATIONS_BIT

SUBMIT_PDF_BIT

CANONICAL_FORMAT_BIT

EXCL_NON_USER_ANNOTS_BIT

EXCL_F_KEY_BIT

EMBED_FORM_BIT

Constructor Detail

SubmitFormAction

Method Detail

getFields

getFileSpecification

executeFormAction

descendFormTree

isIncludeExclude

isIncludeNoValueFields

isExportFormat

isGetMethod

isSubmitCoordinates

isXFDF

isIncludeAppendSaves

isIncludeAnnotations

isSubmitPDF

isCanonicalFormat

isExcludeNonUserAnnots

isExcludeFKey

isEmbedForm