visit Kofax web site

de.softpro.signware.SPSignwareObject Class Reference

Inheritance diagram for de.softpro.signware.SPSignwareObject:

de.softpro.signware.SPAcquire de.softpro.signware.SPBackgroundObjects de.softpro.signware.SPCleanParameter de.softpro.signware.SPCompare de.softpro.signware.SPImage de.softpro.signware.SPJGuiAcqu de.softpro.signware.SPJGuiDisp de.softpro.signware.SPJGuiDyn de.softpro.signware.SPPropertyMap de.softpro.signware.SPReference de.softpro.signware.SPScanner de.softpro.signware.SPScannerEnum de.softpro.signware.SPSignature de.softpro.signware.SPSmartcard de.softpro.signware.SPSmartcardDriver de.softpro.signware.SPTablet de.softpro.signware.SPTabletEnum de.softpro.signware.SPTeller de.softpro.signware.SPTellerImage de.softpro.signware.SPTemplate de.softpro.signware.SPTicket List of all members.

Detailed Description

Encapsulates the native object that is used by the SPSignware subsystem.

Signware classes are not serializable, if not explicitly marked serializable.

Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)


Public Member Functions

void dispose ()
 Free the SDK object.

Protected Member Functions

void finalize () throws Throwable
 free the SDK object

Protected Attributes

boolean bDestroy = true

Package Functions

long getHandle ()
 Query the SDK object identifier.
abstract int jniFree ()
 Free an SDK object.
void setHandle (long iHandle)
 Set the SDK object identifier.
void setReferenceHandle (long iHandle)
 Set the SDK object identifier.
 SPSignwareObject (boolean destroy)
 Create a new SignwareObject instance.
 SPSignwareObject ()
 Create a new SignwareObject instance.


Constructor & Destructor Documentation

de.softpro.signware.SPSignwareObject.SPSignwareObject  )  [package]
 

Create a new SignwareObject instance.

The constructor will destroy the native object, see dispose().

Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

de.softpro.signware.SPSignwareObject.SPSignwareObject boolean  destroy  )  [package]
 

Create a new SignwareObject instance.

This constructor is usefull to create a copy of objects that may not be destroyed (such as SPTablet clones created by SPGuiAcqu.getTablet()), see dispose.

Parameters:
destroy [i] flag to free the object
  • true the native object will be destroyed (call jniFree)
  • false the native object will not be destroyed
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)


Member Function Documentation

void de.softpro.signware.SPSignwareObject.dispose  ) 
 

Free the SDK object.

You should call the dispose methode if a SDK object is no longer needed. This is especially important for Smartcard, SmartcardDriver or Tablet objects, as they may lock hardware resources, that are no longer available to other applications.
The garbage collector invokes finalize(), but it is not predictable when the garbage collector will free an object.

Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

Reimplemented in de.softpro.signware.SPTablet.

void de.softpro.signware.SPSignwareObject.finalize  )  throws Throwable [protected]
 

free the SDK object

The finalize method is called by the garbage collector, and should not be invoked from the application. Use dispose() to free a SDK object.

Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
dispose

long de.softpro.signware.SPSignwareObject.getHandle  )  [package]
 

Query the SDK object identifier.

Returns:
int SDK Object identifier
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

abstract int de.softpro.signware.SPSignwareObject.jniFree  )  [package, pure virtual]
 

Free an SDK object.

Implemented in de.softpro.signware.SPCleanParameter, de.softpro.signware.SPCompare, de.softpro.signware.SPImage, de.softpro.signware.SPJGuiDisp, de.softpro.signware.SPJGuiDyn, de.softpro.signware.SPPropertyMap, de.softpro.signware.SPReference, de.softpro.signware.SPScanner, de.softpro.signware.SPScannerEnum, de.softpro.signware.SPSignature, de.softpro.signware.SPSmartcard, de.softpro.signware.SPSmartcardDriver, de.softpro.signware.SPTablet, de.softpro.signware.SPTabletEnum, de.softpro.signware.SPTeller, de.softpro.signware.SPTellerImage, de.softpro.signware.SPTemplate, and de.softpro.signware.SPTicket.

void de.softpro.signware.SPSignwareObject.setHandle long  iHandle  )  [package]
 

Set the SDK object identifier.

Parameters:
iHandle SDK Object identifier
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

void de.softpro.signware.SPSignwareObject.setReferenceHandle long  iHandle  )  [package]
 

Set the SDK object identifier.

Set a SDK handle as a reference which will not be detroyed.

Parameters:
iHandle SDK Object identifier
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)


Member Data Documentation

boolean de.softpro.signware.SPSignwareObject.bDestroy = true [protected]
 


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