German English
German English

signoPAD-API Java - Einstiegspunkte

Für eine Unterschriftenerfassung sind die hier beschriebenen Einstiegspunkte möglich. Der Einstieg beginnt immer mit der Auswahl der Fassade abhängig davon welches Gerät, Technik oder Verbindungstyp verwendet werden soll. Anschließend wird mithilfe der Fassade ein SigPadDevice Objekt erstellt, was repräsentativ für ein angeschlossenes Signaturgerät steht. Zuletzt wird eine Instanz der SigPadApi Klasse für das SigPadDevice erstellt. Die SigPadApi Klasse ist die wichtigste Klasse wenn es um das Verwenden des Signaturgerätes geht.

Für Details siehe Schnittstellenbeschreibung.

SigPadFacade

Einer der drei Einstiegspunkte ist die Klasse de.signotec.stpad.api.SigPadFacade. Diese stellt allgemeine Methoden zur Initialisierung und Verwendung des signoPAD-API für Java zur Verfügung und sollte immer benutzt werden, sofern die plattformabhängigen Bibliotheken für Windows und Linux verwendet werden können.

Da es sich hierbei um eine Singleton-Klasse handelt, ist kein öffentlicher Konstruktor vorhanden, der Aufruf erfolgt über die getInstance() Methode. Im zweiten Schritt muss initializeApi() aufgerufen werden, damit wird die Schnittstelle initialisiert. Schritt 3 ist der Aufruf der getSignatureDevices() Methode, die alle angeschlossenen Pads als SigPadDevice-Objekte zurückliefert. Mit so einem Objekt kann dann die eigentliche Hauptfunktionalität in der Klasse SigPadApi aufgerufen werden. Nach Abschluss aller Operationen wird finalizeApi() aufgerufen, welches das signoPAD-API für Java ordnungsgemäß beendet. Anwendungen, die nur gelegentlich auf das Signaturgerät zugreifen müssen, können diesen Vorgang für jede Unterschrift vollständig durchführen, üblicherweise sollte das API aber beim Start der Anwendung initialisiert und beim Beenden der Anwendung erst finalisiert werden.

Im Folgenden wird ein schematischer Ablauf der Aufrufe gezeigt:

Java
SigPadFacade facade = SigPadFacade.getInstance();
// initialize
facade.initializeApi();
// search for devices
SigPadDevice[] pads = facade.getSignatureDevices();
// create API for device
SigPadApi padApi = new SigPadApi(pads[0]);
// some custom operations
padApi.XXX();
// clean up
facade.finalizeApi();

SigPadPureFacade

Der zweite Einstiegspunkt ist die Klasse de.signotec.stpad.api.SigPadPureFacade. Diese stellt allgemeine Methoden zur Initialisierung und Verwendung des signoPAD-API für Java zur Verfügung und kann nur benutzt werden, wenn ein signotec LCD Signature Pad über Ethernet im LAN angeschlossen ist. Der Vorteil dieses Einstiegspunktes ist, dass keine plattformabhängigen Bibliotheken verwendet werden und somit keine Beschränkung auf Windows und Linux besteht.

Da es sich hierbei um eine Singleton-Klasse handelt, ist kein öffentlicher Konstruktor vorhanden, der Aufruf erfolgt über die getInstance() Methode. Im zweiten Schritt muss durch Aufruf der getSignatureDevices() Methode nach einem angeschlossenen Pad gesucht werden, das als SigPadDevice zurückgegeben wird. Mit diesem Objekt kann dann die eigentliche Hauptfunktionalität in der Klasse SigPadApi aufgerufen werden.

Im Folgenden wird ein schematischer Ablauf der Aufrufe gezeigt:

Java
SigPadPureFacade facade = SigPadPureFacade.getInstance();
// search for devices
String address = "192.168.100.100";
int port = 1002;
SigPadDevice[] pads = facade.getSignatureDevices(address, port, false);
// create API for device
SigPadApi padApi = new SigPadApi(pads[0]);
// some custom operations
padApi.XXX();

PenDisplayFacade

Der dritte Einstiegspunkt ist die Klasse de.signotec.stpad.api.PenDisplayFacade. Sie bietet die Möglichkeit eine Unterschrift mit dem Stift auf einem Pen Display, z.B. dem signotec Delta PD, oder mit der Maus auf dem Desktop zu erfassen. Als Eingabefläche dient die grafische Swing Komponente SignatureJPanel oder SignatureCanvas.

Qualitativ unterscheidet sich die Unterschrift mit dem Stift stark von der Unterschrift mit der Maus. Die Genauigkeit der erfassten Punkte entspricht mit der Maus der Bildschirmauflösung. Beim Stift ist die Genauigkeit abhängig vom Digitizer i. d. R. um ein Vielfaches höher. Die Maus bietet nur zwei Druckwerte (Taste gedrückt / Taste nicht gedrückt). Mit dem Stift sind über 1000 Druckwerte möglich.

Für die Erfassung mit dem Stift sind Treiber erforderlich. Siehe dazu Kapitel JPen Bibliothek und JWinPointer Bibliothek.

Die Verwendung der Klasse teilt sich in drei Schritte.

  1. Erstellung einer neuen Instanz mit der Methode getInstance().

  2. Einstellen der Pen Display Eigenschaften wie Seriennummer, Größe und Auflösung des Erfassungsbereiches und ob Stift und/oder Maus aktiv ist.

  3. Aufruf der getSignatureDevice() Methode, die eine SigPadDevice Instanz liefert, mit der die eigentliche Hauptfunktionalität in der Klasse SigPadApi aufgerufen wird.

Im Folgenden wird ein schematischer Ablauf der Aufrufe gezeigt:

Java
SigPadApi.setSerialKey("myCompanyKey");
PenDisplayFacade facade = PenDisplayFacade.getInstance();
// set the serial number "1111" of the device
facade.setSerialNumber(1111L);
// use pen only, not the mouse
facade.setPenEnabled(true);
facade.setMouseEnabled(false);
// record the pen in area 320x240
facade.setDisplaySize(320, 240);
// create device
SigPadDevice device1 = facade.getSignatureDevice();
if (device1 != null) {
    SigPadApi padApi = new SigPadApi(device1);
    // open/connect device
    SignatureJPanel panel = new SignatureJPanel(padApi, 320, 240);
    padApi.openDevice(panel);
    // custom operations
    padApi.XXX();
}

Der Funktionsumfang der Fassade ist durch ein Wasserzeichen bei der Erfassung und Darstellung der Unterschrift eingeschränkt. Das Wasserzeichen kann durch Erwerb einer Lizenz von der signotec GmbH entfernt werden. Siehe Kapitel Lizenzschlüssel.