An interface for SignDoc documents. More...

Public Member Functions
synchronized void	close () throws SignDocException
	Close the document and the underlying file.
synchronized int	getType () throws SignDocException
	Get the type of the document.
synchronized int	getPageCount () throws SignDocException
	Get the number of pages of the document.
synchronized SignDocSignatureParameters	createSignatureParameters (String aFieldName, String aProfile) throws SignDocException
	Create a SignDocSignatureParameters object for signing a signature field.
synchronized SignDocSignatureParameters	createSignatureParametersForTimeStamp () throws SignDocException
	Create a SignDocSignatureParameters object for adding a document time stamp.
synchronized String[]	getProfiles (String aFieldName) throws SignDocException
	Get a list of profiles for a signature field.
synchronized void	addSignature (SignDocSignatureParameters aSignatureParameters, SignDocVerificationParameters aVerificationParameters) throws SignDocException
	Sign the document.
synchronized String	getLastTimestamp () throws SignDocException
	Get the timestamp used by the last successful call of addSignature().
synchronized String	getPathname () throws SignDocException
	Get the current pathname of the document.
synchronized int	getAvailableMethods () throws SignDocException
	Get a bitset indicating which signing methods are available for this document.
synchronized int	getSignatureCount () throws SignDocException
	Get the number of signatures that can be retrieved with getSignature().
synchronized SignDocSignature	getSignature (int aIndex) throws SignDocException
	Get a signature of the document.
synchronized SignDocVerificationResult	verifySignature (String aFieldName) throws SignDocException
	Verify a signature of the document.
synchronized SignDocVerificationResult	verifySignature2 (SignDocSignature aSignature) throws SignDocException
	Verify a signature of the document.
synchronized void	clearSignature (String aFieldName) throws SignDocException
	Remove a signature of the document.
synchronized void	clearAllSignatures () throws SignDocException
	Remove all signatures of the document.
synchronized void	clearApprovalSignatures () throws SignDocException
	Remove all approval signatures of the document.
synchronized int	updateDSS (SignDocVerificationParameters aParameters, int aFlags) throws SignDocException
	Update the DSS for any eligible signatures of the document.
synchronized void	updateDSS2 (String aFieldName, SignDocVerificationParameters aParameters, int aFlags) throws SignDocException
	Update the DSS for a signature of the document.
synchronized void	saveToStream (java.io.OutputStream aStream, int aFlags) throws SignDocException
	Save the document to a stream.
synchronized void	saveToFile (String aPath, int aFlags) throws SignDocException
	Save the document to a file.
synchronized void	copyToStream (java.io.OutputStream aStream, int aFlags) throws SignDocException
	Copy the document's current status or backing file or backing blob to a stream.
synchronized void	copyAsSignedToStream (java.io.OutputStream aStream, String aFieldName) throws SignDocException
	Copy the document to a stream for viewing the document "as signed".
synchronized int	getSaveToStreamFlags () throws SignDocException
	Get all flags currently valid for saveToStream().
synchronized int	getSaveToFileFlags () throws SignDocException
	Get all flags currently valid for saveToFile().
synchronized int	getRequiredSaveToFileFlags () throws SignDocException
	Get all flags currently required for saveToFile().
synchronized SignDocField[]	getFields (int aTypes) throws SignDocException
	Get all interactive fields of the specified types.
synchronized SignDocField[]	getFieldsOfPage (int aPage, int aTypes) throws SignDocException
	Get all interactive fields of the specified page, in tab order.
synchronized SignDocField	getField (String aName) throws SignDocException
	Get an interactive field by name.
synchronized void	setField (SignDocField aField, int aFlags) throws SignDocException
	Change a field.
synchronized void	addField (SignDocField aField, int aFlags) throws SignDocException
	Add a field.
synchronized void	removeField (String aName) throws SignDocException
	Remove a field.
synchronized void	flattenField (String aName, int aWidget) throws SignDocException
	Flatten a field.
synchronized void	flattenFields (int aFirstPage, int aLastPage, int aFlags) throws SignDocException
	Flatten all fields of the document or of a range of pages.
synchronized void	exportFields (java.io.OutputStream aStream, int aFlags) throws SignDocException
	Export all fields as XML.
synchronized void	applyFdf (String aPath, int aFlags) throws SignDocException
	Apply an FDF document to a PDF document.
synchronized SignDocTextFieldAttributes	getTextFieldAttributes () throws SignDocException
	Get the document's default text field attributes.
synchronized void	setTextFieldAttributes (SignDocTextFieldAttributes aData) throws SignDocException
	Set the document's default text field attributes.
synchronized SignDocProperty[]	getProperties (String aCollection) throws SignDocException
	Get the names and types of all SignDoc properties of a certain collection of properties of the document.
synchronized int	getIntegerProperty (String aCollection, String aName) throws SignDocException
	Get the value of a SignDoc property (integer).
synchronized String	getStringProperty (String aCollection, String aName) throws SignDocException
	Get the value of a SignDoc property (string).
synchronized boolean	getBooleanProperty (String aCollection, String aName) throws SignDocException
	Get the value of a SignDoc property (boolean).
synchronized void	setIntegerProperty (String aCollection, String aName, int aValue) throws SignDocException
	Set the value of a SignDoc property (integer).
synchronized void	setStringProperty (String aCollection, String aName, String aValue) throws SignDocException
	Set the value of a SignDoc property (string).
synchronized void	setBooleanProperty (String aCollection, String aName, boolean aValue) throws SignDocException
	Set the value of a SignDoc property (boolean).
synchronized void	removeProperty (String aCollection, String aName) throws SignDocException
	Remove a SignDoc property.
synchronized void	exportProperties (String aCollection, java.io.OutputStream aStream, int aFlags) throws SignDocException
	Export all properties (in all collections) as XML.
synchronized void	importProperties (String aCollection, java.io.InputStream aStream, int aFlags) throws SignDocException
	Import properties from XML.
synchronized double	getResolutionX (int aPage) throws SignDocException
	Get the horizontal resolution of a page.
synchronized double	getResolutionY (int aPage) throws SignDocException
	Get the vertical resolution of a page.
synchronized double	getConversionFactorX (int aPage) throws SignDocException
	Get the horizontal conversion factor for a page.
synchronized double	getConversionFactorY (int aPage) throws SignDocException
	Get the vertical conversion factor for a page.
synchronized double	getPageWidth (int aPage) throws SignDocException
	Get the width of a page.
synchronized double	getPageHeight (int aPage) throws SignDocException
	Get the height of a page.
synchronized String	getPageLabel (int aPage) throws SignDocException
	Get the page label for a page number.
synchronized double	getBitsPerPixel (int aPage) throws SignDocException
	Get the number of bits per pixel (TIFF only).
synchronized double	computeZoom (SignDocRenderParameters aParams) throws SignDocException
	Compute the zoom factor used for rendering.
synchronized void	convCanvasPointToPagePoint (Point aPoint, SignDocRenderParameters aParams) throws SignDocException
	Convert a point expressed in canvas (image) coordinates to a point expressed in document coordinate system of the current page.
synchronized void	convPagePointToCanvasPoint (Point aPoint, SignDocRenderParameters aParams) throws SignDocException
	Convert a point expressed in document coordinate system of the current page to a point expressed in canvas (image) coordinates.
synchronized byte[]	renderPageAsImage (SignDocRenderOutput aOutput, SignDocRenderParameters aRenderParameters, SignDocVerificationParameters aVerificationParameters, Rect aClipRect) throws SignDocException
	Render the selected page (or pages) as image.
synchronized void	getRenderedSize (SignDocRenderOutput aOutput, SignDocRenderParameters aParams) throws SignDocException
	Get the size of the rendered page in pixels (without actually rendering it).
synchronized SignDocAnnotation	createLineAnnotation (Point aStart, Point aEnd) throws SignDocException
	Create a line annotation.
synchronized SignDocAnnotation	createLineAnnotation (double aStartX, double aStartY, double aEndX, double aEndY) throws SignDocException
	Create a line annotation.
synchronized SignDocAnnotation	createScribbleAnnotation () throws SignDocException
	Create a scribble annotation.
synchronized SignDocAnnotation	createFreeTextAnnotation (Point aLowerLeft, Point aUpperRight) throws SignDocException
	Create a text annotation.
synchronized SignDocAnnotation	createFreeTextAnnotation (double aX0, double aY0, double aX1, double aY1) throws SignDocException
	Create a text annotation.
synchronized void	addAnnotation (int aPage, SignDocAnnotation aAnnot) throws SignDocException
	Add an annotation to a page.
synchronized String[]	getAnnotations (int aPage) throws SignDocException
	Get a list of all named annotations of a page.
synchronized SignDocAnnotation	getAnnotation (int aPage, String aName) throws SignDocException
	Get a named annotation of a page.
synchronized void	removeAnnotation (int aPage, String aName) throws SignDocException
	Remove an annotation identified by name.
synchronized void	flattenAnnotations (int aFirstPage, int aLastPage, int aFlags) throws SignDocException
	Flatten all annotations of the document or of a range of pages.
synchronized void	addText (String aText, int aPage, double aX, double aY, String aFontName, double aFontSize, SignDocColor aTextColor, double aOpacity, int aFlags) throws SignDocException
	Add text to a page.
synchronized void	addText2 (String aText, int aPage, double aX, double aY, String aFontName, double aFontSize, SignDocColor aTextColor, double aOpacity, int aFlags, String aLang) throws SignDocException
	Add text to a page (with language identifier).
synchronized void	addTextRect (String aText, int aPage, double aX0, double aY0, double aX1, double aY1, String aFontName, double aFontSize, double aLineSkip, SignDocColor aTextColor, double aOpacity, int aHAlignment, int aVAlignment, int aFlags) throws SignDocException
	Add text in a rectangle of a page (with line breaking).
synchronized void	addTextRect2 (String aText, int aPage, double aX0, double aY0, double aX1, double aY1, String aFontName, double aFontSize, double aLineSkip, SignDocColor aTextColor, double aOpacity, int aHAlignment, int aVAlignment, int aFlags, String aLang) throws SignDocException
	Add text in a rectangle of a page (with line breaking and language identifier).
synchronized void	addWatermark (SignDocWatermark aInput) throws SignDocException
	Add a watermark.
synchronized SignDocFindTextPosition[]	findText (int aFirstPage, int aLastPage, String aText, int aFlags) throws SignDocException
	Find text.
synchronized void	addAttachmentBlob (String aName, String aDescription, String aType, String aModificationTime, byte[] aData, int aFlags) throws SignDocException
	Add an attachment to the document.
synchronized void	addAttachmentFile (String aName, String aDescription, String aType, String aPath, int aFlags) throws SignDocException
	Add an attachment (read from a file) to the document.
synchronized void	removeAttachment (String aName) throws SignDocException
	Remove an attachment from the document.
synchronized void	changeAttachmentDescription (String aName, String aDescription) throws SignDocException
	Change the description of an attachment of the document.
synchronized String[]	getAttachments () throws SignDocException
	Get a list of all attachments of the document.
synchronized SignDocAttachment	getAttachment (String aName) throws SignDocException
	Get information about an attachment.
synchronized int	checkAttachment (String aName) throws SignDocException
	Check the checksum of an attachment.
synchronized byte[]	getAttachmentBlob (String aName) throws SignDocException
	Get an attachment as blob.
synchronized java.io.InputStream	getAttachmentStream (String aName) throws SignDocException
	Get an InputStream for an attachment.
synchronized void	addPage (int aTargetPage, double aWidth, double aHeight) throws SignDocException
	Add an empty page to the document.
synchronized void	importPages (int aTargetPage, SignDocDocument aSource, int aSourcePage, int aPageCount, int aFlags) throws SignDocException
	Import pages from another document.
synchronized void	importPageFromImageBlob (int aTargetPage, byte[] aData, double aZoom, double aWidth, double aHeight, int aFlags) throws SignDocException
	Import a page from a blob containing an image.
synchronized void	importPageFromImageBlob2 (int aTargetPage, byte[] aData, double aZoom, double aWidth, double aHeight, int aFlags, String aDescription, String aLang) throws SignDocException
	Import a page from a blob containing an image (with alternate description).
synchronized void	importPageFromImageFile (int aTargetPage, String aPath, double aZoom, double aWidth, double aHeight, int aFlags) throws SignDocException
	Import a page from a file containing an image.
synchronized void	importPageFromImageFile2 (int aTargetPage, String aPath, double aZoom, double aWidth, double aHeight, int aFlags, String aDescription, String aLang) throws SignDocException
	Import a page from a file containing an image (with alternate description).
synchronized void	addImageFromBlob (int aTargetPage, byte[] aData, double aZoom, double aX, double aY, double aWidth, double aHeight, int aFlags) throws SignDocException
	Add an image (from a blob) to a page.
synchronized void	addImageFromBlob2 (int aTargetPage, byte[] aData, double aZoom, double aX, double aY, double aWidth, double aHeight, int aFlags, String aDescription, String aLang) throws SignDocException
	Add an image (from a blob) to a page (with alternate description).
synchronized void	addImageFromFile (int aTargetPage, String aPath, double aZoom, double aX, double aY, double aWidth, double aHeight, int aFlags) throws SignDocException
	Add an image (from a file) to a page.
synchronized void	addImageFromFile2 (int aTargetPage, String aPath, double aZoom, double aX, double aY, double aWidth, double aHeight, int aFlags, String aDescription, String aLang) throws SignDocException
	Add an image (from a file) to a page.
synchronized void	removePages (int[] aPages, int aMode) throws SignDocException
	Remove pages from the document.
synchronized void	setCompatibility (int aMajor, int aMinor) throws SignDocException
	Request to not make changes to the document which are incompatible with an older version of this class.
synchronized boolean	isModified () throws SignDocException
	Check if the document has unsaved changes.
synchronized boolean	isTaggedPDF () throws SignDocException
	Check if the document is a Tagged PDF document.
synchronized void	setFlags (int aFlags) throws SignDocException
	Set flags modifying the behavior of various functions.
synchronized int	getFlags () throws SignDocException
	Get the flags set by setFlags().
synchronized void	setCompressionLevel (int aLevel) throws SignDocException
	Set the FlateDecode compression level.
synchronized int	getDocMDP () throws SignDocException
	Get the DocMDP P value of the document's certification signature.
synchronized int	getLockMDP () throws SignDocException
	Get the lowest lock MDP value of the signed signature fields.
synchronized void	removeDocMDP () throws SignDocException
	Remove any certification signature.
synchronized void	removePermissions (int aFlags) throws SignDocException
	Remove signatures that grant permissions.
synchronized void	removePDFA (int aFlags) throws SignDocException
	Remove PDF/A conformance.
synchronized void	removePDFUA (int aFlags) throws SignDocException
	Remove PDF/UA conformance.
synchronized void	removeLogicalStructure (int aFlags) throws SignDocException
	Remove the logical structure.
synchronized void	removeXFA (int aFlags) throws SignDocException
	Remove XFA (XML Forms Architecture) content.
synchronized String	getDocumentLanguage () throws SignDocException
	Get the document's natural language.
synchronized void	setDocumentLanguage (String aLang) throws SignDocException
	Set the document's natural language.
synchronized void	setDefaultDocumentLanguage (String aLang) throws SignDocException
	Set the language identifier to be used if a language identifier is required but the document doesn't provide one.
synchronized void	setShootInFoot (int aFlags) throws SignDocException
	Disable safety checks.
synchronized int	getShootInFoot () throws SignDocException
	Get the flags set by setShootInFoot().
Static Public Member Functions
static String[]	splitEscapeSequences (String aInput)
	Split a string obtained from a PDF text string into escape sequences and text segments.
static String	withoutEscapeSequences (String aInput)
	Remove escape sequences specifying the natural language in text strings.
static String	withEscapeSequence (String aText, String aLang)
	Prepend an escape sequence for specifying the natural language in a text string.
Static Public Attributes
static final int	dt_unknown = 0
	Document type: unknown, for SignDocDocumentLoader.ping().
static final int	dt_pdf = 1
	Document type: PDF document.
static final int	dt_tiff = 2
	Document type: TIFF document.
static final int	dt_other = 3
	Document type: Other document.
static final int	dt_fdf = 4
	Document type: FDF document.
static final int	sf_incremental = 0x01
	Save flag: Save incrementally (PDF).
static final int	sf_remove_unused = 0x02
	Save flag: Remove unused objects (PDF).
static final int	sf_linearized = 0x04
	Save flag: Linearize the document (PDF).
static final int	sf_pdf_1_4 = 0x08
	Save flag: Do not use features introduced after PDF 1.4 for saving the document (PDF)
static final int	sf_pdfa_buttons = 0x10
	Save flag: Fix appearance streams of check boxes and radio buttons for conformance with PDF/A-1 without Technical Corrigendum 2.
static final int	sf_auto_incremental = 0x20
	Save flag: Automatically set sf_incremental if needed, automatically reset sf_incremental if not allowed.
static final int	ctsf_unsaved = 0x01
	Flag for copyToStream(): Include unsaved changes.
static final int	sff_font_fail = 0x01
	Flag for setField(), addField(), and applyFdf(): Fail if no suitable font is found.
static final int	sff_move = 0x08
	Flag for setField(): Move or resize field.
static final int	sff_keep_ap = 0x10
	Flag for setField(), addField(), and applyFdf(): Keep appearance streams.
static final int	sff_update_ap = 0x20
	Flag for setField() and applyFdf(): Update appearance streams.
static final int	sff_fit_height_only = 0x40
	Flag for setField(), addField(), and applyFdf(): Compute the default font size such that the field contents fit the height of the field.
static final int	sff_force_border_width = 0x80
	Flag for setField(), addField(), and applyFdf(): Use the border width specified by the field even if that will obliterate the field contents.
static final int	sff_dont_break_lines = 0x100
	Flag for setField(), addField(), and applyFdf(): Do not break lines in multiline text fields.
static final int	sff_auto_alignment = 0x200
	Flag for setField(), addField(), and applyFdf(): Align left if the text begins with an LTR run, align right if the text begins with an RTL run.
static final int	sff_ltr = 0x1000
	Flag for setField(), addField(), and applyFdf(): Paragraph direction: LTR.
static final int	sff_rtl = 0x2000
	Flag for setField(), addField(), and applyFdf(): Paragraph direction: RTL.
static final int	sff_default_ltr = 0x4000
	Flag for setField(), addField(), and applyFdf(): Choose direction automatically, default to LTR.
static final int	sff_default_rtl = 0x8000
	Flag for setField(), addField(), and applyFdf(): Choose direction automatically, default to RTL.
static final int	fff_include_signature_unsigned = 0x01
	Flags modifying the behavior of flattenFields(): Include unsigned signature fields.
static final int	fff_include_signature_signed = 0x02
	Flags modifying the behavior of flattenFields(): Include signed signature fields.
static final int	fff_include_hidden = 0x04
	Flags modifying the behavior of flattenFields(): Include hidden and invisible widgets.
static final int	fff_keep_structure = 0x08
	Flags modifying the behavior of flattenFields(): Do not modify logical structure.
static final int	faf_include_hidden = 0x04
	Flags modifying the behavior of flattenAnnotations(): Include hidden and invisible annotations.
static final int	faf_keep_structure = 0x08
	Flags modifying the behavior of flattenAnnotations(): Do not modify logical structure.
static final int	ftf_ignore_hspace = 0x0001
	Flag for findText(): Ignore horizontal whitespace.
static final int	ftf_ignore_hyphenation = 0x0002
	Flag for findText(): Ignore hyphenation.
static final int	ftf_ignore_sequence = 0x0004
	Flag for findText(): Use character positions instead of sequence.
static final int	e_top = 0x01
	Flag for exportFields() and exportProperties(): Include XML declaration and schema for top-level element.
static final int	i_atomic = 0x01
	Flag for importProperties(): Modify all properties from XML or none (on error).
static final int	ii_keep_aspect_ratio = 0x01
	Flag for addImageFromBlob(), addImageFromBlob2(), addImageFromFile(), addImageFromFile2(), importPageFromImageBlob(), importPageFromImageBlob2(), importPageFromImageFile(), and importPageFromImageFile2(): Keep aspect ratio of image, center image on white background.
static final int	ii_brightest_transparent = 0x02
	Flag for addImageFromBlob(), addImageFromBlob2(), addImageFromFile(), and addImageFromFile2(): Make the brightest color transparent.
static final int	kor_keep = 0
	Tell removePages() to keep the specified pages.
static final int	kor_remove = 1
	Tell removePages() to remove the specified pages.
static final int	car_match = 0
	Return value for checkAttachment(): The attachment matches its checksum.
static final int	car_no_checksum = 1
	Return value for checkAttachment(): The attachment does not have a checksum.
static final int	car_mismatch = 2
	Return value for checkAttachment(): The attachment does not match its checksum.
static final int	ha_left = 0
	Horizontal alignment for addTextRect(): Align left.
static final int	ha_center = 1
	Horizontal alignment for addTextRect(): Center.
static final int	ha_right = 2
	Horizontal alignment for addTextRect(): Align right.
static final int	ha_auto = 4
	Horizontal alignment for addTextRect(): Align left if the text begins with an LTR run, align right if the text begins with an RTL run.
static final int	va_top = 0
	Vertical alignment for addTextRect(): Align top.
static final int	va_center = 1
	Vertical alignment for addTextRect(): Center.
static final int	va_bottom = 2
	Vertical alignment for addTextRect(): Align bottom.
static final int	atrf_compat = 0x01
	Flag for addTextRect(): Behave like addTextRect() of SignDoc SDK 4.2.0.8 and earlier.
static final int	atrf_ltr = 0x1000
	Flag for addTextRect(): Paragraph direction: LTR.
static final int	atrf_rtl = 0x2000
	Flag for addTextRect(): Paragraph direction: RTL.
static final int	atrf_default_ltr = 0x4000
	Flag for addTextRect(): Choose direction automatically, default to LTR.
static final int	atrf_default_rtl = 0x8000
	Flag for addTextRect(): Choose direction automatically, default to RTL.
static final int	f_relax_byte_range = 0x01
	Flag for setFlags(): Relax checking of ByteRange.
static final int	f_ambiguous_button_value_empty = 0x02
	Flag for setFlags(): Make exportFields(), getField(), getFields(), and getFieldsOfPage() return an empty button value if there are multiple non-Off values for a check box field.
static final int	f_use_dss_only = 0x04
	Flag for setFlags(): Use only the Document Security Store for building the certificate chain and for checking the revocation state of the certificates, ignore any certificates, CRLs, and OCSP responses from the signature proper.
static final int	f_no_kerning_for_standard_fonts = 0x08
	Flag for setFlags(): Disable kerning for standard fonts.
static final int	f_prevent_breaking_tagged_pdf = 0x10
	Flag for setFlags(): Do not allow operations to break Tagged PDF (and PDF/UA).
static final int	f_keep_escape_sequences = 0x20
	Flag for setFlags(): Do not remove escape sequences specifying the natural language from text strings.
static final int	f_require_alternate_field_name = 0x40
	Flag for setFlags(): Require alternate field names.
static final int	f_require_lang = 0x80
	Flag for setFlags(): Require language identifier for text.
static final int	f_insert_at_end = 0x100
	Flag for setFlags(): Do not attempt to insert new objects into the logical structure in reading order.
static final int	f_use_escape_sequences = 0x200
	Flag for setFlags(): Use escape sequences to encode the natural language in alternate field names.
static final int	f_fail_for_broken_target_structure = 0x400
	Flag for setFlags(): Fail if a new object cannot be inserted into the logical structure of the target document due to that logical structure being broken.
static final int	siff_allow_breaking_signatures = 0x01
	Flag for setShootInFoot(): Allow operations to break existing signatures in signature fields.
static final int	siff_allow_breaking_permissions = 0x02
	Flag for setShootInFoot(): Allow operations to break signatures which grant permissions.
static final int	siff_allow_invalid_certificate = 0x04
	Flag for setShootInFoot(): Allow signing with a certificate that is not yet valid or no longer valid or which is not qualified for digital signatures.
static final int	siff_allow_non_standard_external_fonts = 0x08
	Flag for setShootInFoot(): Allow non-standard usage of external (non-embedded) TrueType and CFF fonts.
static final int	siff_assume_ap_not_shared = 0x10
	Flag for setShootInFoot(): Assume that appearance dictionaries and appearance streams are not shared.
static final int	siff_assume_ap_shared = 0x20
	Flag for setShootInFoot(): Always assume that appearance dictionaries and appearance streams are shared.
static final int	siff_dont_verify_after_signing = 0x40
	Flag for setShootInFoot(): Disable verification of signature after signing by addSignature().
static final int	siff_allow_all_curves = 0x80
	Flag for setShootInFoot(): Allow elliptic curves for signing which are not supported by Adobe products for Windows.
static final int	udf_simulate = 0x01
	Flag for updateDSS() and updateDSS2(): Perform all the checks but do not modify the document.
static final int	udf_vri = 0x02
	Flag for updateDSS() and updateDSS2(): Create VRI dictionaries.
Protected Member Functions
void	finalize () throws Throwable
	Finalize this object.

Detailed Description

An interface for SignDoc documents.

An object of this class represents one document.

Use SignDocDocumentLoader.loadFromMemory(), SignDocDocumentLoader.loadFromFile(), or SignDocDocumentLoader.createPDF() to create objects.

If the document is loaded from a file, the file may remain in use until this object is destroyed or close() is called or the document is saved to a different file with saveToFile(). Please do not change the file while there is a SignDocDocument object for it.

Getting basic information about the document:

Saving the document:

Working with interactive fields:

Signing signature fields:

Verifying and removing signatures:

Working with properties:

Working with pages:

Working with annotations:

Adding text to a page and finding text on pages:

Adding images to a page:

Working with attachments:

Other functions:

Member Function Documentation

synchronized void de.softpro.doc.SignDocDocument.addAnnotation	(	int	aPage,
		SignDocAnnotation	aAnnot
	)		throws SignDocException

Add an annotation to a page.

See SignDocAnnotation for details.

Parameters:

[in]	aPage	The page number (1 for the first page).
[in]	aAnnot	The new annotation.

See also:: createLineAnnotation(), createScribbleAnnotation(), f_fail_for_broken_target_structure

synchronized void de.softpro.doc.SignDocDocument.addAttachmentBlob	(	String	aName,
		String	aDescription,
		String	aType,
		String	aModificationTime,
		byte[]	aData,
		int	aFlags
	)		throws SignDocException

Add an attachment to the document.

Attachments are supported for PDF documents only.

Parameters:

[in]	aName	The name of the attachment. Will also be used as filename of the attachment and must not contain slashes, backslashes, and colons.
[in]	aDescription	The description of the attachment (can be null and empty).
[in]	aType	The MIME type of the attachment (can be null and empty except for PDF/A-3 documents).
[in]	aModificationTime	The time and date of the last modification of the file being attached to the document (can be empty). Must be in ISO 8601 extended calendar date format with optional timezone.
[in]	aData	The attachment proper.
[in]	aFlags	Must be zero.

See also:: addAttachmentFile(), getAttachments(), removeAttachment()

synchronized void de.softpro.doc.SignDocDocument.addAttachmentFile	(	String	aName,
		String	aDescription,
		String	aType,
		String	aPath,
		int	aFlags
	)		throws SignDocException

Add an attachment (read from a file) to the document.

Attachments are supported for PDF documents only.

Parameters:

[in]	aName	The name of the attachment. Will also be used as filename of the attachment and must not contain slashes, backslashes, and colons.
[in]	aDescription	The description of the attachment (can be null and empty except for PDF/A-3 documents).
[in]	aType	The MIME type of the attachment (can be null and empty).
[in]	aPath	The pathname of the file to be attached.
[in]	aFlags	Must be zero.

See also:: addAttachmentBlob(), getAttachments(), removeAttachment()

synchronized void de.softpro.doc.SignDocDocument.addField	(	SignDocField	aField,
		int	aFlags
	)		throws SignDocException

Add a field.

See the members of SignDocField for details.

This function can add check boxes, radio button groups, text fields, and signature fields to PDF documents.

When adding a radio button group or a check box field, a value must be set, see SignDocField.setValue() and SignDocField.setValueIndex().

The SignDocField.f_NoToggleToOff flag should be set for all radio button groups. Adobe products seem to ignore this flag being not set.

When adding a text field, the justification must be set with SignDocField.setJustification().

Currently, you don't have control over the appearance of the field being inserted except for the text field attributes.

Adding a field to a PDF document that doesn't contain any fields will set the document's default text field attributes to font Helvetica, font size 0, text color black.

Only signature fields can be added to PDF documents having signed signature fields.

TIFF documents support signature fields only and all signature fields must be inserted before the first signature is added to the document (you may want to use invisible fields) unless all existing signature fields have flag f_EnableAddAfterSigning set.

Parameters:

[in,out]	aField	The new field. The font resource name of the default text field attributes may be modified. The value index and the value may be modified for radio button fields and check box fields.
[in]	aFlags	Set of flags (sff_keep_ap, sff_fit_height_only, sff_force_border_width, sff_dont_break_lines, sff_auto_alignment, sff_ltr, sff_rtr, sff_default_ltr, and sff_default_rtl) combined with `\|' modifying the behavior of this function. Pass 0 for no flags.

See also:: getField(), removeField(), setField(), setTextFieldAttributes(), f_fail_for_broken_target_structure, f_require_alternate_field_name

synchronized void de.softpro.doc.SignDocDocument.addImageFromBlob	(	int	aTargetPage,
		byte[]	aData,
		double	aZoom,
		double	aX,
		double	aY,
		double	aWidth,
		double	aHeight,
		int	aFlags
	)		throws SignDocException

Add an image (from a blob) to a page.

This function behaves like addImageFromBlob2() with an empty string for aDescription, that is, if the document uses Tagged PDF, a dummy alternate description for the image ("image" with language code "en") will provided to avoid breaking standard compliance. It is strongly recommended to use addImageFromBlob2() with a meaningful description of the image.

Parameters:

[in]	aTargetPage	The 1-based number of the page.
[in]	aData	The blob containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP.
[in]	aZoom	Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom.
[in]	aX	The X coordinate of the point at which the lower left corner of the image shall be placed.
[in]	aY	The Y coordinate of the point at which the lower left corner of the image shall be placed.
[in]	aWidth	Image width (document coordinates) or zero. The image will be scaled to this width. If this argument is non-zero, aZoom must be zero and either aHeight must be non-zero or ii_keep_aspect_ratio must be set in aFlags.
[in]	aHeight	Page height (document coordinates) or zero. The image will be scaled to this height. If this argument is non-zero, aZoom must be zero and either aWidth must be non-zero or ii_keep_aspect_ratio must be set in aFlags.
[in]	aFlags	Flags modifying the behavior of this function, See ii_keep_aspect_ratio. ii_keep_aspect_ratio is not needed if aZoom is non-zero.

See also:: addImageFromBlob2(), addImageFromFile(), addImageFromFile2(), importPageFromImageBlob(), importPageFromImageBlob2(), isTaggedPDF(), f_fail_for_broken_target_structure

synchronized void de.softpro.doc.SignDocDocument.addImageFromBlob2	(	int	aTargetPage,
		byte[]	aData,
		double	aZoom,
		double	aX,
		double	aY,
		double	aWidth,
		double	aHeight,
		int	aFlags,
		String	aDescription,
		String	aLang
	)		throws SignDocException

Add an image (from a blob) to a page (with alternate description).

Parameters:

[in]	aTargetPage	The 1-based number of the page.
[in]	aData	The blob containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP.
[in]	aZoom	Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom.
[in]	aX	The X coordinate of the point at which the lower left corner of the image shall be placed.
[in]	aY	The Y coordinate of the point at which the lower left corner of the image shall be placed.
[in]	aWidth	Image width (document coordinates) or zero. The image will be scaled to this width. If this argument is non-zero, aZoom must be zero and either aHeight must be non-zero or ii_keep_aspect_ratio must be set in aFlags.
[in]	aHeight	Page height (document coordinates) or zero. The image will be scaled to this height. If this argument is non-zero, aZoom must be zero and either aWidth must be non-zero or ii_keep_aspect_ratio must be set in aFlags.
[in]	aFlags	Flags modifying the behavior of this function, See ii_keep_aspect_ratio. ii_keep_aspect_ratio is not needed if aZoom is non-zero.
[in]	aDescription	Alternate description for the image. If this value is null or an empty string, aLang will be ignored. If this value is null or an empty string and the document uses Tagged PDF, "image" with language code "en" will be used to avoid breaking standard compliance. It is strongly recommended to use a meaningful description. Escape sequences must not be used.
[in]	aLang	Language identifier for aDescription. Unless aDescription is an empty string, this must be a string containing an RFC 3066 language tag. Example: "en-US".

See also:: addImageFromBlob(), addImageFromFile(), addImageFromFile2(), importPageFromImageBlob(), importPageFromImageBlob2(), isTaggedPDF(), f_fail_for_broken_target_structure

synchronized void de.softpro.doc.SignDocDocument.addImageFromFile	(	int	aTargetPage,
		String	aPath,
		double	aZoom,
		double	aX,
		double	aY,
		double	aWidth,
		double	aHeight,
		int	aFlags
	)		throws SignDocException

Add an image (from a file) to a page.

This function behaves like addImageFromFile2() with an empty string for aDescription, that is, if the document uses Tagged PDF, a dummy alternate description for the image ("image" with language code "en") will provided to avoid breaking standard compliance. It is strongly recommended to use addImageFromFile2() with a meaningful description of the image.

Parameters:

[in]	aTargetPage	The 1-based number of the page.
[in]	aPath	The pathname of the file containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP.
[in]	aZoom	Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom.
[in]	aX	The X coordinate of the point at which the lower left corner of the image shall be placed.
[in]	aY	The Y coordinate of the point at which the lower left corner of the image shall be placed.
[in]	aWidth	Image width (document coordinates) or zero. The image will be scaled to this width. If this argument is non-zero, aZoom must be zero and either aHeight must be non-zero or ii_keep_aspect_ratio must be set in aFlags.
[in]	aHeight	Page height (document coordinates) or zero. The image will be scaled to this height. If this argument is non-zero, aZoom must be zero and either aWidth must be non-zero or ii_keep_aspect_ratio must be set in aFlags.
[in]	aFlags	Flags modifying the behavior of this function, See ii_keep_aspect_ratio. ii_keep_aspect_ratio is not needed if aZoom is non-zero.

See also:: addImageFromBlob(), addImageFromBlob2(), addImageFromFile2(), importPageFromImageBlob(), importPageFromImageBlob2(), isTaggedPDF(), f_fail_for_broken_target_structure

synchronized void de.softpro.doc.SignDocDocument.addImageFromFile2	(	int	aTargetPage,
		String	aPath,
		double	aZoom,
		double	aX,
		double	aY,
		double	aWidth,
		double	aHeight,
		int	aFlags,
		String	aDescription,
		String	aLang
	)		throws SignDocException

Add an image (from a file) to a page.

Parameters:

[in]	aTargetPage	The 1-based number of the page.
[in]	aPath	The pathname of the file containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP.
[in]	aZoom	Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom.
[in]	aX	The X coordinate of the point at which the lower left corner of the image shall be placed.
[in]	aY	The Y coordinate of the point at which the lower left corner of the image shall be placed.
[in]	aWidth	Image width (document coordinates) or zero. The image will be scaled to this width. If this argument is non-zero, aZoom must be zero and either aHeight must be non-zero or ii_keep_aspect_ratio must be set in aFlags.
[in]	aHeight	Page height (document coordinates) or zero. The image will be scaled to this height. If this argument is non-zero, aZoom must be zero and either aWidth must be non-zero or ii_keep_aspect_ratio must be set in aFlags.
[in]	aFlags	Flags modifying the behavior of this function, See ii_keep_aspect_ratio. ii_keep_aspect_ratio is not needed if aZoom is non-zero.
[in]	aDescription	Alternate description for the image. If this value is null or an empty string, aLang will be ignored. If this value is null or an empty string and the document uses Tagged PDF, "image" with language code "en" will be used to avoid breaking standard compliance. It is strongly recommended to use a meaningful description. Escape sequences must not be used.
[in]	aLang	Language identifier for aDescription. Unless aDescription is an empty string, this must be a string containing an RFC 3066 language tag. Example: "en-US".

See also:: addImageFromBlob(), addImageFromBlob2(), addImageFromFile(), importPageFromImageBlob(), importPageFromImageBlob2(), isTaggedPDF(), f_fail_for_broken_target_structure

synchronized void de.softpro.doc.SignDocDocument.addPage	(	int	aTargetPage,
		double	aWidth,
		double	aHeight
	)		throws SignDocException

Add an empty page to the document.

This function is currently implemented for PDF documents only.

Parameters:

[in]	aTargetPage	The 1-based number of the page before which to insert the new page. The page will be appended if this value is 0.
[in]	aWidth	The width of the page (in 1/72 inches for PDF documents).
[in]	aHeight	The height of the page (in 1/72 inches for PDF documents).

synchronized void de.softpro.doc.SignDocDocument.addSignature	(	SignDocSignatureParameters	aSignatureParameters,
		SignDocVerificationParameters	aVerificationParameters
	)		throws SignDocException

Sign the document.

This function stores changed properties in the document before signing. If string parameter "OutputPath" is set, the signed document will be stored in a new file specified by that parameter and the original file won't be modified. If "OutputPath" is not set, the document will be written to the file from which it was loaded or to which it was most recently saved.

If a PDF document is backed by memory (most recently saved to memory or loaded from memory) and "OutputPath" is empty, the signed document will not be saved. Use

 doc.copyToStream (stream, 0);

to save the signed document in that case.

If string parameter "OutputPath" is set to the special value "<memory>" for a PDF document, it will be saved to memory and signed in memory. You'll have to save the document as described in the preceding paragraph.

Some document types may allow adding signatures only if all signatures of the documents are valid.

For PDF documents, this function either signs or certifies the document, see integer parameter DocMDP.

If you are using RFC 3161 timestamps and get error rc_unexpected_error with a message like "Contents overflow: xxx vs. yyy", try using a bigger value for integer parameter "TimeStampSize".

This function performs a basic verification of the signature after signing a PDF document unless siff_dont_verify_after_signing is set. This ensures that the private key matches the certificate. If that verification fails, SignDocInvalidSignatureException will be thrown.

Parameters:

[in]	aSignatureParameters	The signing parameters. The parameters can be used only once, for a single signature.
[in]	aVerificationParameters	Verification parameters or null for default parameters. If revocation checking is enabled in aVerificationParameters, the revocation state of the certificates (subject to integer parameter "VerificationModel") in both the signing certificate's certificate chain and (if RFC 3161 time stamps are enabled) the RFC 3161 time stamp's certificate chain is checked. These verification parameters are not used for verifying the certificate chain of HTTPS connections to RFC 3161 time-stamp servers.

See also:: copyToStream(), createSignatureParameters(), createSignatureParametersForTimeStamp(), getPathname(), setStringProperty()

synchronized void de.softpro.doc.SignDocDocument.addText	(	String	aText,
		int	aPage,
		double	aX,
		double	aY,
		String	aFontName,
		double	aFontSize,
		SignDocColor	aTextColor,
		double	aOpacity,
		int	aFlags
	)		throws SignDocException

Add text to a page.

This function behaves like addText2() with an empty string for aLang.

Multiple lines are not supported, the text must not contain CR and LF characters.

Note:: addTextRect() is better than addText() for RTL text.

Parameters:

[in]	aText	The text. Complex scripts are supported, see Complex Scripts. Escape sequences must not be used.
[in]	aPage	The 1-based page number of the page.
[in]	aX	The X coordinate of the reference point of the visually left-most character in document coordinates.
[in]	aY	The Y coordinate of the reference point of the visually left-most character in document coordinates.
[in]	aFontName	The font name. This can be the name of a standard font, the name of an already embedded font, or the name of a font defined by a font configuration file.
[in]	aFontSize	The font size (in user space units).
[in]	aTextColor	The text color.
[in]	aOpacity	The opacity, 0.0 (transparent) through 1.0 (opaque). Documents conforming to PDF/A-1 must use an opacity of 1.0.
[in]	aFlags	Must be 0.

See also:: addText2(), addTextRect() addWatermark(), f_fail_for_broken_target_structure, f_require_lang, SignDocDocumentLoader.loadFontConfigFile(), SignDocDocumentLoader.loadFontConfigEnvironment(), SignDocDocumentLoader.loadFontConfigStream()

Todo:: implement for TIFF documents

synchronized void de.softpro.doc.SignDocDocument.addText2	(	String	aText,
		int	aPage,
		double	aX,
		double	aY,
		String	aFontName,
		double	aFontSize,
		SignDocColor	aTextColor,
		double	aOpacity,
		int	aFlags,
		String	aLang
	)		throws SignDocException

Add text to a page (with language identifier).

Multiple lines are not supported, the text must not contain CR and LF characters.

Note:: addTextRect2() is better than addText2() for RTL text.

Parameters:

[in]	aText	The text. Complex scripts are supported, see Complex Scripts. Escape sequences must not be used.
[in]	aPage	The 1-based page number of the page.
[in]	aX	The X coordinate of the reference point of the visually left-most character in document coordinates.
[in]	aY	The Y coordinate of the reference point of the visually left-most character in document coordinates.
[in]	aFontName	The font name. This can be the name of a standard font, the name of an already embedded font, or the name of a font defined by a font configuration file.
[in]	aFontSize	The font size (in user space units).
[in]	aTextColor	The text color.
[in]	aOpacity	The opacity, 0.0 (transparent) through 1.0 (opaque). Documents conforming to PDF/A-1 must use an opacity of 1.0.
[in]	aFlags	Must be 0.
[in]	aLang	Language identifier for aText, either an RFC 3066 language tag (example: "en-US") or an empty string or null. If a PDF/UA document does not specify a natural language, a language identifier is required. If a language identifier is required and aLang is an empty string or null, the behavior depends on flag f_require_lang: if f_require_lang is set, this function will fail if f_require_lang is not set, language tag "en" (or the language set with setDefaultDocumentLanguage()) will be used.

See also:: addText(), addTextRect2() addWatermark(), setDefaultDocumentLanguage(), f_fail_for_broken_target_structure, f_require_lang, SignDocDocumentLoader.loadFontConfigFile(), SignDocDocumentLoader.loadFontConfigEnvironment(), SignDocDocumentLoader.loadFontConfigStream()

Todo:: implement for TIFF documents

synchronized void de.softpro.doc.SignDocDocument.addTextRect	(	String	aText,
		int	aPage,
		double	aX0,
		double	aY0,
		double	aX1,
		double	aY1,
		String	aFontName,
		double	aFontSize,
		double	aLineSkip,
		SignDocColor	aTextColor,
		double	aOpacity,
		int	aHAlignment,
		int	aVAlignment,
		int	aFlags
	)		throws SignDocException

Add text in a rectangle of a page (with line breaking).

This function behaves like addTextRect2() with an empty string for aLang.

The interpretation of CR and LF in the text depends on the value of aFlags, see atrf_compat.

Parameters:

[in]	aText	The text. The interpretation of CR and LF depends on the value of aFlags. Escape sequences must not be used.
[in]	aPage	The 1-based page number of the page.
[in]	aX0	X coordinate of lower left corner.
[in]	aY0	Y coordinate of lower left corner.
[in]	aX1	X coordinate of upper right corner.
[in]	aY1	Y coordinate of upper right corner.
[in]	aFontName	The font name. This can be the name of a standard font, the name of an already embedded font, or the name of a font defined by a font configuration file.
[in]	aFontSize	The font size (in user space units).
[in]	aLineSkip	The vertical distance between the baselines of successive lines (usually 1.2 * aFontSize).
[in]	aTextColor	The text color.
[in]	aHAlignment	Horizontal alignment of the text (ha_left, ha_center, ha_right, or ha_auto).
[in]	aVAlignment	Vertical alignment of the text (va_top, va_center, or va_bottom).
[in]	aOpacity	The opacity, 0.0 (transparent) through 1.0 (opaque). Documents conforming to PDF/A-1 must use an opacity of 1.0.
[in]	aFlags	Flags modifying the behavior of this function, see atrf_compat, atrf_ltr, atrf_rtl, atrf_default_ltr, and atrf_default_rtl.

See also:: addText() addTextRect2(), addWatermark(), f_fail_for_broken_target_structure, f_require_lang, SignDocDocumentLoader.loadFontConfigFile(), SignDocDocumentLoader.loadFontConfigEnvironment(), SignDocDocumentLoader.loadFontConfigStream()

Todo:: implement for TIFF documents

synchronized void de.softpro.doc.SignDocDocument.addTextRect2	(	String	aText,
		int	aPage,
		double	aX0,
		double	aY0,
		double	aX1,
		double	aY1,
		String	aFontName,
		double	aFontSize,
		double	aLineSkip,
		SignDocColor	aTextColor,
		double	aOpacity,
		int	aHAlignment,
		int	aVAlignment,
		int	aFlags,
		String	aLang
	)		throws SignDocException

Add text in a rectangle of a page (with line breaking and language identifier).

The interpretation of CR and LF in the text depends on the value of aFlags, see atrf_compat.

Parameters:

[in]	aText	The text. The interpretation of CR and LF depends on the value of aFlags. Escape sequences must not be used.
[in]	aPage	The 1-based page number of the page.
[in]	aX0	X coordinate of lower left corner.
[in]	aY0	Y coordinate of lower left corner.
[in]	aX1	X coordinate of upper right corner.
[in]	aY1	Y coordinate of upper right corner.
[in]	aFontName	The font name. This can be the name of a standard font, the name of an already embedded font, or the name of a font defined by a font configuration file.
[in]	aFontSize	The font size (in user space units).
[in]	aLineSkip	The vertical distance between the baselines of successive lines (usually 1.2 * aFontSize).
[in]	aTextColor	The text color.
[in]	aHAlignment	Horizontal alignment of the text (ha_left, ha_center, ha_right, or ha_auto).
[in]	aVAlignment	Vertical alignment of the text (va_top, va_center, or va_bottom).
[in]	aOpacity	The opacity, 0.0 (transparent) through 1.0 (opaque). Documents conforming to PDF/A-1 must use an opacity of 1.0.
[in]	aFlags	Flags modifying the behavior of this function, see atrf_compat, atrf_ltr, atrf_rtl, atrf_default_ltr, and atrf_default_rtl.
[in]	aLang	Language identifier for aText, either an RFC 3066 language tag (example: "en-US") or an empty string or null. If a PDF/UA document does not specify a natural language, a language identifier is required. If a language identifier is required and aLang is an empty string or null, the behavior depends on flag f_require_lang: if f_require_lang is set, this function will fail if f_require_lang is not set, language tag "en" (or the language set with setDefaultDocumentLanguage()) will be used.

See also:: addText2() addTextRect(), addWatermark(), f_fail_for_broken_target_structure, f_require_lang, SignDocDocumentLoader.loadFontConfigFile(), SignDocDocumentLoader.loadFontConfigEnvironment(), SignDocDocumentLoader.loadFontConfigStream()

Todo:: implement for TIFF documents

synchronized void de.softpro.doc.SignDocDocument.addWatermark ( SignDocWatermark aInput ) throws SignDocException

Add a watermark.

Parameters:

[in] aInput An object describing the watermark.

See also:: addText(), addTextRect(), addTextRect2(), SignDocDocumentLoader.loadFontConfigFile(), SignDocDocumentLoader.loadFontConfigEnvironment(), SignDocDocumentLoader.loadFontConfigStream()

Todo:: implement for TIFF documents

synchronized void de.softpro.doc.SignDocDocument.applyFdf	(	String	aPath,
		int	aFlags
	)		throws SignDocException

Apply an FDF document to a PDF document.

FDF documents can be applied to PDF documents only.

Parameters:

[in]	aPath	The pathname of the FDF document.
[in]	aFlags	Flags modifying the behavior of this function, see sff_keep_ap, sff_update_ap, sff_fit_height_only, sff_force_border_width, sff_dont_break_lines, sff_auto_alignment, sff_ltr, sff_rtr, sff_default_ltr, and sff_default_rtl.

synchronized void de.softpro.doc.SignDocDocument.changeAttachmentDescription	(	String	aName,
		String	aDescription
	)		throws SignDocException

Change the description of an attachment of the document.

Attachments are supported for PDF documents only.

Parameters:

[in]	aName	The name of the attachment.
[in]	aDescription	The new description of the attachment (can be null and empty).

See also:: addAttachmentBlob(), addAttachmentFile(), getAttachments(), removeAttachment()

synchronized int de.softpro.doc.SignDocDocument.checkAttachment ( String aName ) throws SignDocException

Check the checksum of an attachment.

Attachments are supported for PDF documents only.

Parameters:

[in] aName The name of the attachment.

Returns:: car_match, car_no_checksum, or car_mismatch.

See also:: getAttachment(), getAttachments(), getAttachment(), getAttachmentBlob(), getAttachmentStream()

synchronized void de.softpro.doc.SignDocDocument.clearAllSignatures ( ) throws SignDocException

Remove all signatures of the document.

This includes any certification signature, see removeDocMDP().

See also:: clearSignature(), clearApprovalSignatures(), removeDocMDP()

synchronized void de.softpro.doc.SignDocDocument.clearApprovalSignatures ( ) throws SignDocException

Remove all approval signatures of the document.

Note:: In TIFF documents, all signatures are approval signatures.

See also:: clearAllSignatures(), clearSignature(), removeDocMDP()

synchronized void de.softpro.doc.SignDocDocument.clearSignature ( String aFieldName ) throws SignDocException

Remove a signature of the document.

For some document formats (TIFF), signatures may only be cleared in the reverse order of signing (LIFO).

Parameters:

[in] aFieldName The name of the signature field.

See also:: clearAllSignatures(), clearApprovalSignatures(), getFields(), SignDocField.f_CurrentlyClearable

synchronized void de.softpro.doc.SignDocDocument.close ( ) throws SignDocException

Close the document and the underlying file.

After closing the document, all methods but close() will throw SignDocUnexpectedErrorException.

synchronized double de.softpro.doc.SignDocDocument.computeZoom ( SignDocRenderParameters aParams ) throws SignDocException

Compute the zoom factor used for rendering.

If de.softpro.doc.SignDocRenderParameters.fitWidth(), de.softpro.doc.SignDocRenderParameters.fitHeight(), or de.softpro.doc.SignDocRenderParameters.fitRect() has been called, the actual factor depends on the document's page size. If multiple pages are selected (see de.softpro.doc.SignDocRenderParameters.setPages()), the maximum width and maximum height of all selected pages will be used.

Parameters:

[in] aParams The parameters such as the page number and the zoom factor.

Returns:: The computed zoom factor.

See also:: getRenderedSize(), renderPageAsImage(), SignDocRenderParameters.fitHeight(), SignDocRenderParameters.fitRect(), SignDocRenderParameters.fitWidth(), SignDocRenderParameters.setPages(), SignDocRenderParameters.setZoom()

synchronized void de.softpro.doc.SignDocDocument.convCanvasPointToPagePoint	(	Point	aPoint,
		SignDocRenderParameters	aParams
	)		throws SignDocException

Convert a point expressed in canvas (image) coordinates to a point expressed in document coordinate system of the current page.

The origin is in the bottom left corner of the page. The origin is in the upper left corner of the image. See Coordinate Systems. If multiple pages are selected (see de.softpro.doc.SignDocRenderParameters.setPages()), the first page of the range will be used.

Suppose the current page of a PDF document has height PH and the rendered image has height IH. Then, point (0,0) will be converted to (0,PH) and point (0,IH) will be converted to (0,0).

Parameters:

[in,out]	aPoint	The point to be converted.
[in]	aParams	The parameters such as the page number and the zoom factor.

synchronized void de.softpro.doc.SignDocDocument.convPagePointToCanvasPoint	(	Point	aPoint,
		SignDocRenderParameters	aParams
	)		throws SignDocException

Convert a point expressed in document coordinate system of the current page to a point expressed in canvas (image) coordinates.

The origin is in the bottom left corner of the page. The origin is in the upper left corner of the image. See Coordinate Systems. If multiple pages are selected (see de.softpro.doc.SignDocRenderParameters.setPages()), the first page of the range will be used.

Suppose the current page of a PDF document has height PH and the rendered image has height IH. Then, point (0,0) will be converted to (0,IH) and point (0,PH) will be converted to (0,0).

Parameters:

[in,out]	aPoint	The point to be converted.
[in]	aParams	The parameters such as the page number and the zoom factor.

synchronized void de.softpro.doc.SignDocDocument.copyAsSignedToStream	(	java.io.OutputStream	aStream,
		String	aFieldName
	)		throws SignDocException

Copy the document to a stream for viewing the document "as signed".

This function copies to a stream the document as it was when the specified signature field was signed. If the specified signature field contains the last signature applied to the document, this function is equivalent to copyToStream(). However, for some document formats, this function may require signatures to be valid.

Parameters:

[in]	aStream	The file will be copied to this stream.
[in]	aFieldName	The name of the signature field.

Returns:: rc_ok iff successful.

See also:: copyToStream(), SignDocDocumentLoader.loadFromMemory()

synchronized void de.softpro.doc.SignDocDocument.copyToStream	(	java.io.OutputStream	aStream,
		int	aFlags
	)		throws SignDocException

Copy the document's current status or backing file or backing blob to a stream.

If ctsf_unsaved is not set in aFlags , this function will copy to a stream the file or blob from which the document was loaded or to which the document was most recently saved. Changes made to the in-memory copy of the document since it was loaded or saved will not be reflected in the copy written to the stream.

If ctsf_unsaved is set in aFlags, unsaved changes made to the in-memory copy of the document will be included (as incremental update for PDF documents) in the stream.

This function does not have side effects on the in-memory copy of the document, that is, unsaved changes remain unsaved (except for being saved to the stream if ctsf_unsaved is set in aFlags).

Parameters:

[in]	aStream	The file will be copied to this stream.
[in]	aFlags	Flags modifying the behavior of this function, see ctsf_unsaved.

See also:: copyAsSignedToStream(), saveToFile(), saveToStream(), SignDocDocumentLoader.loadFromFile(), SignDocDocumentLoader.loadFromMemory()

synchronized SignDocAnnotation de.softpro.doc.SignDocDocument.createFreeTextAnnotation	(	Point	aLowerLeft,
		Point	aUpperRight
	)		throws SignDocException

Create a text annotation.

See SignDocAnnotation for details.

This function uses document (page) coordinates, see Coordinate Systems.

Parameters:

[in]	aLowerLeft	coordinates of lower left corner.
[in]	aUpperRight	coordinates of upper right corner.

Returns:: The new annotation object.

See also:: addAnnotation()

synchronized SignDocAnnotation de.softpro.doc.SignDocDocument.createFreeTextAnnotation	(	double	aX0,
		double	aY0,
		double	aX1,
		double	aY1
	)		throws SignDocException

Create a text annotation.

See SignDocAnnotation for details.

This function uses document (page) coordinates, see Coordinate Systems.

Parameters:

[in]	aX0	X coordinate of lower left corner.
[in]	aY0	Y coordinate of lower left corner.
[in]	aX1	X coordinate of upper right corner.
[in]	aY1	Y coordinate of upper right corner.

Returns:: The new annotation object.

See also:: addAnnotation()

synchronized SignDocAnnotation de.softpro.doc.SignDocDocument.createLineAnnotation	(	Point	aStart,
		Point	aEnd
	)		throws SignDocException

Create a line annotation.

See SignDocAnnotation for details.

This function uses document (page) coordinates, see Coordinate Systems.

Parameters:

[in]	aStart	Start point.
[in]	aEnd	End point.

Returns:: The new annotation object.

See also:: addAnnotation()

synchronized SignDocAnnotation de.softpro.doc.SignDocDocument.createLineAnnotation	(	double	aStartX,
		double	aStartY,
		double	aEndX,
		double	aEndY
	)		throws SignDocException

Create a line annotation.

See SignDocAnnotation for details.

This function uses document (page) coordinates, see Coordinate Systems.

Parameters:

[in]	aStartX	X coordinate of start point.
[in]	aStartY	Y coordinate of start point.
[in]	aEndX	X coordinate of end point.
[in]	aEndY	Y coordinate of end point.

Returns:: The new annotation object.

See also:: addAnnotation()

synchronized SignDocAnnotation de.softpro.doc.SignDocDocument.createScribbleAnnotation ( ) throws SignDocException

Create a scribble annotation.

See SignDocAnnotation for details.

Returns:: The new annotation object.

See also:: addAnnotation(), SignDocAnnotation.addPoint(), SignDocAnnotation.newStroke()

synchronized SignDocSignatureParameters de.softpro.doc.SignDocDocument.createSignatureParameters	(	String	aFieldName,
		String	aProfile
	)		throws SignDocException

Create a SignDocSignatureParameters object for signing a signature field.

Each SignDocSignatureParameters object should be used for at most one signature.

The following profiles are available and documented:

Profile	Document Types	Description
""	PDF, TIFF	Image above Signer and SignTime
"image"	PDF, TIFF	Image only

For TIFF documents, "" produces the same output as "image".

Profile "" is defined by this template:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE SignatureTemplate SYSTEM "SignatureTemplate.dtd">
<SignatureTemplate
    text-halignment="center"
    text-valignment="bottom"
    image-halignment="center"
    image-valignment="top"
    image-transparency="brightest"
    text-position="below"
    font-size="0.1 h"
    text-hmargin="0.1 h"
    image-margin="1">
  <Line item="Signer"/>
  <Line item="SignTime"/>
</SignatureTemplate>

Profile "image" is defined by this template:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE SignatureTemplate SYSTEM "SignatureTemplate.dtd">
<SignatureTemplate
    text-halignment="center"
    text-valignment="center"
    image-halignment="center"
    image-valignment="center"
    image-transparency="brightest"
    text-position="overlay"
    font-size="0.1 h"
    text-hmargin="0.1 h"
    image-margin="1">
</SignatureTemplate>

Parameters:

[in]	aFieldName	The name of the signature field.
[in]	aProfile	The profile name. Some document types and signature fields support different sets of default parameters. The default profile, "", is supported for all signature fields.

Returns:: The new parameters object.

See also:: addSignature(), createSignatureParametersForTimeStamp(), getProfiles()

synchronized SignDocSignatureParameters de.softpro.doc.SignDocDocument.createSignatureParametersForTimeStamp ( ) throws SignDocException

Create a SignDocSignatureParameters object for adding a document time stamp.

Each SignDocSignatureParameters object should be used for at most one signature.

Returns:: The new parameters object.

See also:: addSignature(), createSignatureParameters()

synchronized void de.softpro.doc.SignDocDocument.exportFields	(	java.io.OutputStream	aStream,
		int	aFlags
	)		throws SignDocException

Export all fields as XML.

This function always uses UTF-8 encoding. The output conforms to schema PdfFields.xsd.

There is a setFlags() flag modifying the behavior of this function: f_ambiguous_button_value_empty.

Parameters:

[in]	aStream	The fields will be saved to this stream.
[in]	aFlags	Flags modifying the behavior of this function, See e_top.

See also:: getFields(), setField()

Todo:: implement for TIFF

synchronized void de.softpro.doc.SignDocDocument.exportProperties	(	String	aCollection,
		java.io.OutputStream	aStream,
		int	aFlags
	)		throws SignDocException

Export all properties (in all collections) as XML.

/** Export properties as XML.

This function always uses UTF-8 encoding. The output conforms to schema AllSignDocProperties.xsd (if aCollection is empty) or SignDocProperties.xsd (if aCollection is non-empty).

Parameters:

[in]	aCollection	The name of the collection, see getProperties(). If the string is empty, all properties of the "public" and "encrypted" collections will be exported.
[in]	aStream	The properties will be saved to this stream.
[in]	aFlags	Flags modifying the behavior of this function, See e_top.

See also:: importProperties()

void de.softpro.doc.SignDocDocument.finalize ( ) throws Throwable [protected]

Finalize this object.

Do not call this method unless you know what you are doing.

synchronized SignDocFindTextPosition [] de.softpro.doc.SignDocDocument.findText	(	int	aFirstPage,
		int	aLastPage,
		String	aText,
		int	aFlags
	)		throws SignDocException

Find text.

Parameters:

[in]	aFirstPage	1-based number of first page to be searched.
[in]	aLastPage	1-based number of last page to be searched or 0 to search to the end of the document.
[in]	aText	Text to be searched for. Multiple successive spaces are treated as single space (and may be ignored subject to aFlags).
[in]	aFlags	Flags modifying the behavior of this function, see ftf_ignore_hspace, ftf_ignore_hyphenation, and ftf_ignore_sequence.

Returns:: The positions where aText was found or null if not found.

synchronized void de.softpro.doc.SignDocDocument.flattenAnnotations	(	int	aFirstPage,
		int	aLastPage,
		int	aFlags
	)		throws SignDocException

Flatten all annotations of the document or of a range of pages.

Flattening an annotation of a PDF document makes its appearance part of the page and removes the selected annotation or all annotations. This function selects all non-widget annotations on the specified pages, ie, it does not flatten fields.

Flattening annotations breaks existing signatures. If you are flattening annotations only for printing with PDF components that don't support annotations, make a copy of the document, pass

 SignDocDocument.siff_allow_breaking_permissions | SignDocDocument.siff_allow_breaking_signatures

to setShootInFoot(), flatten the annotations, print the document, and throw it away.

Parameters:

[in]	aFirstPage	1-based number of first page.
[in]	aLastPage	1-based number of last page or 0 to process all pages to the end of the document.
[in]	aFlags	Flags modifying the behavior of this function, see faf_include_hidden and faf_keep_structure.

See also:: flattenFields(), removeAnnotation()

synchronized void de.softpro.doc.SignDocDocument.flattenField	(	String	aName,
		int	aWidget
	)		throws SignDocException

Flatten a field.

Flattening a field of a PDF document makes its appearance part of the page and removes the selected widget or all widgets; the field will be removed when all its widgets have been flattened.

Flattening unsigned signature fields does not work correctly.

Flattening fields breaks existing signatures. If you are flattening fields only for printing with PDF components that don't support annotations, make a copy of the document, pass

 SignDocDocument.siff_allow_breaking_permissions | SignDocDocument.siff_allow_breaking_signatures

to setShootInFoot(), flatten the fields, print the document, and throw it away.

Parameters:

[in]	aName	The fully-qualified name of the field.
[in]	aWidget	The widget index to flatten only one widget or -1 to flatten all widgets.

See also:: flattenFields(), removeField()

synchronized void de.softpro.doc.SignDocDocument.flattenFields	(	int	aFirstPage,
		int	aLastPage,
		int	aFlags
	)		throws SignDocException

Flatten all fields of the document or of a range of pages.

Flattening a field of a PDF document makes its appearance part of the page and removes the selected widget or all widgets; the field will be removed when all its widgets have been flattened. This function selects all widgets on the specified pages.

Flattening unsigned signature fields does not work correctly.

Flattening fields breaks existing signatures. If you are flattening fields only for printing with PDF components that don't support annotations, make a copy of the document, pass

 SignDocDocument.siff_allow_breaking_permissions | SignDocDocument.siff_allow_breaking_signatures

to setShootInFoot(), flatten the fields, print the document, and throw it away.

Parameters:

[in]	aFirstPage	1-based number of first page.
[in]	aLastPage	1-based number of last page or 0 to process all pages to the end of the document.
[in]	aFlags	Flags modifying the behavior of this function, see fff_include_signature_unsigned, fff_include_signature_signed, fff_include_hidden, and fff_keep_structure. If this value is 0, signature fields and hidden/invisible widgets will not be flattened.

See also:: flattenAnnotations(), flattenField(), removeField()

synchronized SignDocAnnotation de.softpro.doc.SignDocDocument.getAnnotation	(	int	aPage,
		String	aName
	)		throws SignDocException

Get a named annotation of a page.

All setters will fail for the returned object.

Parameters:

[in]	aPage	The page number (1 for the first page).
[in]	aName	The name of the annotation.

Returns:: The annotation object.

See also:: getAnnotations()

synchronized String [] de.softpro.doc.SignDocDocument.getAnnotations ( int aPage ) throws SignDocException

Get a list of all named annotations of a page.

Unnamed annotations are ignored by this function.

Parameters:

[in] aPage The page number (1 for the first page).

Returns:: The list of annotation names. The order is currently unspecified, a future implementation may return the annotations in tab order.

See also:: addAnnotation(), getAnnotation(), removeAnnotation(), SignDocAnnotation.setName()

Todo:: Get annotations in tab order.

synchronized SignDocAttachment de.softpro.doc.SignDocDocument.getAttachment ( String aName ) throws SignDocException

Get information about an attachment.

Attachments are supported for PDF documents only.

Parameters:

[in] aName The name of the attachment.

Returns:: Information about the attachment.

See also:: checkAttachment(), getAttachments(), getAttachmentBlob(), getAttachmentStream()

synchronized byte [] de.softpro.doc.SignDocDocument.getAttachmentBlob ( String aName ) throws SignDocException

Get an attachment as blob.

Attachments are supported for PDF documents only.

Parameters:

[in] aName The name of the attachment.

Returns:: The attachment's data.

See also:: checkAttachment(), getAttachments(), getAttachmentStream()

synchronized String [] de.softpro.doc.SignDocDocument.getAttachments ( ) throws SignDocException

Get a list of all attachments of the document.

Attachments are supported for PDF documents only.

Returns:: The names of the document's attachments. Use getAttachment() to get information for a single attachment.

See also:: checkAttachment(), getAttachment(), getAttachmentBlob(), getAttachmentStream()

synchronized java.io.InputStream de.softpro.doc.SignDocDocument.getAttachmentStream ( String aName ) throws SignDocException

Get an InputStream for an attachment.

Attachments are supported for PDF documents only.

Parameters:

[in] aName The name of the attachment.

Returns:: An InputStream object for the attachment's data.; rc_ok iff successful.

See also:: checkAttachment(), getAttachments(), getAttachmentBlob()

synchronized int de.softpro.doc.SignDocDocument.getAvailableMethods ( ) throws SignDocException

Get a bitset indicating which signing methods are available for this document.

This document's signature fields offer a subset of the signing methods returned by this function.

Returns:: 1<<SignDocSignatureParameters.m_digsig_pkcs1 etc.

See also:: SignDocSignatureParameters.getAvailableMethods()

synchronized double de.softpro.doc.SignDocDocument.getBitsPerPixel ( int aPage ) throws SignDocException

Get the number of bits per pixel (TIFF only).

Different pages of the document may have different numbers of bits per pixel.

Parameters:

[in] aPage The page number (1 for the first page).

Returns:: The number of bits per pixel of the page (1, 8, 24, or 32) or 0 (for PDF documents).

synchronized boolean de.softpro.doc.SignDocDocument.getBooleanProperty	(	String	aCollection,
		String	aName
	)		throws SignDocException

Get the value of a SignDoc property (boolean).

In the "public" and "encrypted" collections, property names are compared under Unicode simple case folding, that is, lower case and upper case is not distinguished.

Parameters:

[in]	aCollection	The name of the collection, see getProperties().
[in]	aName	The name of the property.

Returns:: The value of the property.

See also:: getProperties()

synchronized double de.softpro.doc.SignDocDocument.getConversionFactorX ( int aPage ) throws SignDocException

Get the horizontal conversion factor for a page.

Different pages of the document may have different conversion factors. For TIFF documents, this function returns the same value as getResolutionX().

Parameters:

[in] aPage The page number (1 for the first page).

Returns:: Divide horizontal coordinates by the returned number to convert document coordinates to inches. The return value will be 0.0 if the factor is not available.

See also:: getConversionFactorY(), getResolutionX()

synchronized double de.softpro.doc.SignDocDocument.getConversionFactorY ( int aPage ) throws SignDocException

Get the vertical conversion factor for a page.

Different pages of the document may have different conversion factors. For TIFF documents, this function returns the same value as getResolutionX().

Parameters:

[in] aPage The page number (1 for the first page).

Returns:: Divide vertical coordinates by the returned number to convert document coordinates to inches. The return value will be 0.0 if the factor is not available.

See also:: getConversionFactorX(), getResolutionY()

synchronized int de.softpro.doc.SignDocDocument.getDocMDP ( ) throws SignDocException

Get the DocMDP P value of the document's certification signature.

The DocMDP P value of the certification signature specifies what modifications to the document are allowed.

This function does not verify the certification signature.

Returns:: -1 if there is no certification signature, 1 if no modifications are allowed, 2 if only filling in forms, instantiating page templates, and signing are permitted, 3 if only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations are permitted. For TIFF documents, this function always returns -1.

See also:: getLockMDP()

synchronized String de.softpro.doc.SignDocDocument.getDocumentLanguage ( ) throws SignDocException

Get the document's natural language.

That language applies to all text unless overridden locally.

Returns:: The natural language of the document as RFC 3066 language tag. Example: "en-US". If the document does not specify a natural language, an empty string will be returned.

See also:: setDocumentLanguage(), f_require_alternate_field_name, f_require_lang

synchronized SignDocField de.softpro.doc.SignDocDocument.getField ( String aName ) throws SignDocException

Get an interactive field by name.

There is a setFlags() flag modifying the behavior of this function: f_ambiguous_button_value_empty.

Parameters:

[in] aName The fully-qualified name of the field.

Returns:: The selected field.

See also:: getFields(), setField()

synchronized SignDocField [] de.softpro.doc.SignDocDocument.getFields ( int aTypes ) throws SignDocException

Get all interactive fields of the specified types.

There is a setFlags() flag modifying the behavior of this function: f_ambiguous_button_value_empty.

Parameters:

[in] aTypes 0 to get fields of all types. Otherwise, a bitset selecting the field types to be included. To include a field of type t, add 1<<t, where t is de.softpro.doc.SignDocField.t_text, etc.

Returns:: An array containing the selected fields in the order in which they have been defined.

See also:: exportFields(), getField(), getFieldsOfPage()

synchronized SignDocField [] de.softpro.doc.SignDocDocument.getFieldsOfPage	(	int	aPage,
		int	aTypes
	)		throws SignDocException

Get all interactive fields of the specified page, in tab order.

If the document does not specify a tab order, the fields will be returned in widget order.

There is a setFlags() flag modifying the behavior of this function: f_ambiguous_button_value_empty.

Note:: Structure order (S) is not yet supported. If the page specifies structure order, the fields will be returned in widget order.

Parameters:

[in]	aPage	The 1-based page number.
[in]	aTypes	0 to get fields of all types. Otherwise, a bitset selecting the field types to be included. To include a field of type t, add 1<<t, where t is de.softpro.doc.SignDocField.t_text, etc.

Returns:: An array containing the selected fields in tab order. There will be one element per widget (rather than per field); use SignDocField.getWidget() to find out which widget of the field is referenced.

See also:: exportFields(), getField(), getFields()

synchronized int de.softpro.doc.SignDocDocument.getFlags ( ) throws SignDocException

Get the flags set by setFlags().

Returns:: The flags currently in force.

See also:: setFlags()

synchronized int de.softpro.doc.SignDocDocument.getIntegerProperty	(	String	aCollection,
		String	aName
	)		throws SignDocException

Get the value of a SignDoc property (integer).

In the "public" and "encrypted" collections, property names are compared under Unicode simple case folding, that is, lower case and upper case is not distinguished.

Parameters:

[in]	aCollection	The name of the collection, see getProperties().
[in]	aName	The name of the property.

Returns:: The value of the property.

See also:: getProperties()

synchronized String de.softpro.doc.SignDocDocument.getLastTimestamp ( ) throws SignDocException

Get the timestamp used by the last successful call of addSignature().

This function may return a timestamp even if the last call of addSignature() was not successful. See also string parameters "Timestamp" and "TimeStampServerURL" of SignDocSignatureParameters.

Returns:: The timestamp in ISO 8601 format (yyyy-mm-ddThh:mm:ss) without milliseconds, with optional timezone (or an empty string if there is no timestamp available).

See also:: addSignature(), getSignatureString(), SignDocSignatureParameters.setString()

synchronized int de.softpro.doc.SignDocDocument.getLockMDP ( ) throws SignDocException

Get the lowest lock MDP value of the signed signature fields.

The lock MDP value specifies what modifications to the document are allowed.

This function does not verify any signature.

Returns:: -1 if there is no signature field with lock MDP value, 1 if no modifications are allowed, 2 if only filling in forms, instantiating page templates, and signing are permitted, 3 if only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations are permitted. For TIFF documents, this function always returns -1.

See also:: getDocMDP()

synchronized int de.softpro.doc.SignDocDocument.getPageCount ( ) throws SignDocException

Get the number of pages of the document.

Returns:: The number of pages.

See also:: getPageLabel()

synchronized double de.softpro.doc.SignDocDocument.getPageHeight ( int aPage ) throws SignDocException

Get the height of a page.

Different pages of the document may have different sizes. Use getConversionFactorY() to get factors for converting the page height from document coordinates to real world dimensions.

Parameters:

[in] aPage The page number (1 for the first page).

Returns:: The page height in document coordinates.

See also:: getConversionFactorY()

synchronized String de.softpro.doc.SignDocDocument.getPageLabel ( int aPage ) throws SignDocException

Get the page label for a page number.

For TIFF documents, aPage will be converted to a decimal number.

Parameters:

[in] aPage The page number (1 for the first page).

Returns:: The page label.

See also:: getPageCount()

synchronized double de.softpro.doc.SignDocDocument.getPageWidth ( int aPage ) throws SignDocException

Get the width of a page.

Different pages of the document may have different sizes. Use getConversionFactorX() to get factors for converting the page width from document coordinates to real world dimensions.

Parameters:

[in] aPage The page number (1 for the first page).

Returns:: The page width in document coordinates.

See also:: getConversionFactorX()

synchronized String de.softpro.doc.SignDocDocument.getPathname ( ) throws SignDocException

Get the current pathname of the document.

The pathname will be empty if the document is stored in memory (ie, if it has been loaded from memory or saved to a stream).

If a FDF document has been opened, this function will return the pathname of the referenced PDF file.

Returns:: The pathname or "".

synchronized String [] de.softpro.doc.SignDocDocument.getProfiles ( String aFieldName ) throws SignDocException

Get a list of profiles for a signature field.

Parameters:

[in] aFieldName The name of the signature field.

Returns:: An array containign the names of all profiles supported by the signature field, excluding the default profile "" which is always available.

See also:: createSignatureParameters()

synchronized SignDocProperty [] de.softpro.doc.SignDocDocument.getProperties ( String aCollection ) throws SignDocException

Get the names and types of all SignDoc properties of a certain collection of properties of the document.

Use getBooleanProperty(), getIntegerProperty(), or getStringProperty() to get the values of the properties.

There are two collections of SignDoc document properties:

"encrypted" Encrypted properties. Names and values are symmetrically encrypted.
"public" Public properties. Document viewer applications may be able to display or let the user modify these properties.
"pdfa" PDF/A properties (PDF documents only):
- part (PDF/A version identifier: 1, 2, or 3)
- amd (optional PDF/A amendment identifier)
- conformance (PDF/A conformance level: A, B, or U)
All properties in this collection have string values, the property names are case-sensitive. If the "part" property is present, the document claims to be conforming to PDF/A. Your application may change its behavior when dealing with PDF/A documents. For instance, it might want to avoid transparency.
"pdfua" PDF/UA properties (PDF documents only):
- part (PDF/UA version identifier: 1)
- amd (optional PDF/UA amendment identifier)
- corr (optional PDF/UA corrigenda identifier)
All properties in this collection have string values, the property names are case-sensitive. If the "part" property is present, the document claims to be conforming to PDF/UA. Your application may change its behavior when dealing with PDF/UA documents.

Using the same property name in the "encrypted" and "public" collections is not possible. Attempts to get, set, or remove a property in the wrong collection will fail with error code rc_wrong_collection. To move a property from one collection to another collection, first remove it from the source collection, then add it to the target collection.

The "pdfa" and "pdfua" collections are read-only and a property name existing in those collections does not prevent that property name from appearing in one of the other collections.

The syntax of property names depends on the document type and the collection containing the property.

"public" properties of PDF documents are stored according to XMP in namespace "http://www.softpro.de/pdfa/signdoc/public/", therefore property names must be valid unqualified XML names, see the syntax of "Name" in the XML 1.1 specification at http://www.w3.org/TR/2004/REC-xml11-20040204/#sec-common-syn (section 2.3 Common Syntactic Constructs).

For "encrypted" properties and any properties in TIFF documents, property names can contain arbitrary Unicode characters except for NUL.

Parameters:

[in] aCollection The name of the collection, see above.

Returns:: The properties.

synchronized void de.softpro.doc.SignDocDocument.getRenderedSize	(	SignDocRenderOutput	aOutput,
		SignDocRenderParameters	aParams
	)		throws SignDocException

Get the size of the rendered page in pixels (without actually rendering it).

The returned values may be approximations for some document formats. If multiple pages are selected (see de.softpro.doc.SignDocRenderParameters.setPages()), the maximum width and maximum height of all selected pages will be used.

Parameters:

[out]	aOutput	The width and height of the image that would be computed by renderPageAsImage() with aClipRect being null will be stored here.
[in]	aParams	Parameters such as the page number.

See also:: renderPageAsImage()

synchronized int de.softpro.doc.SignDocDocument.getRequiredSaveToFileFlags ( ) throws SignDocException

Get all flags currently required for saveToFile().

This function currently returns sf_incremental (saving the document non-incrementally would destroy existing signatures) or 0 (the document may be saved non-incrementally).

Returns:: The flags.

See also:: getSaveToFileFlags(), saveToFile()

synchronized double de.softpro.doc.SignDocDocument.getResolutionX ( int aPage ) throws SignDocException

Get the horizontal resolution of a page.

Different pages of the document may have different resolutions. Use getConversionFactorX() to get the factor for converting document coordinates to real world coordinates.

Parameters:

[in] aPage The page number (1 for the first page).

Returns:: The horizontal resolution in DPI. The value will be 0.0 if the resolution is not available.

See also:: getConversionFactorX(), getResolutionY()

synchronized double de.softpro.doc.SignDocDocument.getResolutionY ( int aPage ) throws SignDocException

Get the vertical resolution of a page.

Different pages of the document may have different resolutions. Use getConversionFactorY() to get the factor for converting document coordinates to real world coordinates.

Parameters:

[in] aPage The page number (1 for the first page).

Returns:: The vertical resolution in DPI. The value will be 0.0 if the resolution is not available.

See also:: getConversionFactorY(), getResolutionX()

synchronized int de.softpro.doc.SignDocDocument.getSaveToFileFlags ( ) throws SignDocException

Get all flags currently valid for saveToFile().

Note that sf_incremental cannot be used together with sf_linearized even if all these flags are returned by this function. sf_pdfa_buttons is returned only if the document claims PDF/A-1 conformance.

Returns:: The flags.

See also:: getRequiredSaveToFileFlags(), getSaveToStreamFlags(), saveToFile(), sf_auto_incremental

synchronized int de.softpro.doc.SignDocDocument.getSaveToStreamFlags ( ) throws SignDocException

Get all flags currently valid for saveToStream().

sf_pdfa_buttons is returned only if the document claims PDF/A-1 conformance.

Returns:: The flags.

See also:: getSaveToFileFlags(), saveToStream()

synchronized int de.softpro.doc.SignDocDocument.getShootInFoot ( ) throws SignDocException

Get the flags set by setShootInFoot().

Returns:: The flags currently in force.

See also:: setShootInFoot()

synchronized SignDocSignature de.softpro.doc.SignDocDocument.getSignature ( int aIndex ) throws SignDocException

Get a signature of the document.

By passing values for aIndex from 0 up to getSignatureCount()-1, the history of changes to the document can be obtained. Exception: If clearSignature() has been called for a TIFF document, the order of signatures is indeterminate.

Parameters:

[in] aIndex The index of the signature, 0 for the first signature applied to the document, getSignatureCount()-1 for the newest signature.

Returns:: A new SignDocSignature object.

See also:: getSignatureCount(), verifySignature(), verifySignature2()

synchronized int de.softpro.doc.SignDocDocument.getSignatureCount ( ) throws SignDocException

Get the number of signatures that can be retrieved with getSignature().

Returns:: The number of signatures, possibly including removed signatures.

See also:: getSignature()

synchronized String de.softpro.doc.SignDocDocument.getStringProperty	(	String	aCollection,
		String	aName
	)		throws SignDocException

Get the value of a SignDoc property (string).

In the "public" and "encrypted" collections, property names are compared under Unicode simple case folding, that is, lower case and upper case is not distinguished.

Parameters:

[in]	aCollection	The name of the collection, see getProperties().
[in]	aName	The name of the property.

Returns:: The value of the property.

See also:: getProperties()

synchronized SignDocTextFieldAttributes de.softpro.doc.SignDocDocument.getTextFieldAttributes ( ) throws SignDocException

Get the document's default text field attributes.

Returns:: A SignDocTextFieldAttributes object.

See also:: getField(), setTextFieldAttributes(), SignDocField.getTextFieldAttributes()

synchronized int de.softpro.doc.SignDocDocument.getType ( ) throws SignDocException

Get the type of the document.

Returns:: The document type.

See also:: dt_unknown, dt_pdf, dt_tiff, dt_other, dt_fdf

synchronized void de.softpro.doc.SignDocDocument.importPageFromImageBlob	(	int	aTargetPage,
		byte[]	aData,
		double	aZoom,
		double	aWidth,
		double	aHeight,
		int	aFlags
	)		throws SignDocException

Import a page from a blob containing an image.

This function behaves like importPageFromImageBlob2() with an empty string for aDescription, that is, if the document uses Tagged PDF, a dummy alternate description for the image ("image" with language code "en") will provided to avoid breaking standard compliance. It is strongly recommended to use importPageFromImageBlob2() with a meaningful description of the image.

This function is currently implemented for PDF documents only.

Parameters:

[in]	aTargetPage	The 1-based number of the page before which to insert the new page. The page will be appended if this value is 0.
[in]	aData	The blob containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP.
[in]	aZoom	Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom.
[in]	aWidth	Page width (document coordinates) or zero. If this argument is non-zero, aHeight must also be non-zero and aZoom must be zero. The image will be scaled to this width.
[in]	aHeight	Page height (document coordinates) or zero. If this argument is non-zero, aWidth must also be non-zero and aZoom must be zero. The image will be scaled to this height.
[in]	aFlags	Flags modifying the behavior of this function, See ii_keep_aspect_ratio. ii_keep_aspect_ratio is not needed if aZoom is non-zero.

See also:: addImageFromBlob(), addImageFromBlob2(), importPageFromImageBlob2(), importPageFromImageFile(), importPageFromImageFile2(), isTaggedPDF(), f_fail_for_broken_target_structure

Todo:: multi-page TIFF

synchronized void de.softpro.doc.SignDocDocument.importPageFromImageBlob2	(	int	aTargetPage,
		byte[]	aData,
		double	aZoom,
		double	aWidth,
		double	aHeight,
		int	aFlags,
		String	aDescription,
		String	aLang
	)		throws SignDocException

Import a page from a blob containing an image (with alternate description).

This function is currently implemented for PDF documents only.

Parameters:

[in]	aTargetPage	The 1-based number of the page before which to insert the new page. The page will be appended if this value is 0.
[in]	aData	The blob containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP.
[in]	aZoom	Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom.
[in]	aWidth	Page width (document coordinates) or zero. If this argument is non-zero, aHeight must also be non-zero and aZoom must be zero. The image will be scaled to this width.
[in]	aHeight	Page height (document coordinates) or zero. If this argument is non-zero, aWidth must also be non-zero and aZoom must be zero. The image will be scaled to this height.
[in]	aFlags	Flags modifying the behavior of this function, See ii_keep_aspect_ratio. ii_keep_aspect_ratio is not needed if aZoom is non-zero.
[in]	aDescription	Alternate description for the image. If this value is null or an empty string, aLang will be ignored. If this value is null or an empty string and the document uses Tagged PDF, "image" with language code "en" will be used to avoid breaking standard compliance. It is strongly recommended to use a meaningful description. Escape sequences must not be used.
[in]	aLang	Language identifier for aDescription. Unless aDescription is an empty string, this must be a string containing an RFC 3066 language tag. Example: "en-US".

See also:: addImageFromBlob(), addImageFromBlob2(), importPageFromImageBlob(), importPageFromImageFile(), importPageFromImageFile2(), isTaggedPDF(), f_fail_for_broken_target_structure

Todo:: multi-page TIFF

synchronized void de.softpro.doc.SignDocDocument.importPageFromImageFile	(	int	aTargetPage,
		String	aPath,
		double	aZoom,
		double	aWidth,
		double	aHeight,
		int	aFlags
	)		throws SignDocException

Import a page from a file containing an image.

This function behaves like importPageFromImageFile2() with an empty string for aDescription, that is, if the document uses Tagged PDF, a dummy alternate description for the image ("image" with language code "en") will provided to avoid breaking standard compliance. It is strongly recommended to use importPageFromImageFile2() with a meaningful description of the image.

This function is currently implemented for PDF documents only.

Parameters:

[in]	aTargetPage	The 1-based number of the page before which to insert the new page. The page will be appended if this value is 0.
[in]	aPath	The pathname of the file containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP.
[in]	aZoom	Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom.
[in]	aWidth	Page width (document coordinates) or zero. If this argument is non-zero, aHeight must also be non-zero and aZoom must be zero. The image will be scaled to this width.
[in]	aHeight	Page height (document coordinates) or zero. If this argument is non-zero, aWidth must also be non-zero and aZoom must be zero. The image will be scaled to this height.
[in]	aFlags	Flags modifying the behavior of this function, See ii_keep_aspect_ratio. ii_keep_aspect_ratio is not needed if aZoom is non-zero.

See also:: importPageFromImageBlob(), importPageFromImageBlob2(), importPageFromImageFile2(), isTaggedPDF(), f_fail_for_broken_target_structure

Todo:: multi-page TIFF

synchronized void de.softpro.doc.SignDocDocument.importPageFromImageFile2	(	int	aTargetPage,
		String	aPath,
		double	aZoom,
		double	aWidth,
		double	aHeight,
		int	aFlags,
		String	aDescription,
		String	aLang
	)		throws SignDocException

Import a page from a file containing an image (with alternate description).

This function is currently implemented for PDF documents only.

Parameters:

[in]	aTargetPage	The 1-based number of the page before which to insert the new page. The page will be appended if this value is 0.
[in]	aPath	The pathname of the file containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP.
[in]	aZoom	Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom.
[in]	aWidth	Page width (document coordinates) or zero. If this argument is non-zero, aHeight must also be non-zero and aZoom must be zero. The image will be scaled to this width.
[in]	aHeight	Page height (document coordinates) or zero. If this argument is non-zero, aWidth must also be non-zero and aZoom must be zero. The image will be scaled to this height.
[in]	aFlags	Flags modifying the behavior of this function, See ii_keep_aspect_ratio. ii_keep_aspect_ratio is not needed if aZoom is non-zero.
[in]	aDescription	Alternate description for the image. If this value is null or an empty string, aLang will be ignored. If this value is null or an empty string and the document uses Tagged PDF, "image" with language code "en" will be used to avoid breaking standard compliance. It is strongly recommended to use a meaningful description. Escape sequences must not be used.
[in]	aLang	Language identifier for aDescription. Unless aDescription is an empty string, this must be a string containing an RFC 3066 language tag. Example: "en-US".

See also:: importPageFromImageBlob(), importPageFromImageBlob2(), importPageFromImageFile(), isTaggedPDF(), f_fail_for_broken_target_structure

Todo:: multi-page TIFF

synchronized void de.softpro.doc.SignDocDocument.importPages	(	int	aTargetPage,
		SignDocDocument	aSource,
		int	aSourcePage,
		int	aPageCount,
		int	aFlags
	)		throws SignDocException

Import pages from another document.

This function is currently implemented for PDF documents only. The pages to be imported must not contain any interactive fields having names that are already used for intercative fields in the target document.

Page labels are currently ignored, that is, they will probably be messed up in the target document.

If flag f_prevent_breaking_tagged_pdf is set, this function may fail for some values of aTargetPage as the target structure may not be suitable for insertion of pages between certain pages. Appending pages after the last page should always work.

Parameters:

[in]	aTargetPage	The 1-based number of the page before which to insert the copied pages. The pages will be appended if this value is 0.
[in]	aSource	The document from which to copy the pages. aSource can be this.
[in]	aSourcePage	The 1-based number of the first page (in the source document) to be copied.
[in]	aPageCount	The number of pages to be copied. All pages of aSource starting with aSourcePage will be copied if this value is 0.
[in]	aFlags	Must be zero.

See also:: isTaggedPDF(), setFlags(), f_fail_for_broken_target_structure, f_prevent_breaking_tagged_pdf

synchronized void de.softpro.doc.SignDocDocument.importProperties	(	String	aCollection,
		java.io.InputStream	aStream,
		int	aFlags
	)		throws SignDocException

Import properties from XML.

The input must conform to schema AllSignDocProperties.xsd (if aCollection is empty) or SignDocProperties.xsd (if aCollection is non-empty).

Parameters:

[in]	aCollection	The name of the collection, see getProperties(). If the string is empty, properties will be imported into all collections, otherwise properties will be imported into the specified collection.
[in]	aStream	The properties will be read from this stream. This function reads the input completely, it doesn't stop at the end tag.
[in]	aFlags	Flags modifying the behavior of this function, See i_atomic.

See also:: exportProperties()

synchronized boolean de.softpro.doc.SignDocDocument.isModified ( ) throws SignDocException

Check if the document has unsaved changes.

Returns:: true if the document has unsaved changes, false if the document does not have unsaved changes.

synchronized boolean de.softpro.doc.SignDocDocument.isTaggedPDF ( ) throws SignDocException

Check if the document is a Tagged PDF document.

Returns:: true if the document is a Tagged PDF document, false if the document is not a Tagged PDF document.; true if the document has unsaved changes, false if the document does not have unsaved changes.

synchronized void de.softpro.doc.SignDocDocument.removeAnnotation	(	int	aPage,
		String	aName
	)		throws SignDocException

Remove an annotation identified by name.

Parameters:

[in]	aPage	The page number (1 for the first page).
[in]	aName	The name of the annotation, must not be empty.

See also:: addAnnotation(), flattenAnnotations(), getAnnotations(), SignDocAnnotation.setName()

synchronized void de.softpro.doc.SignDocDocument.removeAttachment ( String aName ) throws SignDocException

Remove an attachment from the document.

Attachments are supported for PDF documents only.

Parameters:

[in] aName The name of the attachment.

See also:: addAttachmentBlob(), addAttachmentFile(), getAttachments()

synchronized void de.softpro.doc.SignDocDocument.removeDocMDP ( ) throws SignDocException

Remove any certification signature.

This function does nothing for TIFF documents as TIFF documents do not have certification signatures.

See also:: clearAllSignatures(), getDocMDP(), removePDFA(), removePDFUA(), removePermissions(), setShootInFoot()

synchronized void de.softpro.doc.SignDocDocument.removeField ( String aName ) throws SignDocException

Remove a field.

Removing a field of a TIFF document will invalidate all signatures.

Parameters:

[in] aName The fully-qualified name of the field.

See also:: addField(), flattenField(), getFields()

synchronized void de.softpro.doc.SignDocDocument.removeLogicalStructure ( int aFlags ) throws SignDocException

Remove the logical structure.

This function is available for PDF documents only.

Parameters:

[in] aFlags Must be 0.

synchronized void de.softpro.doc.SignDocDocument.removePages	(	int[]	aPages,
		int	aMode
	)		throws SignDocException

Remove pages from the document.

A document must have at least page. This function will fail if you attempt to remove all pages.

Fields will be removed if all their widgets are on removed pages.

Only signatures in signature fields having the SignDocField.f_SinglePage flag set can survive removal of pages.

Parameters:

[in]	aPages	One-based page numbers of pages to be removed. The order does not matter, neither does the number of occurences of a page number.
[in]	aMode	Tell this function whether to keep (kor_keep) or to remove (kor_remove) the pages specified by aPages.

synchronized void de.softpro.doc.SignDocDocument.removePDFA ( int aFlags ) throws SignDocException

Remove PDF/A conformance.

Some operations on PDF documents (such as using standard fonts) are not allowed in PDF/A documents. This function turns a PDF/A document into a plain document, enabling those operations.

This function is available for PDF documents only.

Parameters:

[in] aFlags Must be 0.

See also:: removeDocMDP(), removePDFUA(), removePermissions()

synchronized void de.softpro.doc.SignDocDocument.removePDFUA ( int aFlags ) throws SignDocException

Remove PDF/UA conformance.

Some operations on PDF documents (such as using standard fonts) are not allowed in PDF/UA documents. This function turns a PDF/UA document into a plain document, enabling those operations.

This function is available for PDF documents only.

Parameters:

[in] aFlags Must be 0.

See also:: removeDocMDP(), removePDFA(), removePermissions()

synchronized void de.softpro.doc.SignDocDocument.removePermissions ( int aFlags ) throws SignDocException

Remove signatures that grant permissions.

If you want to modify (beyond adding signature fields, signing signature fields, and filling in form fields) a PDF document that has permissions granted to Adobe Reader by digital signatures, you have to remove those signatures first by calling this function. That action will remove the permissions for Adobe Reader but enable modifying the document without breaking those signatures.

Permissions granted via encryption are not altered by this function.

This function is available for PDF documents only.

Parameters:

[in] aFlags Must be 0.

See also:: removePDFA(), removePDFUA(), setShootInFoot()

synchronized void de.softpro.doc.SignDocDocument.removeProperty	(	String	aCollection,
		String	aName
	)		throws SignDocException

Remove a SignDoc property.

In the "public" and "encrypted" collections, property names are compared under Unicode simple case folding, that is, lower case and upper case is not distinguished.

Parameters:

[in]	aCollection	The name of the collection, see getProperties().
[in]	aName	The name of the property.

See also:: getProperties(), setBooleanProperty(), setIntegerProperty(), setStringProperty()

synchronized void de.softpro.doc.SignDocDocument.removeXFA ( int aFlags ) throws SignDocException

Remove XFA (XML Forms Architecture) content.

SignDoc SDK does not support XFA (XML Forms Architecture) and therefore addSignature(), addField(), applyFdf(), and setField() remove XFA from the document to avoid descrepancies between "classic" form fields and XFA. This function is available for PDF documents only.

You can also remove XFA content by calling this function. It will fail if the document prohibits removal of XFA (removing XFA from signed documents breaks signatures).

This function is available for PDF documents only.

Parameters:

[in] aFlags Must be 0.

synchronized byte [] de.softpro.doc.SignDocDocument.renderPageAsImage	(	SignDocRenderOutput	aOutput,
		SignDocRenderParameters	aRenderParameters,
		SignDocVerificationParameters	aVerificationParameters,
		Rect	aClipRect
	)		throws SignDocException

Render the selected page (or pages) as image.

Parameters:

[out]	aOutput	The image size will be stored here.
[in]	aRenderParameters	Parameters such as the page number.
[in]	aVerificationParameters	Parameters for verification of signatures. Used only if setDecorations(true) has been called for aRenderParameters. Currently, signatures are verified one after another and the "Timeout" integer parameter applies to each verification. Pass null for default parameters.
[in]	aClipRect	The rectangle to be rendered (using document coordinates, see Coordinate Systems) or null to render the complete page.

Returns:: The image as blob.

See also:: computeZoom(), getRenderedSize()

synchronized void de.softpro.doc.SignDocDocument.saveToFile	(	String	aPath,
		int	aFlags
	)		throws SignDocException

Save the document to a file.

After a successful call to this function, the document behaves as if it had been loaded from the specified file.

Saving a signed PDF document without sf_incremental will fail unless sf_auto_incremental is also set. See also getRequiredSaveToFileFlags().

Parameters:

[in]	aPath	The pathname of the file to be created or overwritten. Pass null to save to the file from which the document was loaded or most recently saved (which will fail if the documment was loaded from memory or saved to a stream).
[in]	aFlags	Set of flags (sf_incremental, sf_linearized, sf_pdf_1_4, sf_pdfa_buttons, sf_remove_unused, and sf_auto_incremental, combined with `\|') modifying the behavior of this function. Pass 0 for no flags. Which flags are available depends on the document type. Which flags are required depends on the document state. Call getRequiredSaveToFileFlags() to get the flags that are required.

See also:: copyToStream(), getRequiredSaveToFileFlags(), getSaveToFileFlags(), saveToStream(), sf_auto_incremental, sf_incremental, sf_linearized, sf_pdf_1_4, sf_pdfa_buttons, sf_remove_unused, SignDocDocumentLoader.loadFromFile(), SignDocDocumentLoader.loadFromMemory()

synchronized void de.softpro.doc.SignDocDocument.saveToStream	(	java.io.OutputStream	aStream,
		int	aFlags
	)		throws SignDocException

Save the document to a stream.

This function may have side effects on the document such as marking it as not modified which may render sf_incremental useless for the next saveToFile() call unless the document is changed between those two calls.

Parameters:

[in]	aStream	The document will be saved to this stream.
[in]	aFlags	Set of flags (sf_incremental, sf_linearized, sf_pdf_1_4, sf_pdfa_buttons, sf_remove_unused, and sf_auto_incremental, combined with `\|') modifying the behavior of this function. Pass 0 for no flags. Which flags are available depends on the document type.

See also:: copyToStream(), getSaveToStreamFlags(), saveToFile(), sf_auto_incremental, sf_incremental, sf_linearized, sf_remove_unused, sf_pdf_1_4, sf_pdfa_buttons, SignDocDocumentLoader.loadFromFile(), SignDocDocumentLoader.loadFromMemory()

synchronized void de.softpro.doc.SignDocDocument.setBooleanProperty	(	String	aCollection,
		String	aName,
		boolean	aValue
	)		throws SignDocException

Set the value of a SignDoc property (boolean).

In the "public" and "encrypted" collections, property names are compared under Unicode simple case folding, that is, lower case and upper case is not distinguished.

It's not possible to change the type of a property.

Parameters:

[in]	aCollection	The name of the collection, see getProperties().
[in]	aName	The name of the property.
[in]	aValue	The new value of the property.

See also:: getProperties(), removeProperty(), addSignature()

synchronized void de.softpro.doc.SignDocDocument.setCompatibility	(	int	aMajor,
		int	aMinor
	)		throws SignDocException

Request to not make changes to the document which are incompatible with an older version of this class.

No features introduced after aMajor.aMinor will be used.

Passing a version number before 1.11 or after the current version will fail.

Parameters:

[in]	aMajor	Major version number.
[in]	aMinor	Minor version number.

synchronized void de.softpro.doc.SignDocDocument.setCompressionLevel ( int aLevel ) throws SignDocException

Set the FlateDecode compression level.

Calling this function has an effect for PDF documents only. You might want to use a low compression level on slow machines such as mobile devices. That will speed up operations such as embedding fonts, adding attachments, and adding images.

Parameters:

[in] aLevel The new compression level for encoding data with the FlateDecode filter. Allowed values are 0 (fastest, do not use FlateDecode), and 0 (fast, least compression) through 9 (slowest, best compression). The default value is 6.

synchronized void de.softpro.doc.SignDocDocument.setDefaultDocumentLanguage ( String aLang ) throws SignDocException

Set the language identifier to be used if a language identifier is required but the document doesn't provide one.

If this function is not called, "en" will be used.

This function is available for PDF documents only.

Parameters:

[in] aLang An RFC 3066 language tag. Must not be an empty string. Example: "en-US".

See also:: getDocumentLanguage(), setDocumentLanguage(), f_require_alternate_field_name, f_require_lang

synchronized void de.softpro.doc.SignDocDocument.setDocumentLanguage ( String aLang ) throws SignDocException

Set the document's natural language.

That language applies to all text unless overridden locally.

This function is available for PDF documents only.

Parameters:

[in] aLang The natural language for the document (an RFC 3066 language tag). Must be neither null nor an empty string. Example: "en-US".

See also:: getDocumentLanguage(), f_require_alternate_field_name, f_require_lang

synchronized void de.softpro.doc.SignDocDocument.setField	(	SignDocField	aField,
		int	aFlags
	)		throws SignDocException

Change a field.

This function changes a field in the document using attributes from a SignDocField object. Everything except for the name and the type of the field can be changed. See the member functions of SignDocField for details.

Always get a SignDocField object for a field by calling getField(), getFields(), or getFields(), then apply your modifications to that object, then call setField().

Applications should not call setField() for fields that are locked, ie, have SignDocField.f_ReadOnly set in the return value of SignDocField.getFlags(). However, setField() does not fail in that case.

The coordinates of the field are not changed unless sff_move is set in aFlags.

Do not try to build a SignDocField object from scratch for changing a field as future versions of the SignDocField class may have additional attributes.

This function is implemented for PDF documents only.

This function always fails for PDF documents that have signed signature fields.

Parameters:

[in,out]	aField	The field to be changed. The font resource name of the default text field attributes may be modified. The value index and the value may be modified for radio button fields and check box fields.
[in]	aFlags	Set of flags (sff_move, sff_keep_ap, sff_update_ap, sff_fit_height_only, sff_force_border_width, sff_dont_break_lines, sff_auto_alignment, sff_ltr, sff_rtr, sff_default_ltr, and sff_default_rtl) combined with `\|' modifying the behavior of this function. Pass 0 for no flags.

See also:: addField(), getFields(), removeField(), f_fail_for_broken_target_structure, f_require_alternate_field_name

synchronized void de.softpro.doc.SignDocDocument.setFlags ( int aFlags ) throws SignDocException

Set flags modifying the behavior of various functions.

The default is value is 0.

Parameters:

[in] aFlags New set of flags, see f_relax_byte_range, f_ambiguous_button_value_empty, f_use_dss_only, f_no_kerning_for_standard_fonts, f_prevent_breaking_tagged_pdf, and f_keep_escape_sequences.

See also:: getFlags(), setShootInFoot()

synchronized void de.softpro.doc.SignDocDocument.setIntegerProperty	(	String	aCollection,
		String	aName,
		int	aValue
	)		throws SignDocException

Set the value of a SignDoc property (integer).

In the "public" and "encrypted" collections, property names are compared under Unicode simple case folding, that is, lower case and upper case is not distinguished.

It's not possible to change the type of a property.

Parameters:

[in]	aCollection	The name of the collection, see getProperties().
[in]	aName	The name of the property.
[in]	aValue	The new value of the property.

See also:: getProperties(), removeProperty(), addSignature()

synchronized void de.softpro.doc.SignDocDocument.setShootInFoot ( int aFlags ) throws SignDocException

Disable safety checks.

The default value, 0, makes operations fail which would invalidate existing signatures (signature fields) or signatures granting permissions.

Note:: If you set any flags you risk shooting yourself in the foot.

Parameters:

[in] aFlags A set of flags, see siff_allow_breaking_signatures, siff_allow_breaking_permissions, siff_allow_invalid_certificate, siff_allow_non_standard_external_fonts, siff_assume_ap_not_shared, siff_assume_ap_shared, siff_dont_verify_after_signing, and siff_allow_all_curves.

See also:: getShootInFoot(), removeDocMDP(), removePermissions(), setFlags(), SignDocField.getDocMDP()

synchronized void de.softpro.doc.SignDocDocument.setStringProperty	(	String	aCollection,
		String	aName,
		String	aValue
	)		throws SignDocException

Set the value of a SignDoc property (string).

In the "public" and "encrypted" collections, property names are compared under Unicode simple case folding, that is, lower case and upper case is not distinguished.

It's not possible to change the type of a property.

Parameters:

[in]	aCollection	The name of the collection, see getProperties().
[in]	aName	The name of the property.
[in]	aValue	The new value of the property.

See also:: getProperties(), removeProperty(), addSignature()

synchronized void de.softpro.doc.SignDocDocument.setTextFieldAttributes ( SignDocTextFieldAttributes aData ) throws SignDocException

Set the document's default text field attributes.

Font name, font size, and text color must be specified. This function fails if aInput has any but not all attributes set or if any of the attributes are invalid.

This function fails for signed PDF document.

This function always fails for TIFF documents.

Parameters:

[in,out] aData The new default text field attributes. The font resource name will be updated.

See also:: getTextFieldAttributes(), SignDocField.setTextFieldAttributes()

static String [] de.softpro.doc.SignDocDocument.splitEscapeSequences ( String aInput ) [static]

Split a string obtained from a PDF text string into escape sequences and text segments.

You don't need to call this function unless flag f_keep_escape_sequences is set.

Parameters:

[in] aInput The input string.

Returns:: An array of escape sequences and text segments. The escape characters are not removed from escape sequences.

See also:: withoutEscapeSequences()

synchronized int de.softpro.doc.SignDocDocument.updateDSS	(	SignDocVerificationParameters	aParameters,
		int	aFlags
	)		throws SignDocException

Update the DSS for any eligible signatures of the document.

This function is available for PDF documents only.

To extend the validity of the signatures in a PDF document (long term validity LTV), call this function, save the document incrementally, and add a document time stamp.

If the document already has a document time stamp, this function adds information for the latest document time stamp to the DSS. If the document does not have a document time stamp, this function adds information for all eligible signature fields to the DSS.

This function fails if verification fails for any of the signatures.

Parameters:

[in]	aParameters	Verification parameters or null for default parameters.
[in]	aFlags	Flags modifying the behavior of this function, see udf_simulate and udf_vri.

Returns:: If udf_simulate is not set in aFlags, the number of signature fields for which information has been added to the DSS will be returned. If udf_simulate is set in aFlags, the number of eligible signature fields will be returned.

See also:: updateDSS2()

synchronized void de.softpro.doc.SignDocDocument.updateDSS2	(	String	aFieldName,
		SignDocVerificationParameters	aParameters,
		int	aFlags
	)		throws SignDocException

Update the DSS for a signature of the document.

The main purpose of this function is testing SignDoc SDK, please use updateDSS() instead.

This function is available for PDF documents only.

Call this function (possibly a long time) after signing field aFieldName, then save the document incrementally and add a document time stamp. Before applying the first document time stamp, this function should be called for all eligable signature fields. If any document time stamp has already been added, this function should be called for the last document time stamp.

The signature field must have been signed with one of these methods: SignDocSignatureParameters.m_digsig_pkcs7_detached, SignDocSignatureParameters.m_digsig_pkcs7_sha1, SignDocSignatureParameters.m_digsig_cades_detached, or SignDocSignatureParameters.m_digsig_cades_rfc3161.

This function does nothing if the signature field is not signed.

Parameters:

[in]	aFieldName	The name of the signature field.
[in]	aParameters	Verification parameters or null for default parameters.
[in]	aFlags	Flags modifying the behavior of this function, see udf_simulate and udf_vri.

See also:: addSignature(), updateDSS(), getFields()

synchronized SignDocVerificationResult de.softpro.doc.SignDocDocument.verifySignature ( String aFieldName ) throws SignDocException

Verify a signature of the document.

There is a setFlags() flag modifying the behavior of this function: f_relax_byte_range.

Parameters:

[in] aFieldName The name of the signature field.

Returns:: A new SignDocVerificationResult object describing the result of the verification.

See also:: getSignature(), setFlags(), SignDocField.getSignatureType(), SignDocField.isSigned()

synchronized SignDocVerificationResult de.softpro.doc.SignDocDocument.verifySignature2 ( SignDocSignature aSignature ) throws SignDocException

Verify a signature of the document.

These are the differences between calling this function and calling verifySignature() with the field name obtained from aSignature:

This function fails unless aSignature.getClearedIndex() returns -1.
PDF only: This function uses the DSS of the first document time stamp following the signature described by aSignature. If there is no such document time stamp, the latest DSS will be used. This behavior is required for verifying signatures with LTV (long term validity).

There is a setFlags() flag modifying the behavior of this function: f_relax_byte_range.

Parameters:

[in] aSignature A SignDocSignature object for this document.

Returns:: A new SignDocVerificationResult object describing the result of the verification.

See also:: getSignature(), setFlags(), verifySignature(), SignDocField.getSignatureType(), SignDocField.isSigned()

static String de.softpro.doc.SignDocDocument.withEscapeSequence	(	String	aText,
		String	aLang
	)		`[static]`

Prepend an escape sequence for specifying the natural language in a text string.

This function throws an SignDocInvalidArgumentException if aLang is invalid.

Parameters:

[in]	aText	The text.
[in]	aLang	Language identifier (an RFC3066 language tag with two-character language code and optional two-character country code). Only the language and the optional country will be used, the dash separating them will be removed. Example: "en-US" will prepend ESC "enUS" ESC.

Returns:: A copy of aText with an escape sequence prepended.

See also:: withoutEscapeSequences()

static String de.softpro.doc.SignDocDocument.withoutEscapeSequences ( String aInput ) [static]

Remove escape sequences specifying the natural language in text strings.

You don't need to call this function unless flag f_keep_escape_sequences is set.

Parameters:

[in] aInput The input string.

Returns:: A copy of aInput with escape sequences removed.

See also:: splitEscapeSequences(), withEscapeSequence()

Member Data Documentation

final int de.softpro.doc.SignDocDocument.atrf_compat = 0x01 [static]

Flag for addTextRect(): Behave like addTextRect() of SignDoc SDK 4.2.0.8 and earlier.

If this flag is set, any sequence of CR and LF characters in the text starts a new paragraph (ie, text following such a sequence will be placed at the beginning of the next output line). In consequence, empty lines in the input do not produce empty lines in the output. To get an empty line in the output, you have to add a paragraph containing a non-breaking space (U+00A0) only:

 "Line before empty line\n\xa0\nLine after empty line"

Moreover, lines can be broken only at a space character (U+0020).

If this flag is not set, the rules of UAX #14 will be used. In particular, CR, LF, and CR LF start a new paragraph and lines can be broken after punctuation.

final int de.softpro.doc.SignDocDocument.atrf_default_ltr = 0x4000 [static]

Flag for addTextRect(): Choose direction automatically, default to LTR.

The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph.

The paragraph level will be 0 (LTR) for paragraphs having no strong directional character.

If none of atrf_ltr, atrf_rtl, atrf_default_ltr, and atrf_default_rtl is set, atrf_ltr will be used.

At most one of atrf_ltr, atrf_rtl, atrf_default_ltr, and atrf_default_rtl can be set.

This flag will be ignored if atrf_compat is set.

final int de.softpro.doc.SignDocDocument.atrf_default_rtl = 0x8000 [static]

Flag for addTextRect(): Choose direction automatically, default to RTL.

The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph.

The paragraph level will be 1 (RTL) for paragraphs having no strong directional character.

If none of atrf_ltr, atrf_rtl, atrf_default_ltr, and atrf_default_rtl is set, atrf_ltr will be used.

At most one of atrf_ltr, atrf_rtl, atrf_default_ltr, and atrf_default_rtl can be set.

This flag will be ignored if atrf_compat is set.

final int de.softpro.doc.SignDocDocument.atrf_ltr = 0x1000 [static]

Flag for addTextRect(): Paragraph direction: LTR.

If none of atrf_ltr, atrf_rtl, atrf_default_ltr, and atrf_default_rtl is set, atrf_ltr will be used.

At most one of atrf_ltr, atrf_rtl, atrf_default_ltr, and atrf_default_rtl can be set.

final int de.softpro.doc.SignDocDocument.atrf_rtl = 0x2000 [static]

Flag for addTextRect(): Paragraph direction: RTL.

If none of atrf_ltr, atrf_rtl, atrf_default_ltr, and atrf_default_rtl is set, atrf_ltr will be used.

At most one of atrf_ltr, atrf_rtl, atrf_default_ltr, and atrf_default_rtl can be set.

This flag will be ignored if atrf_compat is set.

final int de.softpro.doc.SignDocDocument.car_match = 0 [static]

Return value for checkAttachment(): The attachment matches its checksum.

final int de.softpro.doc.SignDocDocument.car_mismatch = 2 [static]

Return value for checkAttachment(): The attachment does not match its checksum.

final int de.softpro.doc.SignDocDocument.car_no_checksum = 1 [static]

Return value for checkAttachment(): The attachment does not have a checksum.

final int de.softpro.doc.SignDocDocument.ctsf_unsaved = 0x01 [static]

Flag for copyToStream(): Include unsaved changes.

See copyToStream() for details.

See also:: copyToStream()

final int de.softpro.doc.SignDocDocument.dt_fdf = 4 [static]

Document type: FDF document.

See also:: dt_other, dt_pdf, dt_tiff, dt_unknown

final int de.softpro.doc.SignDocDocument.dt_other = 3 [static]

Document type: Other document.

See also:: dt_fdf, dt_pdf, dt_tiff, dt_unknown

final int de.softpro.doc.SignDocDocument.dt_pdf = 1 [static]

Document type: PDF document.

See also:: dt_fdf, dt_other, dt_tiff, dt_unknown

final int de.softpro.doc.SignDocDocument.dt_tiff = 2 [static]

Document type: TIFF document.

See also:: dt_fdf, dt_other, dt_pdf, dt_unknown

final int de.softpro.doc.SignDocDocument.dt_unknown = 0 [static]

Document type: unknown, for SignDocDocumentLoader.ping().

See also:: dt_fdf, dt_other, dt_pdf, dt_tiff

final int de.softpro.doc.SignDocDocument.e_top = 0x01 [static]

Flag for exportFields() and exportProperties(): Include XML declaration and schema for top-level element.

final int de.softpro.doc.SignDocDocument.f_ambiguous_button_value_empty = 0x02 [static]

Flag for setFlags(): Make exportFields(), getField(), getFields(), and getFieldsOfPage() return an empty button value if there are multiple non-Off values for a check box field.

An empty button value will make setField() fail. Set this flag if you want to detect check box fields with ambiguous button values or if you want to keep the behavior of SignDoc SDK 4.0 and earlier.

If this flag is not set, the first non-Off value of a check box field will be used as button value. The ordering used for determining the first non-Off value is unspecified and may change with different versions of SignDoc SDK.

This flag is used for PDF documents only, it is ignored for TIFF documents.

See also:: getField(), getFlags(), setFlags(), f_relax_byte_range

final int de.softpro.doc.SignDocDocument.f_fail_for_broken_target_structure = 0x400 [static]

Flag for setFlags(): Fail if a new object cannot be inserted into the logical structure of the target document due to that logical structure being broken.

If this flag is not set and insertion into the logical structure fails due to that logical structure being broken, the logical structure will not be modified.

See also:: addAnnotation(), addField(), addImageFromBlob(), addImageFromBlob2(), addImageFromFile(), addImageFromFile2(), addText(), addText2(), addTextRect(), addTextRect2(), importPageFromImageBlob(), importPageFromImageBlob2(), importPageFromImageFile(), importPageFromImageFile2(), importPages(), setField(), f_prevent_breaking_tagged_pdf

final int de.softpro.doc.SignDocDocument.f_insert_at_end = 0x100 [static]

Flag for setFlags(): Do not attempt to insert new objects into the logical structure in reading order.

If inserting in reading order fails or if this flag is set, new objects will be inserted at the end of the page's logical structure.

final int de.softpro.doc.SignDocDocument.f_keep_escape_sequences = 0x20 [static]

Flag for setFlags(): Do not remove escape sequences specifying the natural language from text strings.

In PDF, text strings can contain escape sequences which specify the natural language (and optionally, the country) of the text. By default, those escape sequences are removed by functions like SignDocField.getAlternateName(). If this flag is set, those escape sequences are not removed.

If you serialize and deserialize a SignDocField object and this flag is not set, the escape sequences will get lost.

See also:: withoutEscapeSequences(), f_use_escape_sequences

final int de.softpro.doc.SignDocDocument.f_no_kerning_for_standard_fonts = 0x08 [static]

Flag for setFlags(): Disable kerning for standard fonts.

This flag is used for testing.

See also:: getFlags(), setFlags(), verifySignature(), f_ambiguous_button_value_empty, f_relax_byte_range

final int de.softpro.doc.SignDocDocument.f_prevent_breaking_tagged_pdf = 0x10 [static]

Flag for setFlags(): Do not allow operations to break Tagged PDF (and PDF/UA).

If this flag is set, operations that would break Tagged PDF will report an error.

If this flag is not set, all operations may break Tagged PDF without reporting an error. The target document's logical structure may be broken or incomplete (and thus violating PDF/UA) after such an operation.

This flag is ignored for TIFF documents.

See also:: isTaggedPDF(), f_fail_for_broken_target_structure

final int de.softpro.doc.SignDocDocument.f_relax_byte_range = 0x01 [static]

Flag for setFlags(): Relax checking of ByteRange.

If this flag is set, ByteRange may have any values allowed by ISO 32000-1:2008. If this flag is not set, verifySignature() and verifySignature2() behaves like Adobe Reader: ByteRange must have two ranges, sorted by offset, and covering the complete document. (Covering the complete document is required for PAdES, the other two criterions are not.)

This flag is used for PDF documents only, it is ignored for TIFF documents.

See also:: getFlags(), setFlags(), verifySignature(), f_ambiguous_button_value_empty

final int de.softpro.doc.SignDocDocument.f_require_alternate_field_name = 0x40 [static]

Flag for setFlags(): Require alternate field names.

If this flag is set and the document claims PDF/UA conformance, addField() will require an alternate field name to be set and setField() won't allow removal of the alternate field name (by setting it to an empty string). If a PDF/UA document does not specify a natural language, the alternate field name must start with an escape sequence specifying the language (see f_use_escape_sequences).

If this flag is not set and the document claims PDF/UA conformance, addField() will use the fully qualified field name as alternate field name. If the document does not provide a natural language, "en" (or the language set with setDefaultDocumentLanguage()) will be used. setField() behaves likewise if the alternate field name is removed (by setting it to an empty string). If a PDF/UA document does not specify a natural language and the alternate field name does not start with an escape sequence specifying the language, language identifier "en" (or the language set with setDefaultDocumentLanguage()) will be used (see f_use_escape_sequences).

See also:: getDocumentLanguage(), setDefaultDocumentLanguage(), setDocumentLanguage(), withEscapeSequence(), f_use_escape_sequences, SignDocField.setAlternateName()

final int de.softpro.doc.SignDocDocument.f_require_lang = 0x80 [static]

Flag for setFlags(): Require language identifier for text.

If this flag is set and the document claims PDF/UA conformance and does not provide a natural language, addText2() will fail unless a language identifier is passed in aLang and addText() will always fail.

If this flag is not set and the document claims PDF/UA conformance and does not provide a natural language, addText() and addText2() will use language identifier "en" (or the language set with setDefaultDocumentLanguage()) unless a language identifier is passed in aLang of addText2() or addTextRect2().

See also:: getDocumentLanguage(), setDefaultDocumentLanguage(), setDocumentLanguage()

final int de.softpro.doc.SignDocDocument.f_use_dss_only = 0x04 [static]

Flag for setFlags(): Use only the Document Security Store for building the certificate chain and for checking the revocation state of the certificates, ignore any certificates, CRLs, and OCSP responses from the signature proper.

This flag is used for testing of verifySignature() and verifySignature2().

See also:: getFlags(), setFlags(), verifySignature(), f_ambiguous_button_value_empty, f_relax_byte_range

final int de.softpro.doc.SignDocDocument.f_use_escape_sequences = 0x200 [static]

Flag for setFlags(): Use escape sequences to encode the natural language in alternate field names.

If a natural language for an alternate field name is provided by the caller (by using an escape sequence) or if SignDoc SDK provides a default natural language for an alternate name, this flag controls how the natural language will be encoded in the document:

If this flag is set, the natural language will be encoded in the string, enabling different languages for the alternate field names of different fields. However, this is quite useless, as currently existing assistive technologies do not support escape sequences.

If this flag is not set and the document does provide a natural language, any escape sequences will be removed from the alternate field name.

If this flag is not set and the document does not provide a natrual language, the document's natural language will be set to the natural language of the alternate name.

See also:: f_keep_escape_sequences, f_require_alternate_field_name

final int de.softpro.doc.SignDocDocument.faf_include_hidden = 0x04 [static]

Flags modifying the behavior of flattenAnnotations(): Include hidden and invisible annotations.

final int de.softpro.doc.SignDocDocument.faf_keep_structure = 0x08 [static]

Flags modifying the behavior of flattenAnnotations(): Do not modify logical structure.

Set this flag only if you don't care about the logical structure of the document and fear problems due to errors in the logical structure. For instance, you might want to use this flag if flattening annotations just for printing with a PDF component that does not support annotations and then throw away the document with the flattened annotations.

final int de.softpro.doc.SignDocDocument.fff_include_hidden = 0x04 [static]

Flags modifying the behavior of flattenFields(): Include hidden and invisible widgets.

final int de.softpro.doc.SignDocDocument.fff_include_signature_signed = 0x02 [static]

Flags modifying the behavior of flattenFields(): Include signed signature fields.

final int de.softpro.doc.SignDocDocument.fff_include_signature_unsigned = 0x01 [static]

Flags modifying the behavior of flattenFields(): Include unsigned signature fields.

final int de.softpro.doc.SignDocDocument.fff_keep_structure = 0x08 [static]

Flags modifying the behavior of flattenFields(): Do not modify logical structure.

Set this flag only if you don't care about the logical structure of the document and fear problems due to errors in the logical structure. For instance, you might want to use this flag if flattening fields just for printing with a PDF component that does not support annotations and then throw away the document with the flattened fields.

final int de.softpro.doc.SignDocDocument.ftf_ignore_hspace = 0x0001 [static]

Flag for findText(): Ignore horizontal whitespace.

This flag may be required for some document types.

See also:: ftf_ignore_hyphenation, ftf_ignore_sequence

final int de.softpro.doc.SignDocDocument.ftf_ignore_hyphenation = 0x0002 [static]

Flag for findText(): Ignore hyphenation.

Note:: Not yet implemented

See also:: ftf_ignore_hspace, ftf_ignore_sequence

final int de.softpro.doc.SignDocDocument.ftf_ignore_sequence = 0x0004 [static]

Flag for findText(): Use character positions instead of sequence.

Using this flag can be expensive.

Note:: Not yet implemented

See also:: ftf_ignore_hspace, ftf_ignore_hyphenation

final int de.softpro.doc.SignDocDocument.ha_auto = 4 [static]

Horizontal alignment for addTextRect(): Align left if the text begins with an LTR run, align right if the text begins with an RTL run.

final int de.softpro.doc.SignDocDocument.ha_center = 1 [static]

Horizontal alignment for addTextRect(): Center.

final int de.softpro.doc.SignDocDocument.ha_left = 0 [static]

Horizontal alignment for addTextRect(): Align left.

final int de.softpro.doc.SignDocDocument.ha_right = 2 [static]

Horizontal alignment for addTextRect(): Align right.

final int de.softpro.doc.SignDocDocument.i_atomic = 0x01 [static]

Flag for importProperties(): Modify all properties from XML or none (on error).

final int de.softpro.doc.SignDocDocument.ii_brightest_transparent = 0x02 [static]

Flag for addImageFromBlob(), addImageFromBlob2(), addImageFromFile(), and addImageFromFile2(): Make the brightest color transparent.

This flag may be specified for addImageFromBlob(), addImageFromBlob2(), addImageFromFile(), and addImageFromFile2() only. importPageFromImageBlob(), importPageFromImageBlob2(), importPageFromImageFile(), and importPageFromImageFile2() always make the image opaque.

The rest of this description applies to addImageFromBlob(), addImageFromBlob2(), addImageFromFile(), and addImageFromFile2() only.

If the image has an alpha channel (or if its palette contains a transparent color), this flag will be ignored and the image's transparency will be used.

Transparency is not supported for JPEG images and JPEG-compressed TIFF images.

If this flag is not set, the image will be opaque unless the image has an alpha channel or transparent colors in its palette.

If this flag is set (and the image doesn't have an alpha channel and doesn't have transparent colors in its palette), white will be made transparent for truecolor images and the brightest color in the palette will be made transparent for indexed images (including grayscale images).

final int de.softpro.doc.SignDocDocument.ii_keep_aspect_ratio = 0x01 [static]

Flag for addImageFromBlob(), addImageFromBlob2(), addImageFromFile(), addImageFromFile2(), importPageFromImageBlob(), importPageFromImageBlob2(), importPageFromImageFile(), and importPageFromImageFile2(): Keep aspect ratio of image, center image on white background.

final int de.softpro.doc.SignDocDocument.kor_keep = 0 [static]

Tell removePages() to keep the specified pages.

Keep the specified pages, remove all other pages.

final int de.softpro.doc.SignDocDocument.kor_remove = 1 [static]

Tell removePages() to remove the specified pages.

Remove the specified pages, keep all other pages.

final int de.softpro.doc.SignDocDocument.sf_auto_incremental = 0x20 [static]

Save flag: Automatically set sf_incremental if needed, automatically reset sf_incremental if not allowed.

If this flag is set, SignDoc SDK will save the incrementally or non-incrementally as needed; if you prefer saving incrementally, also set the sf_incremental flag. If you prefer saving non-incrementally, do not set the sf_incremental flag.

See also:: saveToFile(), sf_incremental, sf_linearized, sf_pdf_1_4, sf_pdfa_buttons, sf_remove_unused

final int de.softpro.doc.SignDocDocument.sf_incremental = 0x01 [static]

Save flag: Save incrementally (PDF).

See also:: saveToFile(), sf_auto_incremental, sf_linearized, sf_pdf_1_4, sf_pdfa_buttons, sf_remove_unused

final int de.softpro.doc.SignDocDocument.sf_linearized = 0x04 [static]

Save flag: Linearize the document (PDF).

This flag cannot be used with sf_incremental.

Note:: This flag is currently ignored, it will be supported again in a future version of SignDoc SDK.

See also:: saveToFile(), saveToStream(), sf_auto_incremental, sf_incremental, sf_pdf_1_4, sf_pdfa_buttons, sf_remove_unused

Todo:: implement sf_linearized

final int de.softpro.doc.SignDocDocument.sf_pdf_1_4 = 0x08 [static]

Save flag: Do not use features introduced after PDF 1.4 for saving the document (PDF)

This flag is assumed to be set for PDF 1.4 (and older) documents.

See also:: saveToFile(), saveToStream(), sf_auto_incremental, sf_incremental, sf_linearized, sf_pdfa_buttons, sf_remove_unused

final int de.softpro.doc.SignDocDocument.sf_pdfa_buttons = 0x10 [static]

Save flag: Fix appearance streams of check boxes and radio buttons for conformance with PDF/A-1 without Technical Corrigendum 2.

The appearance streams of a check box or radio button field added by addField() or modified by setField() or applyFdf() do not conform to ISO 19005-1:2005 before Technical Corrigendum 2 (TC2). The relevant wording was fixed in TC2.

To make the appearance streams of check boxes and radio buttons conform to ISO 19005-1:2005 before TC2, save the document with this flag set. The document will be modified in memory and then saved. The document will not conform to TC2 and later versions of ISO 19005.

This flag is observed even if the document does not claim PDF/A-1 conformance.

Note:: After "fixing" appearance streams, check boxes and radio buttons can no longer be modified or operated as the button values (ie, the set of possible values) is lost.

See also:: saveToFile(), saveToStream(), sf_auto_incremental, sf_incremental, sf_linearized, sf_pdf_1_4, sf_remove_unused, SignDocSignatureParameters.pb_auto, SignDocSignatureParameters.pb_freeze

final int de.softpro.doc.SignDocDocument.sf_remove_unused = 0x02 [static]

Save flag: Remove unused objects (PDF).

This flag is ignored, unused objects are always removed.

See also:: saveToFile(), saveToStream(), sf_auto_incremental, sf_incremental, sf_linearized, sf_pdf_1_4, sf_pdfa_buttons

final int de.softpro.doc.SignDocDocument.sff_auto_alignment = 0x200 [static]

Flag for setField(), addField(), and applyFdf(): Align left if the text begins with an LTR run, align right if the text begins with an RTL run.

This flag overrides for creating the appearance stream SignDocField.j_left and SignDocField.j_right set by SignDocField.setJustification(). This flag is ignored for SignDocField.j_center.

See also:: sff_default_ltr, sff_default_rtl, sff_ltr, sff_rtl

final int de.softpro.doc.SignDocDocument.sff_default_ltr = 0x4000 [static]

Flag for setField(), addField(), and applyFdf(): Choose direction automatically, default to LTR.

The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph.

The paragraph level will be 0 (LTR) for paragraphs having no strong directional character.

If none of sff_ltr, sff_rtl, sff_default_ltr, and sff_default_rtl is set, sff_ltr will be used.

At most one of sff_ltr, sff_rtl, sff_default_ltr, and sff_default_rtl can be set.

Usage of sff_default_ltr is not recommended as the visual representation of the value of the field may not match the value of the field (as interpreted by software which does not know that the paragraph direction is supposed to be default-LTR). Use sff_default_ltr only as last resort if you cannot modify the text received from a default-LTR input field appropriately for paragraph direction LTR used in PDF fields.

See also:: sff_auto_alignment

final int de.softpro.doc.SignDocDocument.sff_default_rtl = 0x8000 [static]

Flag for setField(), addField(), and applyFdf(): Choose direction automatically, default to RTL.

The base direction of each paragraph (BiDi paragraph level) will depend on the first strong directional character in the paragraph.

The paragraph level will be 1 (RTL) for paragraphs having no strong directional character.

If none of sff_ltr, sff_rtl, sff_default_ltr, and sff_default_rtl is set, sff_ltr will be used.

At most one of sff_ltr, sff_rtl, sff_default_ltr, and sff_default_rtl can be set.

Usage of sff_default_rtl is not recommended as the visual representation of the value of the field may not match the value of the field (as interpreted by software which does not know that the paragraph direction is supposed to be default-RTL). Use sff_default_rtl only as last resort if you cannot modify the text received from a default-RTL input field appropriately for paragraph direction LTR used in PDF fields.

See also:: sff_auto_alignment

final int de.softpro.doc.SignDocDocument.sff_dont_break_lines = 0x100 [static]

Flag for setField(), addField(), and applyFdf(): Do not break lines in multiline text fields.

You can use this flag to simulate the behavior of SignDoc SDK 4.0 and earlier.

See also:: addField(), applyFdf(), setField(), sff_fit_height_only, sff_force_border_width, sff_move, sff_keep_ap, sff_update_ap

final int de.softpro.doc.SignDocDocument.sff_fit_height_only = 0x40 [static]

Flag for setField(), addField(), and applyFdf(): Compute the default font size such that the field contents fit the height of the field.

If the font size for a text field, list box field, or combo box field is zero (see SignDocTextFieldAttributes.setFontSize()), the default font size will be used. This flag controls how the default font size is computed.

If this flag is set, the font size will be computed such that the field contents fit the height of the field. This is the behavior required by the PDF specification. If the field contents are too long, they will be truncated.

If this flag is not set, the font size will be computed such that the field contents fit both the height and the width of the field. This is the behavior implemented in, for instance, Adobe Acrobat.

This flag is assumed to be not set if line breaking is enabled.

See also:: applyFdf(), setField(), sff_dont_break_lines, sff_force_border_width, sff_move, sff_keep_ap, sff_update_ap

final int de.softpro.doc.SignDocDocument.sff_font_fail = 0x01 [static]

Flag for setField(), addField(), and applyFdf(): Fail if no suitable font is found.

setField(), addField(), and applyFdf() won't modify/add the field and will throw SignDocFontNotFoundException if no font covering all required characters is found.

This flag is provided for compatibility with existing code; setField(), addField(), and applyFdf() now always assume this flag is set.

See also:: addField(), applyFdf(), setField(), sff_dont_break_lines, sff_fit_height_only, sff_force_border_width, sff_move, sff_keep_ap, sff_update_ap

final int de.softpro.doc.SignDocDocument.sff_force_border_width = 0x80 [static]

Flag for setField(), addField(), and applyFdf(): Use the border width specified by the field even if that will obliterate the field contents.

If this flag is set, the behavior matches that of Adobe Acrobat. If this flag is not set, the border width will be reduced to 1/16 of the field height or field width (whichever is smaller) if the border width specified by the field wouldn't leave enough space for the field contents.

See also:: addField(), applyFdf(), setField(), sff_dont_break_lines, sff_fit_height_only, sff_move, sff_keep_ap, sff_update_ap

final int de.softpro.doc.SignDocDocument.sff_keep_ap = 0x10 [static]

Flag for setField(), addField(), and applyFdf(): Keep appearance streams.

If this flag is set, setField() and applyFdf() won't touch the existing (or non-existing) appearance streams, addField() won't add any appearance streams.

Recomputing the appearance can have unexpected results (for instance, Adobe Acrobat and SignDoc SDK use different designs for check marks), therefore you might want to set this flag if you make changes that shall not affect the appearance such as setting the SignDocField.f_ReadOnly flag.

At most one of sff_keep_ap and sff_update_ap can be set.

See also:: addField(), applyFdf(), setField(), sff_dont_break_lines, sff_fit_height_only, sff_force_border_width, sff_move, sff_update_ap

final int de.softpro.doc.SignDocDocument.sff_ltr = 0x1000 [static]

Flag for setField(), addField(), and applyFdf(): Paragraph direction: LTR.

If none of sff_ltr, sff_rtl, sff_default_ltr, and sff_default_rtl is set, sff_ltr will be used.

At most one of sff_ltr, sff_rtl, sff_default_ltr, and sff_default_rtl can be set.

See also:: sff_auto_alignment

final int de.softpro.doc.SignDocDocument.sff_move = 0x08 [static]

Flag for setField(): Move or resize field.

setField() does not update the coordinates of the field unless this flag is set as moving a field may require recomputing the appearance which can have unexpected results (for instance, Adobe Acrobat and SignDoc SDK use different designs for check marks). If this flag is not set, setField() ignores the coordinates set with SignDocField.setLeft(), SignDocField.setBottom(), SignDocField.setRight(), and SignDocField.setTop().

addField() ignores this flag, it always uses the coordinates. applyFdf() ignores this flag, it never moves or resizes fields.

In documents using Tagged PDF, widgets can be moved only within the page, they cannot be moved to a different page.

See also:: setField(), sff_dont_break_lines, sff_fit_height_only, sff_force_border_width, sff_keep_ap, sff_update_ap

final int de.softpro.doc.SignDocDocument.sff_rtl = 0x2000 [static]

Flag for setField(), addField(), and applyFdf(): Paragraph direction: RTL.

If none of sff_ltr, sff_rtl, sff_default_ltr, and sff_default_rtl is set, sff_ltr will be used.

At most one of sff_ltr, sff_rtl, sff_default_ltr, and sff_default_rtl can be set.

Usage of sff_rtl is not recommended as the visual representation of the value of the field may not match the value of the field (as interpreted by software which does not know that the paragraph direction is supposed to be RTL). Use sff_rtl only as last resort if you cannot modify the text received from an RTL input field appropriately for paragraph direction LTR used in PDF fields.

See also:: sff_auto_alignment

final int de.softpro.doc.SignDocDocument.sff_update_ap = 0x20 [static]

Flag for setField() and applyFdf(): Update appearance streams.

If this flag is set, setField() and applyFdf() will always recompute the appearance streams of the field. (addField() always computes the appearance stream unless sff_keep_ap is set).

You might want to use this flag after changing the document's default text field attributes.

At most one of sff_keep_ap and sff_update_ap can be set.

If neither sff_keep_ap and sff_update_ap is set, setField() tries to update the appearance streams only if necessary; the exact behavior depends on the version of SignDoc SDK.

See also:: applyFdf(), setField(), sff_dont_break_lines, sff_fit_height_only, sff_force_border_width, sff_move, sff_keep_ap

final int de.softpro.doc.SignDocDocument.siff_allow_all_curves = 0x80 [static]

Flag for setShootInFoot(): Allow elliptic curves for signing which are not supported by Adobe products for Windows.

As of August 2016, Adobe Acrobat XI and 2015 for Windows support these curves: secp192r1 (prime192v1), secp256r1 (prime256v1), secp224r1, secp384r1, and secp521r1.

Setting this flag enables additional curves: prime192v2, prime192v3, prime239v1, prime239v2, prime239v3, secp112r1, secp112r2, secp160r1, secp160k1, secp256k1, secp128r1, secp128r2, secp160r2, secp192k1, secp224k1, brainpoolp160r1, brainpoolp192r1, brainpoolp224r1, brainpoolp256r1, brainpoolp320r1, brainpoolp384r1, and brainpoolp512r1. However, most of these are not supported (for signing and verifying) by SignDoc SDK for iOS, OS X, and Windows Store apps due to limitations of those operating systems.

This flag is ignored (and assumed to be set) for TIFF documents. This flag is ignored if SignDocSignatureParameters.setPKCS7() is used.

final int de.softpro.doc.SignDocDocument.siff_allow_breaking_permissions = 0x02 [static]

Flag for setShootInFoot(): Allow operations to break signatures which grant permissions.

This flag is available for PDF documents only.

See also:: siff_allow_breaking_signatures, siff_allow_invalid_certificate

final int de.softpro.doc.SignDocDocument.siff_allow_breaking_signatures = 0x01 [static]

Flag for setShootInFoot(): Allow operations to break existing signatures in signature fields.

This flag is available for PDF documents only.

See also:: siff_allow_breaking_permissions, siff_allow_invalid_certificate

final int de.softpro.doc.SignDocDocument.siff_allow_invalid_certificate = 0x04 [static]

Flag for setShootInFoot(): Allow signing with a certificate that is not yet valid or no longer valid or which is not qualified for digital signatures.

See also:: siff_allow_breaking_signatures, siff_allow_breaking_permissions

final int de.softpro.doc.SignDocDocument.siff_allow_non_standard_external_fonts = 0x08 [static]

Flag for setShootInFoot(): Allow non-standard usage of external (non-embedded) TrueType and CFF fonts.

If this flag is not set, TrueType and CFF fonts must be embedded; when trying to use a TrueType or CFF font that is not embededded, SignDocFontNotFoundException will be thrown.

If this flag is set, external TrueType and CFF fonts are allowed. However, the document will violate Table 117, section 9.7.4.2 and section 9.7.5.2 of ISO 32000-1:2008.

final int de.softpro.doc.SignDocDocument.siff_assume_ap_not_shared = 0x10 [static]

Flag for setShootInFoot(): Assume that appearance dictionaries and appearance streams are not shared.

If this flag is set and that assumption doesn't hold, changing one field may change the appearances of other fields.

At most one of siff_assume_ap_not_shared and siff_assume_ap_shared can be set. If neither flag is set, setField() and addSignature() look for shared objects. This can be expensive in terms of time and memory.

final int de.softpro.doc.SignDocDocument.siff_assume_ap_shared = 0x20 [static]

Flag for setShootInFoot(): Always assume that appearance dictionaries and appearance streams are shared.

Setting this flag partially simulates the behavior of SignDoc SDK 3.x and older and causes a minor violation of section 12.7.3.3 of ISO 32000-1:2008 by setField().

At most one of siff_assume_ap_not_shared and siff_assume_ap_shared can be set. If neither flag is set, setField() and addSignature() look for shared objects. This can be expensive in terms of time and memory.

final int de.softpro.doc.SignDocDocument.siff_dont_verify_after_signing = 0x40 [static]

Flag for setShootInFoot(): Disable verification of signature after signing by addSignature().

You might want to set this flag if you always perform a complete verification with verifySignature() after calling addSignature().

final int de.softpro.doc.SignDocDocument.udf_simulate = 0x01 [static]

Flag for updateDSS() and updateDSS2(): Perform all the checks but do not modify the document.

final int de.softpro.doc.SignDocDocument.udf_vri = 0x02 [static]

Flag for updateDSS() and updateDSS2(): Create VRI dictionaries.

This is discouraged by ETSI TS 103 172 V2.2.2 section 8.1.1.

final int de.softpro.doc.SignDocDocument.va_bottom = 2 [static]

Vertical alignment for addTextRect(): Align bottom.

final int de.softpro.doc.SignDocDocument.va_center = 1 [static]

Vertical alignment for addTextRect(): Center.