SignDocField Class Reference

Class representing one field of a document. More...

Inheritance diagram for SignDocField:

Public Member Functions
	SignDocField () throws SignDocException
	Constructor. More...
synchronized SignDocField	clone () throws SignDocException
	Clone this object. More...
synchronized String	getName () throws SignDocException
	Get the name of the field. More...
synchronized void	setName (String aName) throws SignDocException
	Set the name of the field. More...
synchronized String	getAlternateName () throws SignDocException
	Get the alternate name of the field. More...
synchronized void	setAlternateName (String aName) throws SignDocException
	Set the alternate name of the field. More...
synchronized String	getMappingName () throws SignDocException
	Get the mapping name of the field. More...
synchronized void	setMappingName (String aName) throws SignDocException
	Set the mapping name of the field. More...
synchronized int	getValueCount () throws SignDocException
	Get the number of values of the field. More...
synchronized String	getValue (int aIndex) throws SignDocException
	Get a value of the field. More...
synchronized void	clearValues () throws SignDocException
	Clear the values. More...
synchronized void	addValue (String aValue) throws SignDocException
	Add a value to the field. More...
synchronized boolean	setValue (int aIndex, String aValue) throws SignDocException
	Set a value of the field. More...
synchronized void	setValue (String aValue) throws SignDocException
	Set the value of the field. More...
synchronized boolean	removeValue (int aIndex) throws SignDocException
	Remove a value from the field. More...
synchronized int	getValueIndex () throws SignDocException
	Get the current value index. More...
synchronized void	setValueIndex (int aIndex) throws SignDocException
	Set the value index. More...
synchronized boolean	clickButton (int aIndex) throws SignDocException
	Click a check box or a radio button. More...
synchronized int	getChoiceCount () throws SignDocException
	Get the number of available choices for a list box or combo box. More...
synchronized String	getChoiceValue (int aIndex) throws SignDocException
	Get an available choice of a list box or combo box. More...
synchronized String	getChoiceExport (int aIndex) throws SignDocException
	Get the export value for an available choice of a list box or combo box. More...
synchronized void	clearChoices () throws SignDocException
	Clear the choices of a list box or combo box. More...
synchronized void	addChoice (String aValue) throws SignDocException
	Add a choice to a list box or combo box. More...
synchronized void	addChoice (String aValue, String aExport) throws SignDocException
	Add a choice to a list box or combo box. More...
synchronized boolean	setChoice (int aIndex, String aValue) throws SignDocException
	Set a choice value of a list box or combo box. More...
synchronized boolean	setChoice (int aIndex, String aValue, String aExport) throws SignDocException
	Set a choice value of a list box or combo box. More...
synchronized boolean	removeChoice (int aIndex) throws SignDocException
	Remove a choice from a list box or combo box. More...
synchronized int	getType () throws SignDocException
	Get the type of the field. More...
synchronized void	setType (int aType) throws SignDocException
	Set the type of the field. More...
synchronized int	getFlags () throws SignDocException
	Get the flags of the field. More...
synchronized void	setFlags (int aFlags) throws SignDocException
	Set the flags of the field. More...
synchronized int	getSignatureType () throws SignDocException
	Get the signature type of a signature field. More...
synchronized int	getDocMDP () throws SignDocException
	Get the DocMDP P value of a certification signature. More...
synchronized boolean	isSigned () throws SignDocException
	Check if this field is a signed signature field. More...
synchronized boolean	isCurrentlyClearable () throws SignDocException
	Check if this signature field is currently clearable. More...
synchronized int	getMaxLen () throws SignDocException
	Get maximum length of text field. More...
synchronized void	setMaxLen (int aMaxLen) throws SignDocException
	Set maximum length of text fields. More...
synchronized int	getTopIndex () throws SignDocException
	Get the index of the choice to be displayed in the first line of a list box. More...
synchronized void	setTopIndex (int aTopIndex) throws SignDocException
	Set the index of the choice to be displayed in the first line of a list box. More...
synchronized int	getWidget () throws SignDocException
	Get the index of the currently selected widget. More...
synchronized int	getWidgetCount () throws SignDocException
	Get the number of widgets. More...
synchronized boolean	selectWidget (int aIndex) throws SignDocException
	Select a widget. More...
synchronized boolean	addWidget () throws SignDocException
	Add a widget to the field. More...
synchronized boolean	insertWidget (int aIndex) throws SignDocException
	Add a widget to the field in front of another widget. More...
synchronized boolean	removeWidget (int aIndex) throws SignDocException
	Remove a widget from the field. More...
synchronized int	getWidgetFlags () throws SignDocException
	Get the annotation flags of the widget, see wf_Invisible. More...
synchronized void	setWidgetFlags (int aFlags) throws SignDocException
	Set the annotation flags of the widget, see wf_Invisible. More...
synchronized int	getPage () throws SignDocException
	Get the page number. More...
synchronized void	setPage (int aPage) throws SignDocException
	Set the page number. More...
synchronized double	getLeft () throws SignDocException
	Get the left coordinate. More...
synchronized void	setLeft (double aLeft) throws SignDocException
	Set the left coordinate. More...
synchronized double	getBottom () throws SignDocException
	Get the bottom coordinate. More...
synchronized void	setBottom (double aBottom) throws SignDocException
	Set the bottom coordinate. More...
synchronized double	getRight () throws SignDocException
	Get the right coordinate. More...
synchronized void	setRight (double aRight) throws SignDocException
	Set the right coordinate. More...
synchronized double	getTop () throws SignDocException
	Get the top coordinate. More...
synchronized void	setTop (double aTop) throws SignDocException
	Set the top coordinate. More...
synchronized String	getButtonValue () throws SignDocException
	Get the button value of a widget of a radio button group or check box. More...
synchronized void	setButtonValue (String aValue) throws SignDocException
synchronized int	getJustification () throws SignDocException
	Get the justification of the widget. More...
synchronized void	setJustification (int aJustification) throws SignDocException
	Set the justification of the widget. More...
synchronized int	getRotation () throws SignDocException
	Get the rotation of the widget contents. More...
synchronized void	setRotation (int aRotation) throws SignDocException
	Set the rotation of the widget contents. More...
synchronized SignDocTextFieldAttributes	getTextFieldAttributes () throws SignDocException
	Get the text field attributes of the widget. More...
synchronized boolean	setTextFieldAttributes (SignDocTextFieldAttributes aInput) throws SignDocException
	Set the text field attributes of the widget. More...
synchronized SignDocColor	getBackgroundColor () throws SignDocException
	Get the background color of the widget. More...
synchronized void	setBackgroundColor (SignDocColor aColor) throws SignDocException
	Set the background color of the widget. More...
synchronized SignDocColor	getBorderColor () throws SignDocException
	Get the border color of the widget. More...
synchronized void	setBorderColor (SignDocColor aColor) throws SignDocException
	Set the border color of the widget. More...
synchronized double	getBorderWidth () throws SignDocException
	Get the border width of the widget. More...
synchronized void	setBorderWidth (double aWidth) throws SignDocException
	Set the border width of the widget. More...
synchronized int	getBorderStyle () throws SignDocException
	Get the border style. More...
synchronized void	setBorderStyle (int aStyle) throws SignDocException
	Set the border style. More...
synchronized int	getButtonStyle () throws SignDocException
	Get the button style of a check box or radio button field. More...
synchronized void	setButtonStyle (int aStyle) throws SignDocException
	Set the button style of a check box or radio button field. More...
synchronized int	getLockType () throws SignDocException
	Get the lock type. More...
synchronized void	setLockType (int aLockType) throws SignDocException
	Set the lock type. More...
synchronized int	getLockFieldCount () throws SignDocException
	Get the number of field names for lt_include and lt_exclude. More...
synchronized String	getLockField (int aIndex) throws SignDocException
	Get the name of a lock field. More...
synchronized void	clearLockFields () throws SignDocException
	Clear the lock fields. More...
synchronized void	addLockField (String aName) throws SignDocException
	Add a lock field to the field. More...
synchronized boolean	setLockField (int aIndex, String aName) throws SignDocException
	Set a lock field. More...
synchronized void	setLockField (String aName) throws SignDocException
	Set a lock field. More...
synchronized boolean	removeLockField (int aIndex) throws SignDocException
	Remove a lock field. More...
synchronized int	getLockMDP () throws SignDocException
	Get the lock MDP value. More...
synchronized void	setLockMDP (int aMDP) throws SignDocException
	Set the lock MDP value. More...
synchronized int	getCertSeedValueFlags () throws SignDocException
	Get the certificate seed value dictionary flags (/SV/Cert/Ff) of a signature field. More...
synchronized void	setCertSeedValueFlags (int aFlags) throws SignDocException
	Set the certificate seed value dictionary flags (/SV/Cert/Ff) of a signature field. More...
synchronized int	getCertSeedValueSubjectDNCount () throws SignDocException
	Get the number of subject distinguished names in the certificate seed value dictionary. More...
synchronized String	getCertSeedValueSubjectDN (int aIndex) throws SignDocException
	Get a subject distinguished name from the certificate seed value dictionary. More...
synchronized void	clearCertSeedValueSubjectDNs () throws SignDocException
	Remove all subject distinguished names from the certificate seed value dictionary. More...
synchronized boolean	addCertSeedValueSubjectDN (String aName) throws SignDocException
	Add a subject distinguished name to the certificate seed value dictionary. More...
synchronized boolean	setCertSeedValueSubjectDN (int aIndex, String aName) throws SignDocException
	Set a subject distinguished name in the certificate seed value dictionary. More...
synchronized boolean	setCertSeedValueSubjectDN (String aName) throws SignDocException
	Set a subject distinguished name in the certificate seed value dictionary. More...
synchronized boolean	removeCertSeedValueSubjectDN (int aIndex) throws SignDocException
	Remove a subject distinguished name from the certificate seed value dictionary. More...
synchronized int	getCertSeedValuePolicyCount () throws SignDocException
	Get the number of policy OIDs in the certificate seed value dictionary. More...
synchronized String	getCertSeedValuePolicy (int aIndex) throws SignDocException
	Get a policy OID from the certificate seed value dictionary. More...
synchronized void	clearCertSeedValuePolicies () throws SignDocException
	Remove all policy OIDs from the certificate seed value dictionary. More...
synchronized void	addCertSeedValuePolicy (String aOID) throws SignDocException
	Add a policy OID to the certificate seed value dictionary. More...
synchronized boolean	setCertSeedValuePolicy (int aIndex, String aOID) throws SignDocException
	Set a policy OID in the certificate seed value dictionary. More...
synchronized void	setCertSeedValuePolicy (String aOID) throws SignDocException
	Set a policy OID in the certificate seed value dictionary. More...
synchronized boolean	removeCertSeedValuePolicy (int aIndex) throws SignDocException
	Remove a policy OID from the certificate seed value dictionary. More...
synchronized int	getCertSeedValueSubjectCertificateCount () throws SignDocException
	Get the number of subject certificates in the certificate seed value dictionary. More...
synchronized byte[]	getCertSeedValueSubjectCertificate (int aIndex) throws SignDocException
	Get a subject certificate of the certificate seed value dictionary. More...
synchronized void	clearCertSeedValueSubjectCertificates () throws SignDocException
	Remove all subject certificates from the certificate seed value dictionary. More...
synchronized void	addCertSeedValueSubjectCertificate (byte[] aCert) throws SignDocException
	Add a subject certificate to the certificate seed value dictionary. More...
synchronized boolean	setCertSeedValueSubjectCertificate (int aIndex, byte[] aCert) throws SignDocException
	Set a subject certificate in the certificate seed value dictionary. More...
synchronized void	setCertSeedValueSubjectCertificate (byte[] aCert) throws SignDocException
	Set a subject certificate in the certificate seed value dictionary. More...
synchronized boolean	removeCertSeedValueSubjectCertificate (int aIndex) throws SignDocException
	Remove a subject certificate from the certificate seed value dictionary. More...
synchronized int	getCertSeedValueIssuerCertificateCount () throws SignDocException
	Get the number of issuer certificates in the certificate seed value dictionary. More...
synchronized byte[]	getCertSeedValueIssuerCertificate (int aIndex) throws SignDocException
	Get an issuer certificate of the certificate seed value dictionary. More...
synchronized void	clearCertSeedValueIssuerCertificates () throws SignDocException
	Remove all issuer certificates from the certificate seed value dictionary. More...
synchronized void	addCertSeedValueIssuerCertificate (byte[] aCert) throws SignDocException
	Add an issuer certificate to the certificate seed value dictionary. More...
synchronized boolean	setCertSeedValueIssuerCertificate (int aIndex, byte[] aCert) throws SignDocException
	Set an issuer certificate in the certificate seed value dictionary. More...
synchronized void	setCertSeedValueIssuerCertificate (byte[] aCert) throws SignDocException
	Set an issuer certificate in the certificate seed value dictionary. More...
synchronized boolean	removeCertSeedValueIssuerCertificate (int aIndex) throws SignDocException
	Remove an issuer certificate from the certificate seed value dictionary. More...
synchronized String	getSeedValueTimeStampServerURL () throws SignDocException
	Get the URL of the RFC 3161 time-stamp server from the signature field seed value dictionary. More...
synchronized boolean	getSeedValueTimeStampRequired () throws SignDocException
	This function gets a flag from the signature field seed value dictionary that indicates whether a time stamp is required or not for the signature. More...
synchronized boolean	setSeedValueTimeStamp (String aURL, boolean aRequired) throws SignDocException
	Set the URL of an RFC 3161 time-stamp server in the signature field seed value dictionary. More...
synchronized String	getSeedValueFilter () throws SignDocException
	Get Filter entry (signature handler) from the signature field seed value dictionary. More...
synchronized boolean	getSeedValueFilterRequired () throws SignDocException
	This function gets a flag from the signature field seed value dictionary that indicates whether the Filter entry (signature handler) is a required constraint or not. More...
synchronized boolean	setSeedValueFilter (String aFilter, boolean aRequired) throws SignDocException
	Set the Filter entry (signature handler) in the signature field seed value dictionary. More...
synchronized int	getSeedValueSubFilterCount () throws SignDocException
	Get the number of SubFilter values in the seed value dictionary. More...
synchronized String	getSeedValueSubFilter (int aIndex) throws SignDocException
	Get a SubFilter value from the seed value dictionary. More...
synchronized boolean	getSeedValueSubFilterRequired () throws SignDocException
	This function gets a flag from the signature field seed value dictionary that indicates whether the SubFilter values are a required constraint or not. More...
synchronized void	setSeedValueSubFilterRequired (boolean aRequired) throws SignDocException
	Set a flag from the signature field seed value dictionary that indicates whether the SubFilter values are a required constraint or not. More...
synchronized void	clearSeedValueSubFilters () throws SignDocException
	Remove all SubFilter values from the seed value dictionary. More...
synchronized void	addSeedValueSubFilter (String aSubFilter) throws SignDocException
	Add a SubFilter value to the seed value dictionary. More...
synchronized boolean	setSeedValueSubFilter (int aIndex, String aSubFilter) throws SignDocException
	Set a SubFilter value in the seed value dictionary. More...
synchronized void	setSeedValueSubFilter (String aSubFilter) throws SignDocException
	Set a SubFilter value in the seed value dictionary. More...
synchronized boolean	removeSeedValueSubFilter (int aIndex) throws SignDocException
	Remove a SubFilter value from the seed value dictionary. More...
synchronized int	getSeedValueDigestMethodCount () throws SignDocException
	Get the number of DigestMethod values in the seed value dictionary. More...
synchronized String	getSeedValueDigestMethod (int aIndex) throws SignDocException
	Get a DigestMethod value from the seed value dictionary. More...
synchronized boolean	getSeedValueDigestMethodRequired () throws SignDocException
	This function gets a flag from the signature field seed value dictionary that indicates whether the DigestMethod values are a required constraint or not. More...
synchronized void	setSeedValueDigestMethodRequired (boolean aRequired) throws SignDocException
	Set a flag from the signature field seed value dictionary that indicates whether the DigestMethod values are a required constraint or not. More...
synchronized void	clearSeedValueDigestMethods () throws SignDocException
	Remove all DigestMethod values from the seed value dictionary. More...
synchronized void	addSeedValueDigestMethod (String aDigestMethod) throws SignDocException
	Add a DigestMethod value to the seed value dictionary. More...
synchronized boolean	setSeedValueDigestMethod (int aIndex, String aDigestMethod) throws SignDocException
	Set a DigestMethod value in the seed value dictionary. More...
synchronized void	setSeedValueDigestMethod (String aDigestMethod) throws SignDocException
	Set a DigestMethod value in the seed value dictionary. More...
synchronized boolean	removeSeedValueDigestMethod (int aIndex) throws SignDocException
	Remove a DigestMethod value from the seed value dictionary. More...
synchronized boolean	getSeedValueAddRevInfo () throws SignDocException
	Get the AddRevInfo flag from the signature field seed value dictionary. More...
synchronized void	setSeedValueAddRevInfo (boolean aAddRevInfo) throws SignDocException
	Set the AddRevInfo flag in the signature field seed value dictionary. More...
synchronized int	getSeedValueMDP () throws SignDocException
	Get the MDP value from the signature field seed value dictionary. More...
synchronized boolean	setSeedValueMDP (int aMDP) throws SignDocException
	Set the MDP value in the signature field seed value dictionary. More...
synchronized SignDocColor	getEmptyFieldColor () throws SignDocException
	Get the color used for empty signature field in TIFF document. More...
synchronized void	setEmptyFieldColor (SignDocColor aColor) throws SignDocException
	Set color used for empty signature field in TIFF document. More...
synchronized void	close ()
	Destroy the underlying native object (for java.lang.AutoCloseable). More...

Static Public Attributes
static final int	t_unknown = 0
	Field type: Unknown type. More...
static final int	t_pushbutton = 1
	Field type: Pushbutton (PDF). More...
static final int	t_check_box = 2
	Field type: Check box field (PDF). More...
static final int	t_radio_button = 3
	Field type: Radio button (radio button group) (PDF). More...
static final int	t_text = 4
	Field type: Text field (PDF). More...
static final int	t_list_box = 5
	Field type: List box (PDF). More...
static final int	t_signature_digsig = 6
	Field type: Digital signature field (Adobe DigSig in PDF, SOFTPRO signature in TIFF). More...
static final int	t_signature_signdoc = 7
	Field type: Digital signature field (traditional SignDoc) (PDF). More...
static final int	t_combo_box = 8
	Field type: Combo box (drop-down box) (PDF). More...
static final int	f_ReadOnly = 1 << 0
	Field flag: ReadOnly. More...
static final int	f_Required = 1 << 1
	Field flag: Required. More...
static final int	f_NoExport = 1 << 2
	Field flag: NoExport. More...
static final int	f_NoToggleToOff = 1 << 3
	Field flag: NoToggleToOff. More...
static final int	f_Radio = 1 << 4
	Field flag: Radio. More...
static final int	f_Pushbutton = 1 << 5
	Field flag: Pushbutton. More...
static final int	f_RadiosInUnison = 1 << 6
	Field flag: RadiosInUnison. More...
static final int	f_MultiLine = 1 << 7
	Field flag: MultiLine (for text fields). More...
static final int	f_Password = 1 << 8
	Field flag: Password. More...
static final int	f_FileSelect = 1 << 9
	Field flag: FileSelect. More...
static final int	f_DoNotSpellCheck = 1 << 10
	Field flag: DoNotSpellCheck. More...
static final int	f_DoNotScroll = 1 << 11
	Field flag: DoNotScroll. More...
static final int	f_Comb = 1 << 12
	Field flag: Comb. More...
static final int	f_RichText = 1 << 13
	Field flag: RichText. More...
static final int	f_Combo = 1 << 14
	Field flag: Combo (always set for combo boxes). More...
static final int	f_Edit = 1 << 15
	Field flag: Edit (for combo boxes). More...
static final int	f_Sort = 1 << 16
	Field flag: Sort (for list boxes and combo boxes). More...
static final int	f_MultiSelect = 1 << 17
	Field flag: MultiSelect (for list boxes). More...
static final int	f_CommitOnSelChange = 1 << 18
	Field flag: CommitOnSelChange (for list boxes and combo boxes). More...
static final int	f_SinglePage = 1 << 28
	Field flag: Signature applies to the containing page only (TIFF only). More...
static final int	f_EnableAddAfterSigning = 1 << 29
	Field flag: Signature fields can be inserted after signing this field (TIFF only). More...
static final int	f_Invisible = 1 << 30
	Field flag: Invisible (TIFF only). More...
static final int	wf_Invisible = 1 << (1 - 1)
	Annotation flag of a widget: do not display non-standard annotation. More...
static final int	wf_Hidden = 1 << (2 - 1)
	Annotation flag of a widget: do not display or print or interact. More...
static final int	wf_Print = 1 << (3 - 1)
	Annotation flag of a widget: print the annotation. More...
static final int	wf_NoZoom = 1 << (4 - 1)
	Annotation flag of a widget: do not scale to match magnification. More...
static final int	wf_NoRotate = 1 << (5 - 1)
	Annotation flag of a widget: do not rotate to match page's rotation. More...
static final int	wf_NoView = 1 << (6 - 1)
	Annotation flag of a widget: do not display or interact. More...
static final int	wf_ReadOnly = 1 << (7 - 1)
	Annotation flag of a widget: do not interact. More...
static final int	wf_Locked = 1 << (8 - 1)
	Annotation flag of a widget: annotation cannot be deleted or modified, but its value can be changed. More...
static final int	wf_ToggleNoView = 1 << (9 - 1)
	Annotation flag of a widget: toggle wf_NoView for certain events. More...
static final int	wf_LockedContents = 1 << (10 - 1)
	Annotation flag of a widget: value cannot be changed. More...
static final int	j_none = 0
	Justification for text fields and list boxes: Justification does not apply (not a text field or a list box). More...
static final int	j_left = 1
	Justification for text fields and list boxes: Left-justified. More...
static final int	j_center = 2
	Justification for text fields and list boxes: Centered. More...
static final int	j_right = 3
	Justification for text fields and list boxes: Right-justified. More...
static final int	bos_other = 0
	Border style: Unknown/unsupported. More...
static final int	bos_solid = 1
	Border style: Solid rectangle. More...
static final int	bos_dashed = 2
	Border style: Dashed rectangle. More...
static final int	bos_beveled = 3
	Border style: Rectangle looking embossed. More...
static final int	bos_inset = 4
	Border style: Rectangle looking engraved. More...
static final int	bos_underline = 5
	Border style: Single line at bottom. More...
static final int	bus_default = 0
	Style used for check boxes and radio buttons: Default button style. More...
static final int	bus_other = 1
	Style used for check boxes and radio buttons: Unknown/unsupported. More...
static final int	bus_check_mark = 2
	Style used for check boxes and radio buttons: Check mark. More...
static final int	bus_cross = 3
	Style used for check boxes and radio buttons: Cross. More...
static final int	bus_star = 4
	Style used for check boxes and radio buttons: Star. More...
static final int	bus_circle = 5
	Style used for check boxes and radio buttons: Circle (default for radio buttons). More...
static final int	bus_square = 6
	Style used for check boxes and radio buttons: Square. More...
static final int	bus_diamond = 7
	Style used for check boxes and radio buttons: Diamond. More...
static final int	lt_na = 0
	Lock type: Not a signature field / don't change locking. More...
static final int	lt_none = 1
	Lock type: Don't lock any fields. More...
static final int	lt_all = 2
	Lock type: Lock all fields in the document. More...
static final int	lt_include = 3
	Lock type: Lock all fields specified by addLockField() etc. More...
static final int	lt_exclude = 4
	Lock type: Lock all fields except those specified by addLockField() etc. More...
static final int	st_not_a_signature_field = 0
	Signature type: The field is not a signature field. More...
static final int	st_not_signed = 1
	Signature type: The signature field is not signed. More...
static final int	st_approval = 2
	Signature type: Approval signature (that's the normal type of signature). More...
static final int	st_certification = 3
	Signature type: Certification signature (signed by the author). More...
static final int	st_document_time_stamp = 4
	Signature type: Document time stamp. More...
static final int	csvf_SubjectCert = 0x01
	Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags(). More...
static final int	csvf_IssuerCert = 0x02
	Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags(). More...
static final int	csvf_Policy = 0x04
	Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags(). More...
static final int	csvf_SubjectDN = 0x08
	Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags(). More...
static final int	csvf_KeyUsage = 0x20
	Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags(). More...
static final int	csvf_URL = 0x40
	Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags(). More...

Protected Member Functions
void	finalize () throws Throwable
	Finalize this object. More...

Detailed Description

Class representing one field of a document.

Calling methods of this class does not modify the document, use SignDocDocument.setField() to apply your changes to the document or SignDocDocument.addField() to add the field to the document.

In PDF documents, a field may have multiple visible "widgets". For instance, a radio button group (radio button field) usually has multiple visible buttons, ie, widgets.

A SignDocField object represents the logical field (containing the type, name, value, etc) as well as all its widgets. Each widget has a page number, a coordinate rectangle, and, for some field types, text field attributes.

Only one widget of the field is accessible at a time in a SignDocField object; use selectWidget() to select the widget to be operated on.

For radio button fields and check box fields, each widget also has a "button value". The button value should remain constant after the document has been created (but it can be changed if needed). The field proper has a value which is either "Off" or one of the button values of its widgets.

Each widget of a radio button field or a check box field is either off or on. If all widgets of a radio button field or a check box are off, the field's value is "Off". If at least one widget is on, the field's value is that widget's "button value". As the value of a field must be different for the on and off states of the field, the button values must not be "Off".

Check box fields usually have exactly one widget. If that widget's button value is, say, "On", the field's value is either "Off" (for the off state) or "On" (for the on state).

Check box fields can have multiple widgets. If all widgets have the same button value, say, "yes", the field's value is either "Off" (for the off state) or "yes" (for the on state). Clicking one widget of the check box field will toggle all widgets of that check box field.

Check box fields can have multiple widgets having different button values. If a check box field has two widgets with button values, say, "1" and "2", the field's value is either "Off" (for the off state), "1" (if the first widget is on) or "2" (if the second widget is on). The two widgets cannot be on at the same time.

If a check box field has three widgets with button values, say, "one, "two", and "two", respectively, the field's value is either "Off" (for the off state), "one" (if the first widget is on) or "two" (if the second and third widgets are on). The second and third widgets will always have the same state and that state will never be the same as the state of the first widget.

A radio button field usually has at least two widgets, having different button values. If a radio button field has two widgets with button values, say, "a" and "b", the field's value is either "Off" (for the off state), "a" (if the first widget is on), or "b" (if the second widget is on). Clicking the first widget puts the first widget into the on state and the second one into the off state (and vice versa).

Different widgets of a radio button field can have the same button value. The behavior for clicking a widget with non-unique button value depends on the f_RadiosInUnison field flag. If that flag is set (it usually is), widgets having the same button value always have the same on/off state. Clicking one of them will turn all of them on. If the f_RadiosInUnison is not set, clicking one widget will put all others (of the same radio button field) into the off state. See getValueIndex() for details.

Signature fields have exactly one widget. Fields of other types must have at least one widget.

Other fields such as text fields (except for signature fields) also can have multiple widgets, but all of them display the same value.

Signature fields in PDF documents are invisible if their width is zero or if their height is zero, that is, if the coordinates set by setLeft() and setRight() are equal or if the coordinates set by setBottom() and setTop()) are equal.

Constructor:

• SignDocField()

All fields have a type, a name, and flags:

• getType()
• setType()
• getName()
• setName()
• getFlags()
• setFlags()

Fields in PDF documents can have an alternate name which is used for displaying the field name in a user interface:

• getAlternateName()
• setAlternateName()

Moreover, fields in PDF documents can have a mapping name which is used for exporting field data:

• getMappingName()
• setMappingName()

Most fields in PDF documents can have one or more value:

• getValueCount()
• getValue()
• clearValues()
• addValue()
• setValue()
• removeValue()
• getValueIndex()
• setValueIndex()
• clickButton()
• getMaxLen()
• setMaxLen()

List boxes and combo boxes can have multiple possible choices:

• getChoiceCount()
• getChoiceValue()
• getChoiceExport()
• clearChoices()
• addChoice()
• setChoice()
• removeChoice()
• getTopIndex()
• setTopIndex()

Fields have one or more widget annotation:

• getWidgetCount()
• getWidget()
• selectWidget()
• addWidget()
• insertWidget()
• removeWidget()

Each widget annotation has a couple of flags:

• getWidgetFlags()
• setWidgetFlags()

Each widget annotation has a position on a page:

• getPage()
• setPage()
• getLeft()
• setLeft()
• getBottom()
• setBottom()
• getRight()
• setRight()
• getTop()
• setTop()
• getRotation()
• setRotation()

Radio button widgets and check box widgets have a button value (see above):

• getButtonValue()
• setButtonValue()

Text in a widget is controlled by these functions:

• getJustification()
• setJustification()
• getTextFieldAttributes()
• setTextFieldAttributes()

The background color of a widget can be set:

• getBackgroundColor()
• setBackgroundColor()

The border of a widget is controlled by these functions:

• getBorderColor()
• setBorderColor()
• getBorderWidth()
• setBorderWidth()
• getBorderStyle()
• setBorderStyle()

Radio button widgets and Check box widgets can display various symbols:

• getButtonStyle()
• setButtonStyle()

The following functions can be used for signature fields only:

• getDocMDP()
• getSignatureType()
• isCurrentlyClearable()
• isSigned()

Signing signature fields in a PDF document can automatically lock other fields:

• getLockType()
• setLockType()
• getLockFieldCount()
• getLockField()
• clearLockFields()
• addLockField()
• setLockField()
• removeLockField()
• getLockMDP()
• setLocKMDP()

Signature fields in a PDF document can have a signature field seed value dictionary controlling various aspects of signing. It can restrict the certificates that can be used for signing:

• getCertSeedValueFlags()
• setCertSeedValueFlags()

The certificate can be restricted by subject distinguished name:

• getCertSeedValueSubjectDNCount()
• getCertSeedValueSubjectDN()
• clearCertSeedValueSubjectDNs()
• addCertSeedValueSubjectDN()
• setCertSeedValueSubjectDN()
• setCertSeedValueSubjectDN()
• removeCertSeedValueSubjectDN()

The certificate can be restricted by specifying acceptable signing certificates:

• getCertSeedValueSubjectCertificateCount()
• getCertSeedValueSubjectCertificate()
• clearCertSeedValueSubjectCertificates()
• addCertSeedValueSubjectCertificate()
• setCertSeedValueSubjectCertificate()
• setCertSeedValueSubjectCertificate()
• removeCertSeedValueSubjectCertificate()

The certificate can be restricted by specifying acceptable issuer certificates:

• getCertSeedValueIssuerCertificateCount()
• getCertSeedValueIssuerCertificate()
• clearCertSeedValueIssuerCertificates()
• addCertSeedValueIssuerCertificate()
• setCertSeedValueIssuerCertificate()
• setCertSeedValueIssuerCertificate()
• removeCertSeedValueIssuerCertificate()

And the certificate can be restricted by policy:

• getCertSeedValuePolicyCount()
• getCertSeedValuePolicy()
• clearCertSeedValuePolicies()
• addCertSeedValuePolicy()
• setCertSeedValuePolicy()
• setCertSeedValuePolicy()
• removeCertSeedValuePolicy()

The signature field seed value dictionary can specify an RFC 3161 time-stamp server:

• getSeedValueTimeStampServerURL()
• getSeedValueTimeStampRequired()
• setSeedValueTimeStamp()

The signature field seed value dictionary can specify a signature handler (Filter):

• getSeedValueFilter()
• getSeedValueFilterRequired()
• setSeedValueFilter()

The signature field seed value dictionary can specify signing methods (SubFilter):

• getSeedValueSubFilterCount()
• getSeedValueSubFilter()
• getSeedValueSubFilterRequired()
• setSeedValueSubFilterRequired()
• clearSeedValueSubFilters()
• addSeedValueSubFilter()
• setSeedValueSubFilter()
• removeSeedValueSubFilter()

The signature field seed value dictionary can specify a hash algorithms (DigestMethod):

• getSeedValueDigestMethodCount()
• getSeedValueDigestMethod()
• getSeedValueDigestMethodRequired()
• setSeedValueDigestMethodRequired()
• clearSeedValueDigestMethods()
• addSeedValueDigestMethod()
• setSeedValueDigestMethod()
• removeSeedValueDigestMethod()

The signature field seed value dictionary can specify whether adding revocation to the signature is mandatory:

• getSeedValueAddRevInfo()
• setSeedValueAddRevInfo()

The signature field seed value dictionary can specify what changes shall be allowed after signing the signature field:

• getSeedValueMDP()
• setSeedValueMDP()

The color of an empty signature field in a TIFF document can be specified:

• getEmptyFieldColor()
• setEmptyFieldColor()

Constructor & Destructor Documentation

SignDocField

(

)

throws SignDocException

Constructor.

The new SignDocField object will have one widget.

Member Function Documentation

synchronized void addCertSeedValueIssuerCertificate

(

byte[]

aCert

)

throws SignDocException

Add an issuer certificate to the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aCert

The DER-encoded certificate.

See also

clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificate(), setCertSeedValueIssuerCertificate()

synchronized void addCertSeedValuePolicy

(

String

aOID

)

throws SignDocException

Add a policy OID to the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aOID

The policy OID.

See also

clearCertSeedValuePolicies(), getCertSeedValuePolicy(), setCertSeedValuePolicy()

synchronized void addCertSeedValueSubjectCertificate

(

byte[]

aCert

)

throws SignDocException

Add a subject certificate to the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aCert

The DER-encoded certificate.

See also

clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificate(), setCertSeedValueSubjectCertificate()

synchronized boolean addCertSeedValueSubjectDN

(

String

aName

)

throws SignDocException

Add a subject distinguished name to the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aName

The subject distinguished name formatted according to RFC 4514.

Returns

true if successful, false if aName cannot be parsed.

See also

clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDN(), setCertSeedValueSubjectDN()

synchronized void addChoice

(

String

aValue

)

throws SignDocException

Add a choice to a list box or combo box.

This function uses the choice value as export value.

Note

getValue() and setValue() use the export value.

Parameters

[in]

aValue

The choice value and export value to be added. Complex scripts are supported, see Complex Scripts.

See also

clearChoices(), getChoiceExport(), getChoiceValue(), setChoice(), setButtonValue()

synchronized void addChoice	(	String	aValue,
		String	aExport
	)		throws SignDocException

Add a choice to a list box or combo box.

Parameters

[in]	aValue	The choice value to be added.
[in]	aExport	The export value to be added.

See also

clearChoices(), getChoiceExport(), getChoiceValue(), setChoice(), setButtonValue()

synchronized void addLockField

(

String

aName

)

throws SignDocException

Add a lock field to the field.

Parameters

[in]

aName

The name of the lock field to be added.

See also

clearLockFields(), getLockField(), setLockField()

synchronized void addSeedValueDigestMethod

(

String

aDigestMethod

)

throws SignDocException

Add a DigestMethod value to the seed value dictionary.

See getSeedValueDigestMethod() for details.

Parameters

[in]

aDigestMethod

The DigestMethod value.

See also

clearSeedValueDigestMethods(), getSeedValueDigestMethod(), setSeedValueDigestMethod()

synchronized void addSeedValueSubFilter

(

String

aSubFilter

)

throws SignDocException

Add a SubFilter value to the seed value dictionary.

See getSeedValueSubFilter() for details.

Parameters

[in]

aSubFilter

The SubFilter value.

See also

clearSeedValueSubFilters(), getSeedValueSubFilter(), setSeedValueSubFilter()

synchronized void addValue

(

String

aValue

)

throws SignDocException

Add a value to the field.

Pushbutton fields and signature fields don't have a value, list boxes can have multiple values selected if f_MultiSelect is set.

Hard line breaks for multiline text fields (ie, text fields with flag f_MultiLine set) are encoded as "\r", "\n", or "\r\n". The behavior for values containing line breaks is undefined if the f_MultiLine flag is not set.

After calling this function, getValueIndex() will return -1.

Parameters

[in]

aValue

The value to be added. Complex scripts are supported, see Complex Scripts.

See also

clearValues(), getValue(), getValueIndex(), setValue()

synchronized boolean addWidget

(

)

throws SignDocException

Add a widget to the field.

The new widget will be added at the end, ie, calling getWidgetCount() before calling addWidget() yields the index of the widget that will be added.

After adding a widget, the new widget will be selected. You must set the page number and the coordinates in the new widget before calling SignDocDocument.addField() or SignDocDocument.setField().

Returns

true iff successful.

See also

addChoice(), getWidget(), getWidgetCount(), insertWidget(), removeWidget(), selectWidget()

synchronized void clearCertSeedValueIssuerCertificates

(

)

throws SignDocException

Remove all issuer certificates from the certificate seed value dictionary.

See the PDF Reference for details.

After calling this function, getCertSeedValueIssuerCertificateCount() will return 0.

See also

addCertSeedValueIssuerCertificate(), getCertSeedValueIssuerCertificateCount(), removeCertSeedValueIssuerCertificate()

synchronized void clearCertSeedValuePolicies

(

)

throws SignDocException

Remove all policy OIDs from the certificate seed value dictionary.

See the PDF Reference for details.

After calling this function, getCertSeedValuePolicyCount() will return 0.

See also

addCertSeedValuePolicy(), getCertSeedValuePolicyCount(), removeCertSeedValuePolicy()

synchronized void clearCertSeedValueSubjectCertificates

(

)

throws SignDocException

Remove all subject certificates from the certificate seed value dictionary.

See the PDF Reference for details.

After calling this function, getCertSeedValueSubjectCertificateCount() will return 0.

See also

addCertSeedValueSubjectCertificate(), getCertSeedValueSubjectCertificateCount(), removeCertSeedValueSubjectCertificate()

synchronized void clearCertSeedValueSubjectDNs

(

)

throws SignDocException

Remove all subject distinguished names from the certificate seed value dictionary.

See the PDF Reference for details.

After calling this function, getCertSeedValueSubjectDNCount() will return 0.

See also

addCertSeedValueSubjectDN(), getCertSeedValueSubjectDNCount(), removeCertSeedValueSubjectDN()

synchronized void clearChoices

(

)

throws SignDocException

Clear the choices of a list box or combo box.

After calling this function, getChoiceCount() will return 0.

See also

addChoice(), getChoiceCount(), removeChoice(), setButtonValue()

synchronized void clearLockFields

(

)

throws SignDocException

Clear the lock fields.

After calling this function, getLockFieldCount() will return 0.

See also

addLockField(), getLockFieldCount(), removeLockField()

synchronized void clearSeedValueDigestMethods

(

)

throws SignDocException

Remove all DigestMethod values from the seed value dictionary.

See getSeedValueDigestMethod() for details.

After calling this function, getSeedValueDigestMethodCount() will return 0.

See also

addSeedValueDigestMethod(), getSeedValueDigestMethodCount(), removeSeedValueDigestMethod()

synchronized void clearSeedValueSubFilters

(

)

throws SignDocException

Remove all SubFilter values from the seed value dictionary.

See getSeedValueSubFilter() for details.

After calling this function, getSeedValueSubFilterCount() will return 0.

See also

addSeedValueSubFilter(), getSeedValueSubFilterCount(), removeSeedValueSubFilter()

synchronized void clearValues

(

)

throws SignDocException

Clear the values.

After calling this function, getValueCount() will return 0 and getValueIndex() will return -1.

See also

addValue(), getValueCount(), getValueIndex(), removeValue()

synchronized boolean clickButton

(

int

aIndex

)

throws SignDocException

Click a check box or a radio button.

This function updates both the value (see setValue()) and the value index (see setValueIndex()) based on the current (non-committed) state of the SignDocField object (not looking at the state of the field in the document). It does nothing for other field types.

Adobe products seem to ignore f_NoToggleToOff flag being not set, this function behaves the same way (ie, as if f_NoToggleToOff was set).

Note

A return value of false does not indicate an error!

Parameters

[in]

aIndex

The 0-based index of the widget being clicked.

Returns

true if anything has been changed, false if nothing has been changed (wrong field type, aIndex out of range, radio button already active).

synchronized SignDocField clone

(

)

throws SignDocException

Clone this object.

Returns

A clone of this object.

synchronized void close

(

)

Destroy the underlying native object (for java.lang.AutoCloseable).

After calling this method, all methods but close() will throw SignDocUnexpectedErrorException.

void finalize ( ) throws Throwable

protected

Finalize this object.

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

synchronized String getAlternateName

(

)

throws SignDocException

Get the alternate name of the field.

The alternate name (if present) should be used for displaying the field name in a user interface. Currently, only PDF documents support alternate field names.

Returns

The alternate name of the field, empty if the field does not have an alternate name. If flag SignDocDocument.f_keep_escape_sequences is set, the string may contain escape sequences for selecting natural languages.

See also

getMappingName(), getName(), setAlternateName()

synchronized SignDocColor getBackgroundColor

(

)

throws SignDocException

Get the background color of the widget.

This function is available for fields of PDF documents only.

Returns

An object describing the background color or null if the widget does not have a background color (transparent background).

See also

getEmptyFieldColor(), selectWidget(), setBackgroundColor()

synchronized SignDocColor getBorderColor

(

)

throws SignDocException

Get the border color of the widget.

This function is available for fields of PDF documents only.

The border color is used only if the border width is positive.

Returns

An object describing the border color or null if the widget does not have a border color (transparent).

See also

getBorderWidth(), selectWidget(), setBorderColor()

synchronized int getBorderStyle

(

)

throws SignDocException

Get the border style.

This function is available for fields of PDF documents only.

Returns

The border style: bos_other, bos_solid, bos_dashed, bos_beveled, bos_inset, or bos_underline.

See also

selectWidget()

synchronized double getBorderWidth

(

)

throws SignDocException

Get the border width of the widget.

This function is available for fields of PDF documents only.

Returns

The border width of the widget.

See also

getBorderColor(), getBorderStyle(), selectWidget(), setBorderWidth()

synchronized double getBottom

(

)

throws SignDocException

Get the bottom coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems.

Returns

The bottom coordinate.

See also

getLeft(), getRight(), getTop(), selectWidget(), setBottom()

synchronized int getButtonStyle

(

)

throws SignDocException

Get the button style of a check box or radio button field.

This function is available for fields of PDF documents only.

Returns

The button style: bus_other, bus_check_mark, bus_cross, bus_star, bus_circle, bus_square, or bus_diamond.

See also

selectWidget(), setButtonStyle()

synchronized String getButtonValue

(

)

throws SignDocException

Get the button value of a widget of a radio button group or check box.

Usually, different radio buttons (widgets) of a radio button group (field) have different values. The radio button group has a value (returned by getValue()) which is either "Off" or one of those values. The individual buttons (widgets) of a check box field can also have different export values.

Different radio buttons (widgets) of a radio button group (field) can have the same value; in that case, the radio buttons are linked. The individual buttons of a check box field also can have the same value.

Returns

The button value an empty string (for field types that don't use button values). If flag SignDocDocument.f_keep_escape_sequences is set, the string may contain escape sequences for selecting natural languages.

See also

getButtonValueUTF8(), getChoiceExport(), getChoiceValue(), getValue(), setButtonValue()

synchronized int getCertSeedValueFlags

(

)

throws SignDocException

Get the certificate seed value dictionary flags (/SV/Cert/Ff) of a signature field.

The default value is 0.

Returns

The flags of the field.

See also

setCertSeedValueFlags()

csvf_SubjectCert, csvf_IssuerCert, csvf_Policy, csvf_SubjectDN, csvf_KeyUsage, csvf_URL

synchronized byte [] getCertSeedValueIssuerCertificate

(

int

aIndex

)

throws SignDocException

Get an issuer certificate of the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aIndex

0-based index of the issuer certificate.

Returns

The selected DER-encoded certificate or null if the index is out of range.

See also

addCertSeedValueIssuerCertificate(), clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificateCount(), removeCertSeedValueIssuerCertificate(), setCertSeedValueIssuerCertificate()

synchronized int getCertSeedValueIssuerCertificateCount

(

)

throws SignDocException

Get the number of issuer certificates in the certificate seed value dictionary.

See the PDF Reference for details.

Returns

The number of issuer certificates.

See also

addCertSeedValueIssuerCertificate(), clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificate(), removeCertSeedValueIssuerCertificate()

synchronized String getCertSeedValuePolicy

(

int

aIndex

)

throws SignDocException

Get a policy OID from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aIndex

0-based index of the policy OID.

Returns

The selected policy OID or an empty string if the index is out of range.

See also

addCertSeedValuePolicy(), clearCertSeedValuePolicies(), getCertSeedValuePolicyCount(), removeCertSeedValuePolicy(), setCertSeedValuePolicy()

synchronized int getCertSeedValuePolicyCount

(

)

throws SignDocException

Get the number of policy OIDs in the certificate seed value dictionary.

See the PDF Reference for details.

Returns

The number of policy OIDs.

See also

addCertSeedValuePolicy(), clearCertSeedValuePolicies(), getCertSeedValuePolicy(), removeCertSeedValuePolicy()

synchronized byte [] getCertSeedValueSubjectCertificate

(

int

aIndex

)

throws SignDocException

Get a subject certificate of the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aIndex

0-based index of the subject certificate.

Returns

The selected DER-encoded certificate or null if the index is out of range.

See also

addCertSeedValueSubjectCertificate(), clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificateCount(), removeCertSeedValueSubjectCertificate(), setCertSeedValueSubjectCertificate()

synchronized int getCertSeedValueSubjectCertificateCount

(

)

throws SignDocException

Get the number of subject certificates in the certificate seed value dictionary.

See the PDF Reference for details.

Returns

The number of subject certificates.

See also

addCertSeedValueSubjectCertificate(), clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificate(), removeCertSeedValueSubjectCertificate()

synchronized String getCertSeedValueSubjectDN

(

int

aIndex

)

throws SignDocException

Get a subject distinguished name from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aIndex

The 0-based index of the value to be retrieved.

Returns

The selected subject distinguished name (formatted according to RFC 4514) or an empty string if the index is out of range.

See also

addCertSeedValueSubjectDN(), clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDNCount(), removeCertSeedValueSubjectDN(), setCertSeedValueSubjectDN()

synchronized int getCertSeedValueSubjectDNCount

(

)

throws SignDocException

Get the number of subject distinguished names in the certificate seed value dictionary.

See the PDF Reference for details.

See also

addCertSeedValueSubjectDN(), clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDN(), removeCertSeedValueSubjectDN()

synchronized int getChoiceCount

(

)

throws SignDocException

Get the number of available choices for a list box or combo box.

List boxes and combo boxes can have multiple possible choices. For other field types, this function returns 0.

Returns

The number of available choices or 0 if not supported for the type of this field.

See also

getButtonValue(), getChoiceExport(), getChoiceValue(), getValueCount()

synchronized String getChoiceExport

(

int

aIndex

)

throws SignDocException

Get the export value for an available choice of a list box or combo box.

List boxes and combo boxes can have multiple possible choices. Each choice has a value (which will be displayed) and an export value (which is used for exporting the value of the field). Usually, both values are identical. This function returns one export value, use getChoiceValue() to get the associated choice value.

Note

getValue() and setValue() use the export value.

Parameters

[in]

aIndex

0-based index of the export value.

Returns

The selected export value of the field or an empty string if the index is out of range. If flag SignDocDocument.f_keep_escape_sequences is set, the string may contain escape sequences for selecting natural languages.

See also

addChoice(), clearChoices(), getButtonValue(), getChoiceCount(), getChoiceValue(), removeChoice(), setChoice()

synchronized String getChoiceValue

(

int

aIndex

)

throws SignDocException

Get an available choice of a list box or combo box.

List boxes and combo boxes can have multiple possible choices. Each choice has a value (which will be displayed) and an export value (which is used for exporting the value of the field). This function returns one choice value, use getChoiceExport() to get the associated export value.

Note

getValue() and setValue() use the export value.

Parameters

[in]

aIndex

0-based index of the choice value.

Returns

The selected choice value of the field or an empty string if the index is out of range. If flag SignDocDocument.f_keep_escape_sequences is set, the string may contain escape sequences for selecting natural languages.

See also

addChoice(), clearChoices(), getButtonValue(), getChoiceCount(), getChoiceExport(), removeChoice(), setChoice()

synchronized int getDocMDP

(

)

throws SignDocException

Get the DocMDP P value of a certification signature.

The DocMDP p value specifies what modifications to the document are allowed by the certification signature.

This function does not verify the certification signature.

Returns

-1 if this field is not a 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(), getSignatureType(), SignDocDocument.setShootInFoot(), SignDocVerificationResult.getDocMDP()

synchronized SignDocColor getEmptyFieldColor

(

)

throws SignDocException

Get the color used for empty signature field in TIFF document.

The default value is white.

Returns

The color used for empty signature field in TIFF document. The return value is not defined for other cases.

See also

getBackgroundColor(), setEmptyFieldColor()

synchronized int getFlags

(

)

throws SignDocException

Get the flags of the field.

The default value is 0 (f_Radio and f_Pushbutton will be computed from the field type).

Returns

The flags of the field.

See also

setFlags()

f_ReadOnly, f_Required, f_NoExport, f_NoToggleToOff, f_Radio, f_Pushbutton, f_RadiosInUnison, f_MultiLine, f_Password, f_FileSelect, f_DoNotSpellCheck, f_DoNotScroll, f_Comb, f_RichText, f_Combo, f_Edit, f_Sort, f_MultiSelect, f_CommitOnSelChange

synchronized int getJustification

(

)

throws SignDocException

Get the justification of the widget.

The default value is j_none.

Returns

The justification of the widget: j_left, j_center, or j_right for text fields and list boxes, j_none for other fields.

See also

selectWidget(), setJustification()

j_none, j_left, j_center, j_right

synchronized double getLeft

(

)

throws SignDocException

Get the left coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems.

Returns

The left coordinate.

See also

getBottom(), getRight(), getTop(), selectWidget(), setLeft()

synchronized String getLockField

(

int

aIndex

)

throws SignDocException

Get the name of a lock field.

Parameters

[in]

aIndex

0-based index of the lock field.

Returns

The name of the selected lock field or an empty string if the index is out of range. If flag SignDocDocument.f_keep_escape_sequences is set, the string may contain escape sequences for selecting natural languages.

See also

addLockField(), clearLockFields(), getLockFieldCount(), removeLockField(), setLockField()

synchronized int getLockFieldCount

(

)

throws SignDocException

Get the number of field names for lt_include and lt_exclude.

Returns

The number of field names.

See also

addLockField(), clearLockFields(), getLockField(), removeLockField()

synchronized int getLockMDP

(

)

throws SignDocException

Get the lock MDP value.

Returns

The lock MDP value: -1 if there is no 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.

See also

getDocMDP(), setLockMDP()

synchronized int getLockType

(

)

throws SignDocException

Get the lock type.

The lock type defines the fields to be locked when signing this signature field.

Returns

The lock type (lt_na, lt_none, lt_all, lt_include, or lt_exclude).

See also

getLockField(), setLockType()

synchronized String getMappingName

(

)

throws SignDocException

Get the mapping name of the field.

The mapping name (if present) should be used for exporting field data. Currently, only PDF documents support mapping field names.

Returns

The mapping name of the field, empty if the field does not have an mapping name. If flag SignDocDocument.f_keep_escape_sequences is set, the string may contain escape sequences for selecting natural languages.

See also

getAlternateName(), getName(), setMappingName()

synchronized int getMaxLen

(

)

throws SignDocException

Get maximum length of text field.

The default value is -1.

Returns

The maximum length of text fields or -1 if the field is not a text field or if the text field does not have a maximum length.

See also

setMaxLen()

synchronized String getName

(

)

throws SignDocException

Get the name of the field.

Returns

The name of the field. If flag SignDocDocument.f_keep_escape_sequences is set, the string may contain escape sequences for selecting natural languages.

See also

getAlternateName(), getMappingName(), setName()

synchronized int getPage

(

)

throws SignDocException

Get the page number.

This function returns the index of the page on which this field occurs (1 for the first page), or 0 if the page number is unknown.

Returns

The 1-based page number or 0 if the page number is unknown.

See also

selectWidget(), setPage()

synchronized double getRight

(

)

throws SignDocException

Get the right coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems. If coordinates are given in pixels (this is true for TIFF documents), this coordinate is exclusive.

Returns

The right coordinate.

See also

getBottom(), getLeft(), getTop(), selectWidget(), setRight()

synchronized int getRotation

(

)

throws SignDocException

Get the rotation of the widget contents.

The rotation is specified in degrees (counter-clockwise). The default value is 0.

For instance, if the rotation is 270, left-to right text will display top down.

Returns

The rotation of the widget: 0, 90, 180, or 270.

See also

selectWidget(), setJustification()

synchronized boolean getSeedValueAddRevInfo

(

)

throws SignDocException

Get the AddRevInfo flag from the signature field seed value dictionary.

If the AddRevInfo flag is set, revocation must be checked at signing time and revocation data must be included in the signature.

Returns

true if the AddRevInfo flag is set and the Ff entry specifies that AddRevInfo is a mandatory constraint. false otherwise.

See also

setSeedValueAddRevInfo()

synchronized String getSeedValueDigestMethod

(

int

aIndex

)

throws SignDocException

Get a DigestMethod value from the seed value dictionary.

DigestMethod values in the seed value dictionary restrict the hash algorithms available for signing with RSA.

Note that DigestMethod values are different from the message digest algorithms returned by SignDocVerificationResult.getDigestAlgorithm():

DigestMethod	getDigestAlgorithm()	DetachedHashAlgorithm
n/a	"MD5"	n/a
"RIPEMD160"	"RIPEMD-160"	"RIPEMD-160"
"SHA1"	"SHA-1"	"SHA-1"
-	"SHA-224"	"SHA-224"
"SHA256"	"SHA-256"	"SHA-256"
"SHA384"	"SHA-384"	"SHA-384"
"SHA512"	"SHA-512"	"SHA-512"

Parameters

[in]

aIndex

0-based index of the DigestMethod value.

Returns

The selected DigestMethod value or an empty string if the index is out of range.

See also

addSeedValueDigestMethod(), clearSeedValueDigestMethods(), getSeedValueDigestMethodCount(), getSeedValueDigestMethodRequired(), removeSeedValueDigestMethod(), setSeedValueDigestMethod()

synchronized int getSeedValueDigestMethodCount

(

)

throws SignDocException

Get the number of DigestMethod values in the seed value dictionary.

See getSeedValueDigestMethod() for details.

Returns

The number of DigestMethod values.

See also

addSeedValueDigestMethod(), clearSeedValueDigestMethods(), getSeedValueDigestMethod(), removeSeedValueDigestMethod()

synchronized boolean getSeedValueDigestMethodRequired

(

)

throws SignDocException

This function gets a flag from the signature field seed value dictionary that indicates whether the DigestMethod values are a required constraint or not.

If this function returns true, a signing method corresponding to one of the DigestMethod values returned by getSeedValueDigestMethod() must be used for signing.

Returns

true iff one of the DigestMethod values returned by getSeedValueDigestMethod() must be used.

See also

getSeedValueDigestMethodCount(), getSeedValueDigestMethod(), setSeedValueDigestMethodRequired()

synchronized String getSeedValueFilter

(

)

throws SignDocException

Get Filter entry (signature handler) from the signature field seed value dictionary.

Note

The Filter entry should be an ASCII string.

Returns

The Filter entry (signature handler) or an empty string if the signature field seed value dictionary does not have a Filter entry.

See also

getSeedValueFilterRequired(), setSeedValueFilter()

synchronized boolean getSeedValueFilterRequired

(

)

throws SignDocException

This function gets a flag from the signature field seed value dictionary that indicates whether the Filter entry (signature handler) is a required constraint or not.

If this function returns true, the signature handler returned by getSeedValueFilter() must be used for signing.

Note

Adobe Reader seems to ignore this flag.

Returns

true iff the signature handler returned by getSeedValueFilter() must be used.

See also

getSeedValueFilter()

synchronized int getSeedValueMDP

(

)

throws SignDocException

Get the MDP value from the signature field seed value dictionary.

Returns

-1 if the MDP value is not set, 0 for an approval signature, 1 through 3 for a certification signature:

• 1 no changes to the document shall be permitted
• 2 only filling in forms, instantiating page templates, and signing shall be permitted
• 3 only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations shall be permitted.

See also

setSeedValueMDP()

synchronized String getSeedValueSubFilter

(

int

aIndex

)

throws SignDocException

Get a SubFilter value from the seed value dictionary.

SubFilter values in the seed value dictionary restrict the signing methods available for signing. These values are currently defined:

• "adbe.x509.rsa_sha1" (SignDocSignatureParameters.m_digsig_pkcs1)
• "adbe.pkcs7.sha1" (SignDocSignatureParameters.m_digsig_pkcs7_sha1)
• "adbe.pkcs7.detached" (SignDocSignatureParameters.m_digsig_pkcs7_detached)
• "ETSI.CAdES.detached" (SignDocSignatureParameters.m_digsig_cades_detached)

Parameters

[in]

aIndex

0-based index of the SubFilter value.

Returns

The selected SubFilter value or an empty string if the index is out of range.

See also

addSeedValueSubFilter(), clearSeedValueSubFilters(), getSeedValueSubFilterCount(), getSeedValueSubFilterRequired(), removeSeedValueSubFilter(), setSeedValueSubFilter()

synchronized int getSeedValueSubFilterCount

(

)

throws SignDocException

Get the number of SubFilter values in the seed value dictionary.

See getSeedValueSubFilter() for details.

Returns

The number of SubFilter values.

See also

addSeedValueSubFilter(), clearSeedValueSubFilters(), getSeedValueSubFilter(), removeSeedValueSubFilter()

synchronized boolean getSeedValueSubFilterRequired

(

)

throws SignDocException

This function gets a flag from the signature field seed value dictionary that indicates whether the SubFilter values are a required constraint or not.

If this function returns true, a signing method corresponding to one of the SubFilter values returned by getSeedValueSubFilter() must be used for signing.

Returns

true iff one of the SubFilter values returned by getSeedValueSubFilter() must be used.

See also

getSeedValueSubFilterCount(), getSeedValueSubFilter(), setSeedValueSubFilterRequired()

synchronized boolean getSeedValueTimeStampRequired

(

)

throws SignDocException

This function gets a flag from the signature field seed value dictionary that indicates whether a time stamp is required or not for the signature.

If this function returns true, the URL returned by getSeedValueTimeStampServerURL() will be used to add a time stamp to the signature when signing.

Returns

false if a time stamp is not required, true if a time stamp is required.

See also

getSeedValueTimeStampServerURL()

synchronized String getSeedValueTimeStampServerURL

(

)

throws SignDocException

Get the URL of the RFC 3161 time-stamp server from the signature field seed value dictionary.

Note

The URL should be an ASCII string.

Returns

The URL of the time-stamp server or an empty string if no time-stamp server is defined.

See also

getSeedValueTimeStampRequired(), setSeedValueTimeStamp()

synchronized int getSignatureType

(

)

throws SignDocException

Get the signature type of a signature field.

For TIFF documents, only approval signatures are available.

For st_certification, you should display "certified by ..." rather than "signed by ...".

Returns

The signature type: st_not_a_signature_field, st_not_signed, st_approval, st_certification, or st_document_time_stamp.

See also

isSigned()

synchronized SignDocTextFieldAttributes getTextFieldAttributes

(

)

throws SignDocException

Get the text field attributes of the widget.

This function returns null if the field uses the document's default font name for fields.

Text fields, signature fields, list boxes, and combo boxes can have text field attributes.

Returns

A SignDocTextFieldAttributes object if successful, null on error.

See also

selectWidget(), setTextFieldAttributes(), SignDocDocument.getTextFieldAttributes()

synchronized double getTop

(

)

throws SignDocException

Get the top coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems. If coordinates are given in pixels (this is true for TIFF documents), this coordinate is exclusive.

Returns

The top coordinate.

See also

getBottom(), getLeft(), getRight(), selectWidget(), setTop()

synchronized int getTopIndex

(

)

throws SignDocException

Get the index of the choice to be displayed in the first line of a list box.

The default value is 0.

Returns

The index of the choice to be displayed in the first line of a list box or 0 for other field types.

See also

getChoiceValue(), setTopIndex()

synchronized int getType

(

)

throws SignDocException

Get the type of the field.

Returns

The type of the field.

See also

setType()

t_unknown, t_pushbutton, t_check_box, t_radio_button, t_text, t_list_box, t_combo_box, t_signature_digsig, t_signature_signdoc

synchronized String getValue

(

int

aIndex

)

throws SignDocException

Get a value of the field.

Pushbutton fields and signature fields don't have a value, list boxes can have multiple values selected if f_MultiSelect is set.

Hard line breaks for multiline text fields (ie, text fields with flag f_MultiLine set) are encoded as "\r", "\n", or "\r\n".

Parameters

[in]

aIndex

0-based index of the value.

Returns

The selected value of the field or an empty string if the index is out of range. If flag SignDocDocument.f_keep_escape_sequences is set, the string may contain escape sequences for selecting natural languages.

See also

addValue(), clearValues(), getChoiceValue(), getValueCount(), getValueIndex(), removeValue(), setValue()

synchronized int getValueCount

(

)

throws SignDocException

Get the number of values of the field.

Pushbutton fields and signature fields don't have a value, list boxes can have multiple values selected if f_MultiSelect is set.

Returns

The number of values.

See also

getChoiceCount(), getValue()

synchronized int getValueIndex

(

)

throws SignDocException

Get the current value index.

Radio button groups and check box fields can have multiple widgets having the same button value. For check box fields and radio buttons without f_RadiosInUnison set, specifying the selected button by value string is not possible in that case. A 0-based value index can be used to find out which button is selected or to select a button.

Radio button groups and check box fields need not use a value index; in fact, they usually don't.

SignDocDocument.addField() and SignDocDocument.setField() update the value index if the value of a radio button group or check box field is selected by string (ie, setValue()) and the field has ambiguous button names.

The "Off" value never has a value index.

Note

addValue(), clearValues(), and setValue() make the value index unset (ie, getValueIndex() will return -1).

Returns

the 0-based value index or -1 if the value index is not set.

See also

clickButton(), getValue(), setValueIndex()

synchronized int getWidget

(

)

throws SignDocException

Get the index of the currently selected widget.

Initially, the first widget is selected (ie, this function returns 0). However, there is an exception to this rule: SignDocField objects created by SignDocDocument.getFieldsOfPage() can have a different widget selected initially for PDF documents.

Returns

The 0-based index of the currently selected widget.

See also

selectWidget()

synchronized int getWidgetCount

(

)

throws SignDocException

Get the number of widgets.

Signature fields always have exactly one widget. Radio button fields (radio button groups) usually have one widget per button (but can have more widgets than buttons by having multiple widgets for some or all buttons).

Returns

The number of widgets for this field.

synchronized int getWidgetFlags

(

)

throws SignDocException

Get the annotation flags of the widget, see wf_Invisible.

The default value is wf_Print. The annotation flags are used for PDF documents only. Currently, the semantics of the annotation flags are ignored by this software (ie, the flags are stored in the document, but they don't have any meaning to this software).

Returns

The annotation flags of the widget.

See also

selectWidget(), setWidgetFlags()

synchronized boolean insertWidget

(

int

aIndex

)

throws SignDocException

Add a widget to the field in front of another widget.

The new widget will be inserted at the specified index, ie, the index of the new widget will be aIndex.

After adding a widget, the new widget will be selected. You must set the page number and the coordinates in the new widget before calling SignDocDocument.addField() or SignDocDocument.setField().

Parameters

[in]

aIndex

0-based index of the widget in front of which the new widget shall be inserted. You can pass the current number of widgets as returned by getWidgetCount() to add the new widget to the end as addWidget() does.

Returns

true iff successful.

See also

addWidget(), getWidget(), getWidgetCount(), removeWidget(), selectWidget(), setValueIndex

synchronized boolean isCurrentlyClearable

(

)

throws SignDocException

Check if this signature field is currently clearable.

For some document formats (TIFF), signatures may only be cleared in the reverse order of signing (LIFO). Use this function to find out whether the signature field is currently clearable (as determined by SignDocDocument.getField() or SignDocDocument.getFields(),

Note

The value returned by this function does not change over the lifetime of this object and therefore may not reflect the current state if signature fields have been signed or cleared since this object was created.

Returns

true iff this is a signature field that can be cleared now.

See also

SignDocDocument.getField(), SignDocDocument.getFields()

synchronized boolean isSigned

(

)

throws SignDocException

Check if this field is a signed signature field.

This function is much more efficient than SignDocDocument.verifySignature().

Returns

true if this field is a signed signature field, false if this field is not a signature field or if this field is a signature field that is not signed.

See also

getSignatureType(), SignDocDocument.verifySignature()

synchronized boolean removeCertSeedValueIssuerCertificate

(

int

aIndex

)

throws SignDocException

Remove an issuer certificate from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aIndex

The 0-based index of the issuer certificate to be removed.

Returns

true if successful, false if aIndex is out of range.

See also

clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificate()

synchronized boolean removeCertSeedValuePolicy

(

int

aIndex

)

throws SignDocException

Remove a policy OID from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aIndex

The 0-based index of the policy OID to be removed.

Returns

true if successful, false if aIndex is out of range.

See also

clearCertSeedValuePolicies(), getCertSeedValuePolicy()

synchronized boolean removeCertSeedValueSubjectCertificate

(

int

aIndex

)

throws SignDocException

Remove a subject certificate from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aIndex

The 0-based index of the subject certificate to be removed.

Returns

true if successful, false if aIndex is out of range.

See also

clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificate()

synchronized boolean removeCertSeedValueSubjectDN

(

int

aIndex

)

throws SignDocException

Remove a subject distinguished name from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]

aIndex

The 0-based index of the value to be removed.

Returns

true if successful, false if aIndex is out of range.

See also

clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDN()

synchronized boolean removeChoice

(

int

aIndex

)

throws SignDocException

Remove a choice from a list box or combo box.

Parameters

[in]

aIndex

The 0-based index of the choice to be removed.

Returns

true if successful, false if aIndex is out of range.

See also

addChoice(), clearChoices()

synchronized boolean removeLockField

(

int

aIndex

)

throws SignDocException

Remove a lock field.

Parameters

[in]

aIndex

The 0-based index of the lock field to be removed.

Returns

true if successful, false if aIndex is out of range.

See also

clearLockFields(), getLockField()

synchronized boolean removeSeedValueDigestMethod

(

int

aIndex

)

throws SignDocException

Remove a DigestMethod value from the seed value dictionary.

See getSeedValueDigestMethod() for details.

Parameters

[in]

aIndex

The 0-based index of the DigestMethod value to be removed.

Returns

true if successful, false if aIndex is out of range.

See also

clearSeedValueDigestMethods(), getSeedValueDigestMethod()

synchronized boolean removeSeedValueSubFilter

(

int

aIndex

)

throws SignDocException

Remove a SubFilter value from the seed value dictionary.

See getSeedValueSubFilter() for details.

Parameters

[in]

aIndex

The 0-based index of the SubFilter value to be removed.

Returns

true if successful, false if aIndex is out of range.

See also

clearSeedValueSubFilters(), getSeedValueSubFilter()

synchronized boolean removeValue

(

int

aIndex

)

throws SignDocException

Remove a value from the field.

After calling this function, getValueIndex() will return -1.

Parameters

[in]

aIndex

The 0-based index of the value to be removed.

Returns

true if successful, false if aIndex is out of range.

See also

clearValues(), getValue(), getValueIndex()

synchronized boolean removeWidget

(

int

aIndex

)

throws SignDocException

Remove a widget from the field.

This function fails when there is only one widget. That is, a field always has at least one widget.

If the currently selected widget is removed, the following rules apply:

• When removing the last widget (the one with index getWidgetCount()-1), the predecessor of the removed widget will be selected.
• Otherwise, the index of the selected widget won't change, ie, the successor of the removed widget will be selected.

If the widget to be removed is not selected, the currently selected widget will remain selected.

All widgets having an index greater than aIndex will have their index decremented by one.

Parameters

[in]

aIndex

0-based index of the widget to remove.

Returns

true iff successful.

See also

addWidget(), getWidget(), getWidgetCount(), insertWidget(), selectWidget(), setValueIndex

synchronized boolean selectWidget

(

int

aIndex

)

throws SignDocException

Select a widget.

This function selects the widget to be used by getWidgetFlags(), getPage(), getLeft(), getBottom(), getRight(), getTop(), getButtonValue(), getJustification(), getRotation(), getTextFieldAttributes(), getBackgroundColor(), getBorderColor(), getBorderWidth(), getBorderStyle(), getButtonStyle(), setWidgetFlags(), setPage(), setLeft(), setBottom(), setRight(), setTop(), setButtonValue(), setJustification(), setRotation(), setTextFieldAttributes(), setBackgroundColor(), setBorderColor(), setBorderWidth(), setBorderStyle(), and setButtonStyle().

Parameters

[in]

aIndex

0-based index of the widget.

Returns

true iff successful.

See also

clickButton(), getWidgetCount()

synchronized void setAlternateName

(

String

aName

)

throws SignDocException

Set the alternate name of the field.

The alternate name (if present) should be used for displaying the field name in a user interface. Currently, only PDF documents support alternate field names.

Parameters

[in]

aName

The alternate name of the field, empty to remove any alternate field name. Use SignDocDocument.withEscapeSequence() to add a language code. See SignDocDocument.f_require_alternate_field_name for details.

See also

getAlternateName(), getName(), setMappingName(), setName(), SignDocDocument.withEscapeSequence(), SignDocDocument.f_require_alternate_field_name

synchronized void setBackgroundColor

(

SignDocColor

aColor

)

throws SignDocException

Set the background color of the widget.

This function is available for fields of PDF documents only.

The initial value is null (transparent).

Parameters

[in]

aColor

null for transparent or a SignDocColor object representing the new background color.

See also

getBackgroundColor(), selectWidget(), setEmptyFieldColor()

synchronized void setBorderColor

(

SignDocColor

aColor

)

throws SignDocException

Set the border color of the widget.

This function is available for fields of PDF documents only.

The border color is used only if the border width is positive.

For combo boxes, check boxes, and radio buttons, the initial value is black, for other field types, the initial value is transparent. After creation of a SignDocField object, calling setType() will set the border color accordingly. Once setBorderColor() has been called, setType() will no longer affect the border color.

Parameters

[in]

aColor

null for transparent or a SignDocColor object representing the new border color.

See also

getBorderColor(), selectWidget(), setBorderWidth(), setType()

synchronized void setBorderStyle

(

int

aStyle

)

throws SignDocException

Set the border style.

This function is available for fields of PDF documents only.

If aStyle is bos_other, SignDocDocument.setField() will keep the current border style and SignDocDocument.addField() will fail.

Parameters

[in]

aStyle

The new border style: bos_other, bos_solid, bos_dashed, bos_beveled, bos_inset, or bos_underline.

See also

selectWidget(), getBorderStyle()

synchronized void setBorderWidth

(

double

aWidth

)

throws SignDocException

Set the border width of the widget.

This function is available for fields of PDF documents only.

The initial value is 1.

Parameters

[in]

aWidth

The new border width.

See also

getBorderWidth(), selectWidget(), setBorderColor(), setBorderStyle()

synchronized void setBottom

(

double

aBottom

)

throws SignDocException

Set the bottom coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems.

Parameters

[in]

aBottom

The bottom coordinate.

See also

getBottom(), selectWidget(), setLeft(), setRight(), setTop(), SignDocDocument.sff_move

synchronized void setButtonStyle

(

int

aStyle

)

throws SignDocException

Set the button style of a check box or radio button field.

This function is available for fields of PDF documents only.

If aStyle is bus_other, SignDocDocument.setField() will keep the current border style and SignDocDocument.addField() will fail.

Parameters

[in]

aStyle

The new button style: bus_default, bus_other, bus_check_mark, bus_cross, bus_star, bus_circle, bus_square, or bus_diamond.

See also

getButtonStyle(), selectWidget()

synchronized void setButtonValue

(

String

aValue

)

throws SignDocException

Set the button value of a widget of a radio button group or a check box.

Usually, different radio buttons (widgets) of a radio button group (field) have different values. The radio button group has a value (returned by getValue()) which is either "Off" or one of those values. The individual buttons (widgets) of a check box field can also have different export values.

Different radio buttons (widgets) of a radio button group (field) can have the same value; in that case, the radio buttons are linked. The individual buttons of a check box field also can have the same value.

SignDocDocument.addField() and SignDocDocument.setField() ignore the value set by this function if the field is neither a radio button group nor a check box field.

Parameters

[in]

aValue

The value to be set. Must not be empty, must not be "Off".

See also

getButtonValue(), getChoiceExport(), getChoiceValue(), getValue()

synchronized void setCertSeedValueFlags

(

int

aFlags

)

throws SignDocException

Set the certificate seed value dictionary flags (/SV/Cert/Ff) of a signature field.

The default value is 0.

Parameters

[in]

aFlags

The certificate seed value dicitionary flags of the field.

See also

getCertSeedValueFlags()

csvf_SubjectCert, csvf_IssuerCert, csvf_Policy, csvf_SubjectDN, csvf_KeyUsage, csvf_URL

synchronized boolean setCertSeedValueIssuerCertificate	(	int	aIndex,
		byte[]	aCert
	)		throws SignDocException

Set an issuer certificate in the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]	aIndex	The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]	aCert	The DER-encoded certificate.

Returns

true if successful, false if aIndex is out of range or if aCert cannot be parsed.

See also

clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificate()

synchronized void setCertSeedValueIssuerCertificate

(

byte[]

aCert

)

throws SignDocException

Set an issuer certificate in the certificate seed value dictionary.

See the PDF Reference for details.

Calling this function is equivalent to calling clearCertSeedValueIssuerCertificates() and addCertSeedValueIssuerCertificate().

Parameters

[in]

aCert

The DER-encoded certificate.

See also

clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificate()

synchronized boolean setCertSeedValuePolicy	(	int	aIndex,
		String	aOID
	)		throws SignDocException

Set a policy OID in the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]	aIndex	The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]	aOID	The policy OID.

Returns

true if successful, false if aIndex is out of range or if aOID cannot be parsed.

See also

clearCertSeedValuePolicies(), getCertSeedValuePolicy()

synchronized void setCertSeedValuePolicy

(

String

aOID

)

throws SignDocException

Set a policy OID in the certificate seed value dictionary.

See the PDF Reference for details.

Calling this function is equivalent to calling clearCertSeedValuePolicies() and addCertSeedValuePolicy().

Parameters

[in]

aOID

The policy OID.

See also

clearCertSeedValuePolicies(), getCertSeedValuePolicy()

synchronized boolean setCertSeedValueSubjectCertificate	(	int	aIndex,
		byte[]	aCert
	)		throws SignDocException

Set a subject certificate in the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]	aIndex	The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]	aCert	The DER-encoded certificate.

Returns

true if successful, false if aIndex is out of range or if aCert cannot be parsed.

See also

clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificate()

synchronized void setCertSeedValueSubjectCertificate

(

byte[]

aCert

)

throws SignDocException

Set a subject certificate in the certificate seed value dictionary.

See the PDF Reference for details.

Calling this function is equivalent to calling clearCertSeedValueSubjectCertificates() and addCertSeedValueSubjectCertificate().

Parameters

[in]

aCert

The DER-encoded certificate.

See also

clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificate()

synchronized boolean setCertSeedValueSubjectDN	(	int	aIndex,
		String	aName
	)		throws SignDocException

Set a subject distinguished name in the certificate seed value dictionary.

See the PDF Reference for details.

Parameters

[in]	aIndex	The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]	aName	The subject distinguished name formatted according to RFC 4514.

Returns

true if successful, false if aIndex is out of range or if aName cannot be parsed.

See also

clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDN()

synchronized boolean setCertSeedValueSubjectDN

(

String

aName

)

throws SignDocException

Set a subject distinguished name in the certificate seed value dictionary.

See the PDF Reference for details.

Calling this function is equivalent to calling clearCertSeedValueSubjectDNs() and addCertSeedValueSubjectDN().

Parameters

[in]

aName

The subject distinguished name formatted according to RFC 4514.

Returns

true if successful, false if aName cannot be parsed.

See also

clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDN()

synchronized boolean setChoice	(	int	aIndex,
		String	aValue
	)		throws SignDocException

Set a choice value of a list box or combo box.

This function uses the choice value as export value.

Note

getValue() and setValue() use the export value.

Parameters

[in]	aIndex	The 0-based index of the choice to be set. If aIndex equals the current number of choices, the value will be added.
[in]	aValue	The choice value and export value to be set. Complex scripts are supported, see Complex Scripts.

Returns

true if successful, false if aIndex is out of range.

See also

clearChoices(), getChoiceExport(), getChoiceValue(), setButtonValue()

synchronized boolean setChoice	(	int	aIndex,
		String	aValue,
		String	aExport
	)		throws SignDocException

Set a choice value of a list box or combo box.

Note

getValue() and setValue() use the export value.

Parameters

[in]	aIndex	The 0-based index of the choice to be set. If aIndex equals the current number of choices, the value will be added.
[in]	aValue	The choice value to be set. Complex scripts are supported, see Complex Scripts.
[in]	aExport	The export value to be set.

Returns

true if successful, false if aIndex is out of range.

See also

clearChoices(), getChoiceExport(), getChoiceValue(), setButtonValue()

synchronized void setEmptyFieldColor

(

SignDocColor

aColor

)

throws SignDocException

Set color used for empty signature field in TIFF document.

The default value is white. For non-TIFF documents, the value set by this function is ignored. The value is also ignored if compatibility with version 1.12 and earlier is requested.

Parameters

[in]

aColor

The new color.

See also

getEmptyFieldColor(), setBackgroundColor(), SignDocDocument.setCompatibility()

synchronized void setFlags

(

int

aFlags

)

throws SignDocException

Set the flags of the field.

The default value is 0 (f_Radio and f_Pushbutton will be computed from the field type).

Do not set f_ReadOnly yourself to lock a field before or after signing. Instead, use setLockType() when adding the signature field.

Parameters

[in]

aFlags

The flags of the field.

See also

getFlags()

f_ReadOnly, f_Required, f_NoExport, f_NoToggleToOff, f_Radio, f_Pushbutton, f_RadiosInUnison, f_MultiLine, f_Password, f_FileSelect, f_DoNotSpellCheck, f_DoNotScroll, f_Comb, f_RichText, f_Combo, f_Edit, f_Sort, f_MultiSelect, f_CommitOnSelChange

synchronized void setJustification

(

int

aJustification

)

throws SignDocException

Set the justification of the widget.

The default value is j_none.

For text fields and list boxes, the justification must be j_left, j_center, or j_right. For other fields, the justification must be j_none.

Parameters

[in]

aJustification

The justification.

See also

getJustification(), selectWidget()

j_none, j_left, j_center, j_right

synchronized void setLeft

(

double

aLeft

)

throws SignDocException

Set the left coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems.

Parameters

[in]

aLeft

The left coordinate.

See also

getLeft(), selectWidget(), setBottom(), setRight(), setTop(), SignDocDocument.sff_move

synchronized boolean setLockField	(	int	aIndex,
		String	aName
	)		throws SignDocException

Set a lock field.

Parameters

[in]	aIndex	The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]	aName	The name of the lock field to be set.

Returns

true if successful, false if aIndex is out of range.

See also

clearLockFields(), getLockField()

synchronized void setLockField

(

String

aName

)

throws SignDocException

Set a lock field.

Calling this function is equivalent to calling clearLockFields() and addLockField().

Parameters

[in]

aName

The name of the lock field to be set.

See also

clearLockFields(), getLockField()

synchronized void setLockMDP

(

int

aMDP

)

throws SignDocException

Set the lock MDP value.

Parameters

[in]

aMDP

The new lock MDP value: 1 no changes to the document shall be permitted 2 only filling in forms, instantiating page templates, and signing shall be permitted 3 only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations shall be permitted.

See also

getDocMDP(), getLockMDP()

synchronized void setLockType

(

int

aLockType

)

throws SignDocException

Set the lock type.

The lock type defines the fields to be locked when signing this signature field.

Parameters

[in]

aLockType

The new lock type (lt_none, lt_all, lt_include, or lt_exclude).

See also

addLockField(), getLockType()

lt_na, lt_none, lt_all, lt_include, lt_exclude

synchronized void setMappingName

(

String

aName

)

throws SignDocException

Set the mapping name of the field.

The mapping name (if present) should be used for exporting field data. Currently, only PDF documents support mapping field names.

Parameters

[in]

aName

The mapping name of the field, empty to remove any mapping name.

See also

getMappingName(), getName(), setAlternateName(), setName()

synchronized void setMaxLen

(

int

aMaxLen

)

throws SignDocException

Set maximum length of text fields.

Parameters

[in]

aMaxLen

The maximum length (in characters) of the text field or -1 for no maximum length.

See also

getMaxLen()

synchronized void setName

(

String

aName

)

throws SignDocException

Set the name of the field.

Different document types impose different restrictions on field names. PDF fields have hierarchical field names with components separated by dots.

SignDocDocument.setField() operates on the field having a fully-qualified name which equals the name set by this function. In consequence, SignDocDocument.setField() cannot change the name of a field.

Parameters

[in]

aName

The name of the field.

See also

getName(), setAlternateName(), setMappingName()

synchronized void setPage

(

int

aPage

)

throws SignDocException

Set the page number.

This function sets the index of the page on which this field occurs (1 for the first page).

By calling SignDocDocument.getField(), setPage(), and SignDocDocument.setField(), you can move a field's widget to another page.

Parameters

[in]

aPage

The 1-based page number of the field.

See also

getPage(), selectWidget()

synchronized void setRight

(

double

aRight

)

throws SignDocException

Set the right coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems. If coordinates are given in pixels (this is true for TIFF documents), this coordinate is exclusive.

Parameters

[in]

aRight

The right coordinate.

See also

getRight(), selectWidget(), setBottom(), setLeft(), setTop(), SignDocDocument.sff_move

synchronized void setRotation

(

int

aRotation

)

throws SignDocException

Set the rotation of the widget contents.

The rotation is specified in degrees (counter-clockwise). The default value is 0.

For instance, if the rotation is 270, left-to right text will display top down.

Currently, the rotation must always be 0 for TIFF documents.

Parameters

[in]

aRotation

The rotation: 0, 90, 180, or 270.

See also

getRotation(), selectWidget()

synchronized void setSeedValueAddRevInfo

(

boolean

aAddRevInfo

)

throws SignDocException

Set the AddRevInfo flag in the signature field seed value dictionary.

This function sets both the AddRevInfo flag and the flag specifying that AddRevInfo is mandatory. (Both flags are set to the same value, that is, you cannot set AddRevInfo as optional constraint.)

If the AddRevInfo flag is set, revocation must be checked at signing time and revocation data must be included in the signature.

Parameters

[in]

aAddRevInfo

The new AddRevInfo flag value.

See also

getSeedValueAddRevInfo()

synchronized boolean setSeedValueDigestMethod	(	int	aIndex,
		String	aDigestMethod
	)		throws SignDocException

Set a DigestMethod value in the seed value dictionary.

See getSeedValueDigestMethod() for details.

Parameters

[in]	aIndex	The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]	aDigestMethod	The DigestMethod value.

Returns

true if successful, false if aIndex is out of range.

See also

clearSeedValueDigestMethods(), getSeedValueDigestMethod()

synchronized void setSeedValueDigestMethod

(

String

aDigestMethod

)

throws SignDocException

Set a DigestMethod value in the seed value dictionary.

See getSeedValueDigestMethod() for details.

Calling this function is equivalent to calling clearSeedValueDigestMethods() and addSeedValueDigestMethod().

Parameters

[in]

aDigestMethod

The DigestMethod value.

See also

clearSeedValueDigestMethods(), getSeedValueDigestMethod()

synchronized void setSeedValueDigestMethodRequired

(

boolean

aRequired

)

throws SignDocException

Set a flag from the signature field seed value dictionary that indicates whether the DigestMethod values are a required constraint or not.

Parameters

[in]

aRequired

true if the DigestMethod values are a required constraint, false if the DigestMethod values are an optional constraint. If aRequired is true, there should be at least one DigestMethod value.

See also

getSeedValueDigestMethod(), getSeedValueDigestMethodRequired()

synchronized boolean setSeedValueFilter	(	String	aFilter,
		boolean	aRequired
	)		throws SignDocException

Set the Filter entry (signature handler) in the signature field seed value dictionary.

Parameters

[in]	aFilter	The name of the signature handler to be used for signing, e.g., "Adobe.PPKLite". An empty value will cause the Filter entry (constraint) to be removed. This should be an ASCII string.
[in]	aRequired	true if aFilter is a required constraint, false if aFilter is an optional constraint. Adobe Reader seems to ignore this flag.

Returns

true if successful, false if aFilter is invalid.

See also

getSeedValueFilter(), getSeedValueFilterRequired()

synchronized boolean setSeedValueMDP

(

int

aMDP

)

throws SignDocException

Set the MDP value in the signature field seed value dictionary.

Parameters

[in]

aMDP

The new MDP value: -1 to remove the MDP value 0 for an approval signature 1 for a certification signature, no changes to the document shall be permitted 2 for a certification signature, only filling in forms, instantiating page templates, and signing shall be permitted 3 for a certification signature, only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations shall be permitted.

Returns

true if successful, false if aMDP is invalid.

See also

getSeedValueMDP()

synchronized boolean setSeedValueSubFilter	(	int	aIndex,
		String	aSubFilter
	)		throws SignDocException

Set a SubFilter value in the seed value dictionary.

See getSeedValueSubFilter() for details.

Parameters

[in]	aIndex	The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]	aSubFilter	The SubFilter value.

Returns

true if successful, false if aIndex is out of range.

See also

clearSeedValueSubFilters(), getSeedValueSubFilter()

synchronized void setSeedValueSubFilter

(

String

aSubFilter

)

throws SignDocException

Set a SubFilter value in the seed value dictionary.

See getSeedValueSubFilter() for details.

Calling this function is equivalent to calling clearSeedValueSubFilters() and addSeedValueSubFilter().

Parameters

[in]

aSubFilter

The SubFilter value.

See also

clearSeedValueSubFilters(), getSeedValueSubFilter()

synchronized void setSeedValueSubFilterRequired

(

boolean

aRequired

)

throws SignDocException

Set a flag from the signature field seed value dictionary that indicates whether the SubFilter values are a required constraint or not.

Parameters

[in]

aRequired

true if the SubFilter values are a required constraint, false if the SubFilter values are an optional constraint. If aRequired is true, there should be at least one SubFilter value.

See also

getSeedValueSubFilter(), getSeedValueSubFilterRequired()

synchronized boolean setSeedValueTimeStamp	(	String	aURL,
		boolean	aRequired
	)		throws SignDocException

Set the URL of an RFC 3161 time-stamp server in the signature field seed value dictionary.

Note

URLs must be ASCII strings.

Parameters

[in]	aURL	The URL (must be ASCII), empty for no time-stamp server. Must be non-empty if aRequired is true. The scheme must be http or https.
[in]	aRequired	true if a time stamp is required, false if a time stamp is not required.

Returns

true if successful, false if aURL is invalid.

See also

getSeedValueTimeStampRequired(), getSeedValueTimeStampServerURL()

synchronized boolean setTextFieldAttributes

(

SignDocTextFieldAttributes

aInput

)

throws SignDocException

Set the text field attributes of the widget.

Font name and font size must be specified. The text color is optional. This function fails if any of the attributes of aInput are invalid.

Text field attributes can be specified for text fields, signature fields, list boxes, and combo boxes.

If SignDocTextFieldAttributes.isSet() returns false for aInput, the text field attributes of the field will be removed by SignDocDocument.setField().

The following rules apply if the field does not have text field attributes:

• If the field inherits text field attributes from a ancestor field, those will be used by PDF processing software.
• Otherwise, if the document has specifies text field attributes (see SignDocDocument.getTextFieldAttributes()), those will be used by PDF processing software.
• Otherwise, the field is not valid.

To avoid having invalid fields, SignDocDocument.addField() and SignDocDocument.setField() will use text field attributes specifying Helvetica as the font and black for the text color if the field does not inherit text field attributes from an ancestor field or from the document.

This function always fails for TIFF documents.

Parameters

[in]

aInput

The new text field attributes.

Returns

true iff successful.

See also

getTextFieldAttributes(), selectWidget()

synchronized void setTop

(

double

aTop

)

throws SignDocException

Set the top coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems. If coordinates are given in pixels (this is true for TIFF documents), this coordinate is exclusive.

Parameters

[in]

aTop

The top coordinate.

See also

getTop(), selectWidget(), setBottom(), setLeft(), setRight(), SignDocDocument.sff_move

synchronized void setTopIndex

(

int

aTopIndex

)

throws SignDocException

Set the index of the choice to be displayed in the first line of a list box.

This value is ignored for other field types.

Parameters

[in]

aTopIndex

The index of the choice to be displayed in the first line of a list box.

See also

getChoiceValue(), getTopIndex()

synchronized void setType

(

int

aType

)

throws SignDocException

Set the type of the field.

The default value is t_unknown.

Calling this function may affect the border color, see setBorderColor().

Parameters

[in]

aType

The type of the field.

See also

getType(), setBorderColor()

t_unknown, t_pushbutton, t_check_box, t_radio_button, t_text, t_list_box, t_combo_box, t_signature_digsig, t_signature_signdoc

synchronized boolean setValue	(	int	aIndex,
		String	aValue
	)		throws SignDocException

Set a value of the field.

Pushbutton fields and signature fields don't have a value, list boxes can have multiple values selected if f_MultiSelect is set.

Hard line breaks for multiline text fields (ie, text fields with flag f_MultiLine set) are encoded as "\r", "\n", or "\r\n". The behavior for values containing line breaks is undefined if the f_MultiLine flag is not set.

After calling this function, getValueIndex() will return -1.

Parameters

[in]	aIndex	The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]	aValue	The value to be set. Complex scripts are supported, see Complex Scripts.

Returns

true if successful, false if aIndex is out of range.

See also

addValue() clearValues(), clickButton(), getValue(), getValueIndex(), setValueIndex()

synchronized void setValue

(

String

aValue

)

throws SignDocException

Set the value of the field.

Calling this function is equivalent to calling clearValues() and addValue().

Hard line breaks for multiline text fields (ie, text fields with flag f_MultiLine set) are encoded as "\r", "\n", or "\r\n". The behavior for values containing line breaks is undefined if the f_MultiLine flag is not set.

After calling this function, getValueIndex() will return -1.

Parameters

[in]

aValue

The value to be set. Complex scripts are supported, see Complex Scripts.

See also

addValue(), clearValues(), clickButton(), getValue(), getValueIndex(), setValueIndex()

synchronized void setValueIndex

(

int

aIndex

)

throws SignDocException

Set the value index.

Radio button groups and check box fields can have multiple widgets having the same button value. For check box fields and radio buttons without f_RadiosInUnison set, specifying the selected button by value string is ambiguous in that case. A 0-based value index can be used to find out which button is selected or to select a button.

Radio button groups and check box fields need not use a value index; in fact, they usually don't. However, you can always set a value index for radio button groups and check box fields.

If the value index is non-negative, SignDocDocument.addField() and SignDocDocument.setField() will use the value index instead of the string value set by setValue().

Calling setValueIndex() doesn't affect the return value of getValue() as the value index is used by SignDocDocument.addField() and SignDocDocument.setField() only. However, successful calls to SignDocDocument.addField() and SignDocDocument.setField() will make getValue() return the selected value.

For radio button groups with f_RadiosInUnison set and non-unique button values and for check box fields with non-unique button values, for each button value, the lowest index having that button value is the canonical one. After calling SignDocDocument.addField() or SignDocDocument.setField(), getValueIndex() will return the canonical value index.

Don't forget to update the value index when adding or removing widgets!

SignDocDocument.addField() and SignDocDocument.setField() will fail if the value index is non-negative for fields other than radio button groups and check box fields.

The "Off" value never has a value index.

Note

addValue(), clearValues(), and setValue() make the value index unset (ie, getValueIndex() will return -1). Therefore, you don't have to call setValueIndex(-1) to make setValue() take effect on SignDocDocument.addField() and SignDocDocument.setField().

Parameters

[in]

aIndex

the 0-based value index or -1 to make the value index unset.

See also

clickButton(), getValue(), getValueIndex(), setValue()

synchronized void setWidgetFlags

(

int

aFlags

)

throws SignDocException

Set the annotation flags of the widget, see wf_Invisible.

The default value is wf_Print. The annotation flags are used for PDF documents only. Currently, the semantics of the annotation flags are ignored by this software (ie, the flags are stored in the document, but they don't have any meaning to this software).

Parameters

[in]

aFlags

The annotation flags of the widget.

See also

getWidgetFlags(), selectWidget()

Member Data Documentation

final int bos_beveled = 3

static

Border style: Rectangle looking embossed.

See also

getBorderStyle(), setBorderStyle()

final int bos_dashed = 2

static

Border style: Dashed rectangle.

See also

getBorderStyle(), setBorderStyle()

final int bos_inset = 4

static

Border style: Rectangle looking engraved.

See also

getBorderStyle(), setBorderStyle()

final int bos_other = 0

static

Border style: Unknown/unsupported.

See also

getBorderStyle(), setBorderStyle()

final int bos_solid = 1

static

Border style: Solid rectangle.

See also

getBorderStyle(), setBorderStyle()

final int bos_underline = 5

static

Border style: Single line at bottom.

See also

getBorderStyle(), setBorderStyle()

final int bus_check_mark = 2

static

Style used for check boxes and radio buttons: Check mark.

See also

getButtonStyle(), setButtonStyle()

final int bus_circle = 5

static

Style used for check boxes and radio buttons: Circle (default for radio buttons).

See also

getButtonStyle(), setButtonStyle()

final int bus_cross = 3

static

Style used for check boxes and radio buttons: Cross.

See also

getButtonStyle(), setButtonStyle()

final int bus_default = 0

static

Style used for check boxes and radio buttons: Default button style.

See also

getButtonStyle(), setButtonStyle()

final int bus_diamond = 7

static

Style used for check boxes and radio buttons: Diamond.

See also

getButtonStyle(), setButtonStyle()

final int bus_other = 1

static

Style used for check boxes and radio buttons: Unknown/unsupported.

See also

getButtonStyle(), setButtonStyle()

final int bus_square = 6

static

Style used for check boxes and radio buttons: Square.

See also

getButtonStyle(), setButtonStyle()

final int bus_star = 4

static

Style used for check boxes and radio buttons: Star.

See also

getButtonStyle(), setButtonStyle()

final int csvf_IssuerCert = 0x02

static

Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags().

Adobe bit 2.

Please see the PDF specification (ISO 32000-1:2008) for details.

See also

getCertSeedValueFlags(), setCertSeedValueFlags()

final int csvf_KeyUsage = 0x20

static

Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags().

Adobe bit 6.

Please see the PDF specification (ISO 32000-1:2008) for details.

See also

getCertSeedValueFlags(), setCertSeedValueFlags()

final int csvf_Policy = 0x04

static

Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags().

Adobe bit 3.

Please see the PDF specification (ISO 32000-1:2008) for details.

See also

getCertSeedValueFlags(), setCertSeedValueFlags()

final int csvf_SubjectCert = 0x01

static

Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags().

Adobe bit 1.

Please see the PDF specification (ISO 32000-1:2008) for details.

See also

getCertSeedValueFlags(), setCertSeedValueFlags()

final int csvf_SubjectDN = 0x08

static

Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags().

Adobe bit 4.

Please see the PDF specification (ISO 32000-1:2008) for details.

See also

getCertSeedValueFlags(), setCertSeedValueFlags()

final int csvf_URL = 0x40

static

Bit mask for getCertSeedValueFlags() and setCertSeedValueFlags().

Adobe bit 7.

Please see the PDF specification (ISO 32000-1:2008) for details.

See also

getCertSeedValueFlags(), setCertSeedValueFlags()

final int f_Comb = 1 << 12

static

Field flag: Comb.

See also

getFlags(), setFlags()

final int f_Combo = 1 << 14

static

Field flag: Combo (always set for combo boxes).

See also

getFlags(), setFlags()

final int f_CommitOnSelChange = 1 << 18

static

Field flag: CommitOnSelChange (for list boxes and combo boxes).

See also

getFlags(), setFlags()

final int f_DoNotScroll = 1 << 11

static

Field flag: DoNotScroll.

See also

getFlags(), setFlags()

final int f_DoNotSpellCheck = 1 << 10

static

Field flag: DoNotSpellCheck.

See also

getFlags(), setFlags()

final int f_Edit = 1 << 15

static

Field flag: Edit (for combo boxes).

If this flag is set, the user can enter an arbitrary value.

See also

getFlags(), setFlags()

final int f_EnableAddAfterSigning = 1 << 29

static

Field flag: Signature fields can be inserted after signing this field (TIFF only).

By default, no fields can be inserted into a TIFF document after a signature field has been signed. The f_EnableAddAfterSigning flag changes this behavior. (f_EnableAddAfterSigning is ignored for PDF documents.)

If the f_EnableAddAfterSigning flag is set, document size increases more during signing this field than when this flaq is not set. Each signature will increase the document size by the initial size of the document (before the first signature was applied), approximately. That is, the first signature will approximately double the size of the document.

Inserting a signature field fails if there already are any signed signature fields that don't have this flag set.

A signature field for which f_EnableAddAfterSigning is not set (in a TIFF document) can only be cleared if no other signature fields that don't have f_EnableAddAfterSigning have been signed after the signature field to be cleared. Signature fields having f_EnableAddAfterSigning set can always be cleared.

This flag cannot be modified.

See also

getFlags(), setFlags(), SignDocDocument.clearSignature()

final int f_FileSelect = 1 << 9

static

Field flag: FileSelect.

See also

getFlags(), setFlags()

final int f_Invisible = 1 << 30

static

Field flag: Invisible (TIFF only).

Invisible signature fields are invisible (ie, they look as if not inserted) until signed. Warning: signing an invisible signature field in a TIFF file may increase the size of the file substantially.

See also

getFlags(), setFlags()

final int f_MultiLine = 1 << 7

static

Field flag: MultiLine (for text fields).

The value of a text field that has this flag set may contain hard line breaks encoded as "\r", "\n", or "\r\n".

The contents of the text field are top-aligned if this flag is set and vertically centered if this flag is not set.

See also

getFlags(), setFlags()

final int f_MultiSelect = 1 << 17

static

Field flag: MultiSelect (for list boxes).

See also

getFlags(), setFlags()

final int f_NoExport = 1 << 2

static

Field flag: NoExport.

See also

getFlags(), setFlags()

final int f_NoToggleToOff = 1 << 3

static

Field flag: NoToggleToOff.

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

See also

getFlags(), setFlags()

final int f_Password = 1 << 8

static

Field flag: Password.

See also

getFlags(), setFlags()

final int f_Pushbutton = 1 << 5

static

Field flag: Pushbutton.

See also

getFlags(), setFlags()

final int f_Radio = 1 << 4

static

Field flag: Radio.

See also

getFlags(), setFlags()

final int f_RadiosInUnison = 1 << 6

static

Field flag: RadiosInUnison.

See also

getFlags(), setFlags()

final int f_ReadOnly = 1 << 0

static

Field flag: ReadOnly.

See also

getFlags(), setFlags()

final int f_Required = 1 << 1

static

Field flag: Required.

See also

getFlags(), setFlags()

final int f_RichText = 1 << 13

static

Field flag: RichText.

See also

getFlags(), setFlags()

final int f_SinglePage = 1 << 28

static

Field flag: Signature applies to the containing page only (TIFF only).

By default, signing a signature field signs the complete document, that is, modifications to any page are detected. For TIFF documents, this behavior can be changed for signature fields that have the f_EnableAddAfterSigning flag set: If the f_SinglePage flag is set, the signature applies only to the page containing the signature field, modifications to other pages won't be detected. This flag can be used for speeding up verification of signatures.

This flag cannot be modified.

See also

getFlags(), setFlags()

final int f_Sort = 1 << 16

static

Field flag: Sort (for list boxes and combo boxes).

See also

getFlags(), setFlags()

final int j_center = 2

static

Justification for text fields and list boxes: Centered.

See also

getJustification(), setJustification()

final int j_left = 1

static

Justification for text fields and list boxes: Left-justified.

See also

getJustification(), setJustification()

final int j_none = 0

static

Justification for text fields and list boxes: Justification does not apply (not a text field or a list box).

See also

getJustification(), setJustification()

final int j_right = 3

static

Justification for text fields and list boxes: Right-justified.

See also

getJustification(), setJustification()

final int lt_all = 2

static

Lock type: Lock all fields in the document.

See also

getLockType(), setLockType()

final int lt_exclude = 4

static

Lock type: Lock all fields except those specified by addLockField() etc.

See also

getLockType(), setLockType()

final int lt_include = 3

static

Lock type: Lock all fields specified by addLockField() etc.

See also

getLockType(), setLockType()

final int lt_na = 0

static

Lock type: Not a signature field / don't change locking.

See also

getLockType(), setLockType()

final int lt_none = 1

static

Lock type: Don't lock any fields.

See also

getLockType(), setLockType()

final int st_approval = 2

static

Signature type: Approval signature (that's the normal type of signature).

See also

getSignatureType()

final int st_certification = 3

static

Signature type: Certification signature (signed by the author).

See also

getSignatureType()

final int st_document_time_stamp = 4

static

Signature type: Document time stamp.

See also

getSignatureType()

final int st_not_a_signature_field = 0

static

Signature type: The field is not a signature field.

See also

getSignatureType()

final int st_not_signed = 1

static

Signature type: The signature field is not signed.

See also

getSignatureType()

final int t_check_box = 2

static

Field type: Check box field (PDF).

See also

getType(), setType()

final int t_combo_box = 8

static

Field type: Combo box (drop-down box) (PDF).

See also

getType(), setType()

final int t_list_box = 5

static

Field type: List box (PDF).

See also

getType(), setType()

final int t_pushbutton = 1

static

Field type: Pushbutton (PDF).

See also

getType(), setType()

final int t_radio_button = 3

static

Field type: Radio button (radio button group) (PDF).

See also

getType(), setType()

final int t_signature_digsig = 6

static

Field type: Digital signature field (Adobe DigSig in PDF, SOFTPRO signature in TIFF).

See also

getType(), setType()

final int t_signature_signdoc = 7

static

Field type: Digital signature field (traditional SignDoc) (PDF).

See also

getType(), setType()

final int t_text = 4

static

Field type: Text field (PDF).

See also

getType(), setType()

final int t_unknown = 0

static

Field type: Unknown type.

See also

getType(), setType()

final int wf_Hidden = 1 << (2 - 1)

static

Annotation flag of a widget: do not display or print or interact.

See also

getWidgetFlags(), setWidgetFlags(), wf_Invisible

final int wf_Invisible = 1 << (1 - 1)

static

Annotation flag of a widget: do not display non-standard annotation.

See the PDF Reference for the meaning of these flags. All these flags are supported for PDF documents only, they are ignored for TIFF documents.

See also

getWidgetFlags(), setWidgetFlags()

final int wf_Locked = 1 << (8 - 1)

static

Annotation flag of a widget: annotation cannot be deleted or modified, but its value can be changed.

See also

getWidgetFlags(), setWidgetFlags(), wf_Invisible

final int wf_LockedContents = 1 << (10 - 1)

static

Annotation flag of a widget: value cannot be changed.

See also

getWidgetFlags(), setWidgetFlags(), wf_Invisible

final int wf_NoRotate = 1 << (5 - 1)

static

Annotation flag of a widget: do not rotate to match page's rotation.

See also

getWidgetFlags(), setWidgetFlags(), wf_Invisible

final int wf_NoView = 1 << (6 - 1)

static

Annotation flag of a widget: do not display or interact.

See also

getWidgetFlags(), setWidgetFlags(), wf_Invisible

final int wf_NoZoom = 1 << (4 - 1)

static

Annotation flag of a widget: do not scale to match magnification.

See also

getWidgetFlags(), setWidgetFlags(), wf_Invisible

final int wf_Print = 1 << (3 - 1)

static

Annotation flag of a widget: print the annotation.

See also

getWidgetFlags(), setWidgetFlags(), wf_Invisible

final int wf_ReadOnly = 1 << (7 - 1)

static

Annotation flag of a widget: do not interact.

See also

getWidgetFlags(), setWidgetFlags(), wf_Invisible

final int wf_ToggleNoView = 1 << (9 - 1)

static

Annotation flag of a widget: toggle wf_NoView for certain events.

See also

getWidgetFlags(), setWidgetFlags(), wf_Invisible

---

The documentation for this class was generated from the following file:

• de/softpro/doc/SignDocField.java