signoAPI Android – Form fields – Class overview

STFormFieldInfoDTO class

The abstract STFormFieldInfoDTO class is a data object that contains the common properties of a form field. This class has the STSignatureFieldInfoDTO and STEditableFieldInfoDTO subclasses. The class is part of libSignoPDFSigner.

Property	Description
String name	Name of the form field
Rect rectangle	Position specification of the form field
int page	Page on which the form field is located. The first page number of the document begins with 1.
STFormFieldType formFieldType	Type of form field
boolean isRequired	true if the field is a mandatory field, otherwise false

STSignatureFieldInfoDTO class

The STSignatureFieldInfoDTO class is a data object derived from the STFormFieldInfoDTO class that contains the properties of a signature field. The class is part of libSignoPDFSigner.

Property	Description
boolean isSigned	true if the field has already been signed, otherwise false
String location	Place where the signature was made.
String reason	Reason for signature.
signerAppName string	Name of the app that creates the signature.
signerAppVersion string	Version of the app that creates the signature.

setSignerApp method

This method sets the signerAppName and signerAppVersion properties of the signature. Both parameters must always be specified together; separate specification is not possible. If one of the parameters is null or empty, the predefined default values of the API are used. This method ensures that the name and version of the app are set consistently.

Java

public void setSignerApp(String signerAppName, String signerAppVersion);

Parameter	Description
signerAppName string	Name of the app that creates the signature.
signerAppVersion string	Version of the app that creates the signature.
Return value	Description
-	-

Usage:

Java

signatureFieldInfoDTO.setSignerApp("My App", "1.0.0");

STEditableFieldInfoDTO class

The STEditableFieldInfoDTO abstract class is a data object derived from the STFormFieldInfoDTO class that contains the common properties of an editable form field. The class is also a superclass of STTextFieldInfoDTO, STButtonFieldInfoDTO and STChoiceFieldInfoDTO. The class is part of libSignoPDFSigner.

Property	Description
String value	Value of the form field
boolean readOnly	‘read only’ property of the form field

STTextFieldInfoDTO class

The STextFieldInfoDTO class is a data object derived from the STEditableFieldInfoDTO class that contains the properties of a text form field. The class is part of libSignoPDFSigner.

Property	Description
-	-

STButtonFieldInfoDTO class

The STButtonFieldInfoDTO class is a data object derived from the STEditableFieldInfoDTO class that contains the properties of a checkbox or an option field. The class is part of libSignoPDFSigner.

Property	Description
-	-

STChoiceFieldInfoDTO class

The STChoiceFieldInfoDTO class is a data object derived from the STEditableFieldInfoDTO class that contains the properties of a combo box or a list field. The class is part of libSignoPDFSigner.

Property	Description
List<String> possibleValues	Possible values for the form field

STFormFieldType class

The STFormFieldType class is an enum class that represents form field types.

Property	Description
TEXT	Text form field
BUTTON	Checkbox or radio button
CHOICE	Dropdown field
SIGNATURE	Signature field

See the examples for using the form field types in the STSignoSigner.getFormFields() method.

All fields in the DTO classes – with the exception of special fields such as signerAppName and signerAppVersion in STSignatureFieldInfoDTO – have classic getters/setters and do not require further documentation. The special fields are set and documented using special methods.