Foxit PDF SDK
com.foxit.sdk.pdf.PagingSealSignature Class Reference
Inheritance diagram for com.foxit.sdk.pdf.PagingSealSignature:
com.foxit.sdk.pdf.Signature com.foxit.sdk.pdf.interform.Field com.foxit.sdk.common.Base

Public Member Functions

synchronized void delete ()
 Clean up related resources immediately. More...
 
boolean generateAppearance () throws com.foxit.sdk.PDFException
 Generate the appearance of paging seal signature.
More...
 
void setAPStateBitmap (int ap_state, Bitmap bitmap) throws com.foxit.sdk.PDFException
 Set a bitmap for the appearance of signature state.
More...
 
void setPagingSealConfig (PagingSealConfig paging_seal_config) throws com.foxit.sdk.PDFException
 Set the config of paging seal signature.
More...
 
- Public Member Functions inherited from com.foxit.sdk.pdf.Signature
 Signature (Field field)
 Constructor, with parent class object.
More...
 
 Signature (PDFDoc document, PDFDictionary sig_field_dict)
 Constructor, from signature field dictionary.
More...
 
boolean clearSignedData () throws com.foxit.sdk.PDFException
 Clear the data and appearance if current signature is singed and verified valid.
More...
 
void enableEmbedFont (boolean enable_embed_font)
 Enable or disable embed font.
More...
 
void enableIncrementalSaveForFirstSigning (boolean enable_incremental_save)
 Enable or disable incremental save for first signing. User should call this function before calling function Signature.startSign .
Default: false.
More...
 
int getAppearanceFlags () throws com.foxit.sdk.PDFException
 Get signature appearance flags.
More...
 
Bitmap getBitmap () throws com.foxit.sdk.PDFException
 Get a bitmap which is used for the signature appearance.
More...
 
boolean getByteRangeArray (int[] out_byte_range_array) throws com.foxit.sdk.PDFException
 Get the byte ranges data, including 4 elements.
More...
 
String getCert (int index) throws com.foxit.sdk.PDFException
 Get a certificate from current signature's certificate chain by index.
More...
 
int getCertCount () throws com.foxit.sdk.PDFException
 Get the count of certificates in current signature's certificate chain.
More...
 
String getCertificateInfo (String key) throws com.foxit.sdk.PDFException
 Get certificate information.
More...
 
int getDocPermission () throws com.foxit.sdk.PDFException
 Get document permission for current signature.
More...
 
PDFDoc getDocument () throws com.foxit.sdk.PDFException
 Get the PDF document, which current signature belongs to.
More...
 
int getFieldMDPAction () throws com.foxit.sdk.PDFException
 Get FieldMDP("MDP" means modification detection and prevention) action type.
More...
 
WStringArray getFieldMDPActionFields () throws com.foxit.sdk.PDFException
 Get the field name array which is used for FieldMDP action.
More...
 
String getFilter () throws com.foxit.sdk.PDFException
 Get filter.
More...
 
String getKeyLabel (int label_name) throws com.foxit.sdk.PDFException
 Get the string for specified key label.
More...
 
String getKeyValue (int key) throws com.foxit.sdk.PDFException
 Get the string value for specified key name.
More...
 
int getPAdESLevel () throws com.foxit.sdk.PDFException
 Get PAdES level.
More...
 
SignatureArray getPagingSealGroupElements () throws com.foxit.sdk.PDFException
 Get the group elements of current paging seal signature.
More...
 
PagingSealSignature getPagingSealSignature () throws com.foxit.sdk.PDFException
 Get the paging seal signature.
More...
 
PDFDictionary getSignatureDict () throws com.foxit.sdk.PDFException
 Get signature dictionary.
More...
 
int getSignatureType () throws com.foxit.sdk.PDFException
 Get signature type.
More...
 
PDFDoc getSignedVersionDocument (String file_path) throws com.foxit.sdk.PDFException
 Get the PDF document in the signed version in which current signature was signed.
More...
 
DateTime getSignTime () throws com.foxit.sdk.PDFException
 Get time of signing.
More...
 
int getState () throws com.foxit.sdk.PDFException
 Get current state.
More...
 
String getSubFilter () throws com.foxit.sdk.PDFException
 Get sub filter.
More...
 
boolean isEmpty ()
 Check whether current object is empty or not.
More...
 
boolean isSigned () throws com.foxit.sdk.PDFException
 Check whether current signature is signed or not.
More...
 
boolean isTimeStamp () throws com.foxit.sdk.PDFException
 Check if current signature is a time stamp signature.
More...
 
void setAppearanceContent (String appearance_content) throws com.foxit.sdk.PDFException
 Set customized appearance content (as low level drawing operation commands) for signed signature appearance.
More...
 
void setAppearanceFlags (int appearance_flags) throws com.foxit.sdk.PDFException
 Set signature appearance flags.
More...
 
void setBitmap (Bitmap bitmap) throws com.foxit.sdk.PDFException
 Set a bitmap for the signature appearance.
More...
 
void setCertChain (WStringArray cert_chain) throws com.foxit.sdk.PDFException
 Set a certificate chain.
More...
 
void setCustomObject (String key, PDFObject pdf_object) throws com.foxit.sdk.PDFException
 Set custom PDF object for signature dictionary.
More...
 
void setDefaultContentsLength (int default_length) throws com.foxit.sdk.PDFException
 Set the default length of signature contents which represents signature value (known as signed data).
More...
 
void setDocPermission (int permission) throws com.foxit.sdk.PDFException
 Set document permission for current signature.
More...
 
void setFieldMDPActionFields (int action, WStringArray field_array) throws com.foxit.sdk.PDFException
 Set FieldMDP("MDP" means modification detection and prevention) action names array.
More...
 
void setFilter (String filter) throws com.foxit.sdk.PDFException
 Set filter.
More...
 
void setImage (Image image, int frame_index) throws com.foxit.sdk.PDFException
 Set an image for the signature appearance, with a specified frame index.
More...
 
void setImage (String file_path, int frame_index) throws com.foxit.sdk.PDFException
 Set an image for the signature appearance, with a specified frame index.
More...
 
void setKeyLabel (int label_name, String label_value) throws com.foxit.sdk.PDFException
 Set the string for specified key label.
More...
 
void setKeyValue (int key, String value) throws com.foxit.sdk.PDFException
 Set the string value for specified key name.
More...
 
void setSignTime (DateTime sign_time) throws com.foxit.sdk.PDFException
 Set time of signing.
More...
 
void setSubFilter (String sub_filter) throws com.foxit.sdk.PDFException
 Set sub filter.
More...
 
Progressive startSign (StreamCallback cert_file_stream, byte[] cert_password, int digest_algorithm, StreamCallback stream_callback, java.lang.Object client_data, PauseCallback pause) throws com.foxit.sdk.PDFException
 Start signing current signature if current signature is unsigned.
More...
 
Progressive startSign (StreamCallback cert_file_stream, byte[] cert_password, int digest_algorithm, String save_path, java.lang.Object client_data, PauseCallback pause) throws com.foxit.sdk.PDFException
 Start signing current signature if current signature is unsigned.
More...
 
Progressive startSign (String cert_path, byte[] cert_password, int digest_algorithm, StreamCallback stream_callback, java.lang.Object client_data, PauseCallback pause) throws com.foxit.sdk.PDFException
 Start signing current signature if current signature is unsigned.
More...
 
Progressive startSign (String cert_path, byte[] cert_password, int digest_algorithm, String save_path, java.lang.Object client_data, PauseCallback pause) throws com.foxit.sdk.PDFException
 Start signing current signature if current signature is unsigned.
More...
 
Progressive startVerify (java.lang.Object client_data, PauseCallback pause) throws com.foxit.sdk.PDFException
 Start verifying the intergrity of current signature if current signature is signed.
More...
 
- Public Member Functions inherited from com.foxit.sdk.pdf.interform.Field
 Field (Field field)
 Constructor, with another form field object.
More...
 
 Field (PDFDoc document, PDFDictionary field_dict) throws com.foxit.sdk.PDFException
 Constructor, from field dictionary.
More...
 
int getAlignment () throws com.foxit.sdk.PDFException
 Get the alignment value.
More...
 
String getAlternateName () throws com.foxit.sdk.PDFException
 Get alternate name.
More...
 
Control getControl (int index) throws com.foxit.sdk.PDFException
 Get a form control by index.
More...
 
Control getControl (PDFPage page, int index) throws com.foxit.sdk.PDFException
 Get a form control by index, in a specified PDF page.
More...
 
int getControlCount () throws com.foxit.sdk.PDFException
 Get count of form controls.
More...
 
int getControlCount (PDFPage page) throws com.foxit.sdk.PDFException
 Get count of form controls in a specified PDF page.
More...
 
DefaultAppearance getDefaultAppearance () throws com.foxit.sdk.PDFException
 Get the default appearance data.
More...
 
String getDefaultValue () throws com.foxit.sdk.PDFException
 Get default value.
More...
 
PDFObject getDefaultValueObj () throws com.foxit.sdk.PDFException
 Get the PDF object of field's default value.
More...
 
PDFDictionary getDict () throws com.foxit.sdk.PDFException
 Get the PDF dictionary of current object.
More...
 
int getFlags () throws com.foxit.sdk.PDFException
 Get field flags.
More...
 
PDFObject getInheritedAttribute (String attribute_name) throws com.foxit.sdk.PDFException
 Get the PDF object for specified attribute which may be inherited from the ancestor node in the field tree.
More...
 
String getMappingName () throws com.foxit.sdk.PDFException
 Get mapping name.
More...
 
int getMaxLength () throws com.foxit.sdk.PDFException
 Get maximum length of the field's text, in characters.
More...
 
String getName () throws com.foxit.sdk.PDFException
 Get field name.
More...
 
ChoiceOptionArray getOptions () throws com.foxit.sdk.PDFException
 Get options of list box or combo box.
More...
 
int getTopVisibleIndex () throws com.foxit.sdk.PDFException
 Get top index of option for scrollable list boxes.
More...
 
int getType () throws com.foxit.sdk.PDFException
 Get field type.
More...
 
String getValue () throws com.foxit.sdk.PDFException
 Get value.
More...
 
PDFObject getValueObj () throws com.foxit.sdk.PDFException
 Get the PDF object of field's value.
More...
 
boolean reset () throws com.foxit.sdk.PDFException
 Reset data in current field to its default value. (Not support signature field)
More...
 
void setAlignment (int alignment) throws com.foxit.sdk.PDFException
 Set alignment property of a form, as a document-wide default value. (Not support signature field)
More...
 
void setAlternateName (String alternate_name) throws com.foxit.sdk.PDFException
 Set alternate name. (Not support signature field)
More...
 
void setDefaultAppearance (DefaultAppearance default_ap) throws com.foxit.sdk.PDFException
 Set default appearance data.
More...
 
void setDefaultValue (String value) throws com.foxit.sdk.PDFException
 Set default value.
More...
 
void setFlags (int flags) throws com.foxit.sdk.PDFException
 Set field flags.
More...
 
void setMappingName (String name) throws com.foxit.sdk.PDFException
 Set mapping name. (Not support signature field)
More...
 
void setMaxLength (int max_length) throws com.foxit.sdk.PDFException
 Set maximum length of the field's text, in characters.
More...
 
void setOptions (ChoiceOptionArray option_array) throws com.foxit.sdk.PDFException
 Set options of list box or combo box.
More...
 
void setTopVisibleIndex (int index) throws com.foxit.sdk.PDFException
 Set top index for scrollable list boxes.
More...
 
void setValue (String value) throws com.foxit.sdk.PDFException
 Set value.
More...
 

Static Public Attributes

static final int e_PagingSealAPStateInvalid = 4
 Verification state of a signature is invalid.

 
static final int e_PagingSealAPStateSigned = 2
 Signed signature.

 
static final int e_PagingSealAPStateUnknown = 0
 Unknown signature.

 
static final int e_PagingSealAPStateUnsigned = 1
 Unsigned signature.

 
static final int e_PagingSealAPStateValid = 3
 Verification state of a signature is valid.

 
- Static Public Attributes inherited from com.foxit.sdk.pdf.Signature
static final int e_APFlagBitmap = 0x0080
 If set, show bitmap on signature appearance.

 
static final int e_APFlagDN = 0x0010
 If set, show distinguish name on signature appearance.

 
static final int e_APFlagFoxitEditorFlag = 0x0200
 If set, show Foxit Editor content on signature appearance.

 
static final int e_APFlagFoxitFlag = 0x0001
 If set, show Foxit flag on signature appearance.

 
static final int e_APFlagLabel = 0x0002
 If set, show label on signature appearance.

 
static final int e_APFlagLocation = 0x0020
 If set, show location on signature appearance.

 
static final int e_APFlagProducer = 0x0400
 If set, show producer content on signature appearance.

 
static final int e_APFlagReason = 0x0004
 If set, show reason on signature appearance.

 
static final int e_APFlagSigner = 0x0040
 If set, show signer on signature appearance.

 
static final int e_APFlagSigningTime = 0x0008
 If set, show signing time on signature appearance.

 
static final int e_APFlagText = 0x0100
 If set, show text content on signature appearance.

 
static final int e_DigestSHA1 = 0
 Signature digest algorithm: sha1 algorithm.

 
static final int e_DigestSHA256 = 1
 Signature digest algorithm: sha256 algorithm.

 
static final int e_DigestSHA384 = 2
 Signature digest algorithm: sha384 algorithm.

 
static final int e_DigestSHA512 = 3
 Signature digest algorithm: sha512 algorithm.

 
static final int e_DocPermFillingFormAndSigning = 2
 Permitted changes are filling in forms, instantiating page templates, and signing. Other changes will invalidate the signature.

 
static final int e_DocPermFillingFormSigningAndAnnotating = 3
 Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification. Other changes will invalidate the signature.

 
static final int e_DocPermNoChangesAllowed = 1
 No changes to the PDF document (which is signed by the signture) are permitted. Any change to this kind of PDF document will invalidate the signature.

 
static final int e_DocPermUnrestricted = 0
 No restriction.

 
static final int e_FieldMDPActionAll = 1
 All form fields' flags will be set read-only.

 
static final int e_FieldMDPActionExclude = 3
 Flags of form fields (except specified form fields) will be set read-only.
More...
 
static final int e_FieldMDPActionInclude = 2
 Specified form fields' flags will be set read-only.
More...
 
static final int e_FieldMDPActionNone = 0
 No Field MDP action.

 
static final int e_KeyNameContactInfo = 3
 Signature key name: contact information.

 
static final int e_KeyNameDN = 4
 Signature key name: distinguish name.

 
static final int e_KeyNameLocation = 1
 Signature key name: location.

 
static final int e_KeyNameProducer = 6
 Signature key name: producer content.

 
static final int e_KeyNameReason = 2
 Signature key name: reason.

 
static final int e_KeyNameSigner = 0
 Signature key name: signer.

 
static final int e_KeyNameText = 5
 Signature key name: text content.

 
static final int e_LabelNameDN = 4
 Signature key name for distinguish name.
More...
 
static final int e_LabelNameLocation = 1
 Signature label name for location.
More...
 
static final int e_LabelNameProducer = 6
 Signature key name for producer name.
More...
 
static final int e_LabelNameReason = 2
 Signature label name for reason.
More...
 
static final int e_LabelNameSigner = 0
 Signature label name for signer.
More...
 
static final int e_LabelNameSignTime = 3
 Signature label name for sign time.
More...
 
static final int e_PAdESLevelBB = 2
 PAdES level: B-B.

 
static final int e_PAdESLevelBLT = 4
 PAdES level: B-LT.

 
static final int e_PAdESLevelBLTA = 5
 PAdES level: B-LTA.

 
static final int e_PAdESLevelBT = 3
 PAdES level: B-T.

 
static final int e_PAdESLevelNone = 1
 PAdES level: none.

 
static final int e_PAdESLevelNotPAdES = 0
 Not a PAdES signature.

 
static final int e_SignatureTypeOrdinary = 0
 Signature type: ordinary.

 
static final int e_SignatureTypePagingSeal = 4
 Signature type: paging seal.

 
static final int e_SignatureTypeTimeStamp = 3
 Signature type: time stamp.

 
static final int e_StateCertCannotGetVRI = 0x04000000
 Cannot get verify relevant information.

 
static final int e_StateNoSignData = 0x00000200
 Signature does not have any data for signing.It means that there is not "V" entry in the signature dictionary.

 
static final int e_StateSigned = 0x00000002
 Signed signature.

 
static final int e_StateUnknown = 0x80000000
 Unknown signature.

 
static final int e_StateUnsigned = 0x00000001
 Unsigned signature.

 
static final int e_StateVerifyChange = 0x00000080
 The document has been changed within the scope of the signature. (This indicates that signature is invalid.)

 
static final int e_StateVerifyChangeIllegal = 0x10000000
 The document has been changed outside of signature scope, and the changed invalidate the signature.

 
static final int e_StateVerifyChangeLegal = 0x08000000
 The document has been changed outside of signature scope, but the changed is permitted.

 
static final int e_StateVerifyErrorByteRange = 0x00000040
 Non expected byte range.

 
static final int e_StateVerifyErrorData = 0x00000010
 Signature data is destroyed (that means the signature data cannot be parsed properly).

 
static final int e_StateVerifyIncredible = 0x00000100
 Signature cannot be trusted (containing aggression).

 
static final int e_StateVerifyInvalid = 0x00000008
 Verification state of a signature is invalid.

 
static final int e_StateVerifyIssueCurrent = 0x00020000
 The verified issue is current issuer.

 
static final int e_StateVerifyIssueExpire = 0x00008000
 Certificate for verifying issuer is expired.

 
static final int e_StateVerifyIssueRevoke = 0x00004000
 Certificate for verifying issuer is revoked.

 
static final int e_StateVerifyIssueUncheck = 0x00010000
 Not check the issuer.

 
static final int e_StateVerifyIssueUnknown = 0x00002000
 Verification state of the issuer is unknown.

 
static final int e_StateVerifyIssueValid = 0x00001000
 Verification state of the issuer is valid.

 
static final int e_StateVerifyNoChange = 0x00000400
 The document has not been changed within the scope of the signature.

 
static final int e_StateVerifyNoSupportWay = 0x00000020
 Unsupported signature.

 
static final int e_StateVerifyTimestampDoc = 0x00080000
 The signature is a time stamp signature.

 
static final int e_StateVerifyTimestampExpire = 0x00400000
 Verification state of the time stamp is expired.

 
static final int e_StateVerifyTimestampInvalid = 0x00200000
 Verification state of the time stamp is invalid.

 
static final int e_StateVerifyTimestampIssueUnknown = 0x00800000
 Verification state of the time stamp issuer is unknown.

 
static final int e_StateVerifyTimestampIssueValid = 0x01000000
 Verification state of the time stamp issuer is valid.

 
static final int e_StateVerifyTimestampNone = 0x00040000
 No time stamp or not check time stamp.

 
static final int e_StateVerifyTimestampTimeBefore = 0x02000000
 Verification state of the time stamp time is valid, since the times is before the expiration date.

 
static final int e_StateVerifyTimestampValid = 0x00100000
 Verification state of the time stamp is valid.

 
static final int e_StateVerifyValid = 0x00000004
 Verification state of a signature is valid.

 
- Static Public Attributes inherited from com.foxit.sdk.pdf.interform.Field
static final int e_FlagButtonNoToggleToOff = 0x100
 (Only useful for radio button) If set, exactly one radio button must be selected at all times; clicking the currently selected button has no effect. If clear, clicking the selected button deselects it, leaving no button selected.

 
static final int e_FlagButtonRadiosInUnison = 0x200
 (Only useful for radio button) If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive.

 
static final int e_FlagChoiceCommitOnSelChange = 0x400
 (Only useful for choice field) If set, the new value is committed as soon as a selection is made with the pointing device; if clear, the new value is not committed until the user exits the field.

 
static final int e_FlagChoiceMultiSelect = 0x100
 (Only useful for list box) If set, more than one items may be selected simultaneously; if clear, no more than one item at a time may be selected.

 
static final int e_FlagChoiceSort = 0x200
 (Only useful for choice field) If set, the field's option items should be sorted alphabetically.

 
static final int e_FlagComboEdit = 0x100
 (Only useful for combo box) If set, the combo box includes an editable text control with a drop-down list, if clear, it includes only a drop-down list.

 
static final int e_FlagNoExport = 0x04
 if set, the field must not be exported by a submit-form action.

 
static final int e_FlagReadOnly = 0x01
 If set, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.

 
static final int e_FlagRequired = 0x02
 If set, the field must have a value at the time it is exported by a submit-form action.

 
static final int e_FlagTextComb = 0x2000
 (Only useful for text field) If set, use combs.
More...
 
static final int e_FlagTextDoNotScroll = 0x1000
 (Only useful for text field) If set, the field does not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text is accepted.

 
static final int e_FlagTextFileSelect = 0x400
 (Only useful for text field) If set, the text entered in the field represents the pathname of a file whose contents are to be submitted as the value of the field.

 
static final int e_FlagTextMultiline = 0x100
 (Only useful for text field) If set, the text field can contain multiple lines of text; if clear, the field's text is restricted to a single line.

 
static final int e_FlagTextNoSpellCheck = 0x800
 (Only useful for text field) If set, text entered in the field is not spell-checked.

 
static final int e_FlagTextPassword = 0x200
 (Only useful for text field) If set, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard should instead be echoed in some unreadable form, such as asterisks or bullet characters.
More...
 
static final int e_FlagTextRichText = 0x4000
 (Only useful for text field) If set, the value of this field should be represented as a rich text string.

 
static final int e_TypeCheckBox = 2
 Form field type: check box.

 
static final int e_TypeComboBox = 4
 Form field type: combo box.

 
static final int e_TypeListBox = 5
 Form field type: list box.

 
static final int e_TypePushButton = 1
 Form field type: push button.

 
static final int e_TypeRadioButton = 3
 Form field type: radio button.

 
static final int e_TypeSignature = 7
 Form field type: signature field.

 
static final int e_TypeTextField = 6
 Form field type: text field.

 
static final int e_TypeUnknown = 0
 Form field type: unknown.

 

Detailed Description

This class represents a paging seal signature object for signing the signatures. It is a type of signature field, so class PagingSealSignature is derived from class com.foxit.sdk.pdf.Signature . A new paging seal signature object would be returned by function PDFDoc.addPagingSealSignature , instead of PDFPage.addSignature .
A paging seal signature contains a few signatures or a few paging seal annotation. To set the configuration of paging seal signature, please use the function PagingSealSignature.setPagingSealConfig .

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.pdf.PagingSealSignature.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

Reimplemented from com.foxit.sdk.pdf.Signature.

◆ generateAppearance()

boolean com.foxit.sdk.pdf.PagingSealSignature.generateAppearance ( ) throws com.foxit.sdk.PDFException

Generate the appearance of paging seal signature.

This function should be called before signing and the paging seal config should be set already. If this function is not called, the page will not display the paging seal signatures.

Returns
true means success, while false means failure.

Reimplemented from com.foxit.sdk.pdf.Signature.

◆ setAPStateBitmap()

void com.foxit.sdk.pdf.PagingSealSignature.setAPStateBitmap ( int  ap_state,
Bitmap  bitmap 
) throws com.foxit.sdk.PDFException

Set a bitmap for the appearance of signature state.

If user wants the setting by this function has effect on paging seal signatures' appearance, please call function PagingSealSignature::GenerateAppearence after this function.

Parameters
[in]ap_stateThe state of signature.
[in]bitmapA bitmap to be set to the appearance.
Returns
None.

◆ setPagingSealConfig()

void com.foxit.sdk.pdf.PagingSealSignature.setPagingSealConfig ( PagingSealConfig  paging_seal_config) throws com.foxit.sdk.PDFException

Set the config of paging seal signature.

Parameters
[in]paging_seal_configA paging seal configuration to be set.
Returns
None.