| java.lang.Object | ||
| ↳ | java.lang.Enum<E extends java.lang.Enum<E>> | |
| ↳ | com.pspdfkit.annotations.actions.SubmitFormAction.SubmitFormActionFlag | |
Class Overview
Flags specifying various characteristics of form submit action.
Summary
| Enum Values | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| SubmitFormAction.SubmitFormActionFlag | CANONICAL_FORMAT | If set, any submitted field values representing dates shall be converted to the standard PDF format. | |||||||||
| SubmitFormAction.SubmitFormActionFlag | EMBED_FORM | If set, form submission data shall include embedded file stream representing the PDF file from which the data is being submitted. | |||||||||
| SubmitFormAction.SubmitFormActionFlag | EXCLUDE_NON_USER_ANNOTATIONS | If set, it form submission data shall include only those annotations whose creator property matches the name of the current user. | |||||||||
| SubmitFormAction.SubmitFormActionFlag | EXPORT_FORMAT | If set, field names and values shall be submitted in HTML Form format. | |||||||||
| SubmitFormAction.SubmitFormActionFlag | GET_METHOD | If set, field names and values shall be submitted using an HTTP GET request. | |||||||||
| SubmitFormAction.SubmitFormActionFlag | INCLUDE_ANNOTATIONS | If set, the submitted FDF file shall include all annotations in the underlying PDF document. | |||||||||
| SubmitFormAction.SubmitFormActionFlag | INCLUDE_APPEND_SAVES | If set, the submitted FDF file shall include the contents of all incremental updates to the underlying PDF document. | |||||||||
| SubmitFormAction.SubmitFormActionFlag | INCLUDE_EXCLUDE | If set, the getFieldNames() specifies fields to exclude from submit action. |
|||||||||
| SubmitFormAction.SubmitFormActionFlag | INCLUDE_NO_VALUE_FIELDS | If set, the target fields (getFormFieldsAsync(PdfDocument)) shall be submitted
regardless of whether they have a value. |
|||||||||
| SubmitFormAction.SubmitFormActionFlag | SUBMIT_COORDINATES | If set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data. | |||||||||
| SubmitFormAction.SubmitFormActionFlag | SUBMIT_PDF | If set, the document shall be submitted as PDF, using the MIME content type application/pdf. | |||||||||
| SubmitFormAction.SubmitFormActionFlag | XFDF | If set, field names and values shall be submitted as XFDF. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static SubmitFormAction.SubmitFormActionFlag | valueOf(String name) | ||||||||||
| final static SubmitFormActionFlag[] | values() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Enum
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.Comparable
| |||||||||||
Enum Values
public static final SubmitFormAction.SubmitFormActionFlag CANONICAL_FORMAT
If set, any submitted field values representing dates shall be converted to the standard PDF format.
public static final SubmitFormAction.SubmitFormActionFlag EMBED_FORM
If set, form submission data shall include embedded file stream representing the PDF file from which the data is being submitted.
This flag shall be used only when the form is being submitted in Forms Data Format
(that is, when both the XFDF and EXPORT_FORMAT flags are clear).
public static final SubmitFormAction.SubmitFormActionFlag EXCLUDE_NON_USER_ANNOTATIONS
If set, it form submission data shall include only those annotations whose creator property matches the name of the current user.
This flag shall be used only when the form is being submitted in Forms Data Format
(that is, when both the XFDF and EXPORT_FORMAT flags are clear).
public static final SubmitFormAction.SubmitFormActionFlag EXPORT_FORMAT
If set, field names and values shall be submitted in HTML Form format. If not set, they shall be submitted in Forms Data format (FDF).
Meaningful only if the SUBMIT_PDF and XFDF flags are not set.
public static final SubmitFormAction.SubmitFormActionFlag GET_METHOD
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 EXPORT_FORMAT flag is set. If EXPORT_FORMAT flag is not set, this flag also should not be set.
public static final SubmitFormAction.SubmitFormActionFlag INCLUDE_ANNOTATIONS
If set, the submitted FDF file shall include all annotations in the underlying PDF document.
This flag shall be used only when the form is being submitted in Forms Data Format
(that is, when both the XFDF and EXPORT_FORMAT flags are clear).
public static final SubmitFormAction.SubmitFormActionFlag INCLUDE_APPEND_SAVES
If set, the submitted FDF file shall include the contents of all incremental updates to the underlying PDF document.
This flag shall be used only when the form is being submitted in Forms Data Format
(that is, when both the XFDF and EXPORT_FORMAT flags are clear).
public static final SubmitFormAction.SubmitFormActionFlag INCLUDE_EXCLUDE
If set, the getFieldNames() specifies fields to exclude from submit action. If
not set, the getFieldNames() specifies which fields to include in the
submission.
public static final SubmitFormAction.SubmitFormActionFlag INCLUDE_NO_VALUE_FIELDS
If set, the target fields (getFormFieldsAsync(PdfDocument)) shall be submitted
regardless of whether they have a value. If not set, fields without a value shall not be
submitted.
public static final SubmitFormAction.SubmitFormActionFlag SUBMIT_COORDINATES
If set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data.
This flag shall be used only when the EXPORT_FORMAT flag is set. If EXPORT_FORMAT flag is not set, this flag also should not be set.
public static final SubmitFormAction.SubmitFormActionFlag SUBMIT_PDF
If set, the document shall be submitted as PDF, using the MIME content type
application/pdf. If set, all other flags shall be ignored except GET_METHOD.
public static final SubmitFormAction.SubmitFormActionFlag XFDF
If set, field names and values shall be submitted as XFDF.
This flag shall be used only if the SUBMIT_PDF flag is not set.