signoAPI Android – Formularfelder – Klassenübersicht

Klasse STFormFieldInfoDTO

Die abstrakte Klasse STFormFieldInfoDTO ist ein Datenobjekt, das die gemeinsamen Eigenschaften eines Formularfeldes enthält. Diese Klasse verfügt über die Unterklassen STSignatureFieldInfoDTO und STEditableFieldInfoDTO. Die Klasse ist Bestandteil der libSignoPDFSigner.

Eigenschaft	Bedeutung
String name	Name des Formularfeldes
Rect rectangle	Positionsangabe des Formularfeldes
int page	Seite, auf der sich das Formularfeld befindet. Die erste Seitennummer des Dokuments beginnt mit 1.
STFormFieldType formFieldType	Typ des Formularfeldes
boolean isRequired	true, wenn das Feld ein Pflichtfeld ist, sonst false

Klasse STSignatureFieldInfoDTO

Die Klasse STSignatureFieldInfoDTO ist ein von der Klasse STFormFieldInfoDTO abgeleitetes Datenobjekt, das die Eigenschaften eines Signaturfeldes enthält. Die Klasse ist Bestandteil der libSignoPDFSigner.

Eigenschaft	Bedeutung
boolean isSigned	true, wenn das Feld bereits unterschrieben ist, sonst false.
String location	Ort, an dem Unterschrift geleistet wurde.
String reason	Grund der Signatur.
String signerAppName	Name der App, die die Signatur erstellt.
String signerAppVersion	Version der App, die die Signatur erstellt.

Methode setSignerApp

Diese Methode setzt die Eigenschaften signerAppName und signerAppVersion der Signatur. Beide Parameter müssen immer zusammen angegeben werden; eine separate Angabe ist nicht möglich. Wenn einer der Parameter null oder leer ist, werden die vordefinierten Standardwerte der API verwendet. Diese Methode stellt sicher, dass Name und Version der App konsistent gesetzt werden.

Java

public void setSignerApp(String signerAppName, String signerAppVersion);

Parameter	Bedeutung
String signerAppName	Name der App, die die Signatur erstellt.
String signerAppVersion	Version der App, die die Signatur erstellt.
Rückgabewert	Bedeutung
-	-

Anwendung:

Java

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

Klasse STEditableFieldInfoDTO

Die abstrakte Klasse STEditableFieldInfoDTO ist ein von der Klasse STFormFieldInfoDTO abgeleitetes Datenobjekt, das die gemeinsamen Eigenschaften eines editierbaren Formularfeldes enthält. Die Klasse ist auch eine Superklasse von STTextFieldInfoDTO, STButtonFieldInfoDTO und STChoiceFieldInfoDTO. Die Klasse ist Bestandteil der libSignoPDFSigner.

Eigenschaft	Bedeutung
String value	Wert des Formularfeldes
boolean readOnly	„read only“-Eigenschaft des Formularfeldes

Klasse STTextFieldInfoDTO

Die Klasse STextFieldInfoDTO ist ein von der Klasse STEditableFieldInfoDTO abgeleitetes Datenobjekt, das die Eigenschaften eines Textformularfeldes enthält. Die Klasse ist Bestandteil der libSignoPDFSigner.

Eigenschaft	Bedeutung
-	-

Klasse STButtonFieldInfoDTO

Die Klasse STButtonFieldInfoDTO ist ein von der Klasse STEditableFieldInfoDTO abgeleitetes Datenobjekt, das die Eigenschaften eines Kontrollkästchens oder ein Optionsfeldes enthält. Die Klasse ist Bestandteil der libSignoPDFSigner.

Eigenschaft	Bedeutung
-	-

Klasse STChoiceFieldInfoDTO

Die Klasse STChoiceFieldInfoDTO ist ein von der Klasse STEditableFieldInfoDTO abgeleitetes Datenobjekt, das die Eigenschaften eines Kombinationsfeld oder eines Listenfeldes enthält. Die Klasse ist Bestandteil der libSignoPDFSigner.

Eigenschaft	Bedeutung
List<String> possibleValues	Mögliche Werte für das Formularfeld

Klasse STFormFieldType

Die Klasse STFormFieldType ist eine Enum-Klasse, die Formularfeldtypen repräsentiert.

Eigenschaft	Bedeutung
TEXT	Textformularfeld
BUTTON	Kontrollkästchen oder Optionsfeld
CHOICE	Dropdownfeld
SIGNATURE	Signaturfeld

Siehe die Beispiele für die Verwendung der Formularfeldtypen in der Methode STSignoSigner.getFormFields().

Alle Felder in den DTO-Klassen – mit Ausnahme der speziellen Felder, wie z. B. signerAppName und signerAppVersion in der STSignatureFieldInfioDTO – verfügen über klassische Getter/Setter und benötigen keine weitere Dokumentation. Die besonderen Felder werden über spezielle Methoden gesetzt und dokumentiert.