visit Kofax web site

de.softpro.signware.SPTabletEnum Class Reference

Inheritance diagram for de.softpro.signware.SPTabletEnum:

de.softpro.signware.SPSignwareObject List of all members.

Detailed Description

Tablet enumerator object.

The object SPTabletEnum enumerates tablets for either a specific tablet class or all tablet classes. You may use an enumeration object to create the specific tablet,

See also:
de.softpro.signware.SPTablet.SPTablet(SPPropertyMap).
SPTabletEnum enumerates all devices in these tablet classes: All drivers are loaded and queried for the list of devices when SPTabletEnum is instantiated the first time. The drivers will not be unloaded until the application is closed or SPTablet.reset is called.
Successive instances will update the device list to reflect the actual state (dynamically update the device list).
Some device drivers have long timeouts before they return with 'no device found'. It is thus recommended to create a SPTabletEnum object when the application starts. The object may be freed immediately, subsequent calls use static objects which are only deleted when calling SPTablet.reset or when exiting the applition.

Operating Systems:
Windows (Win32)
Since:
Version 3.2


Public Member Functions

SPPropertyMap getDescriptor (int iIndex) throws SPSignwareException
 Query the descriptor of a tablet in the enumerator.
int getNumberTablets () throws SPSignwareException
 Query the number of tablets in the enumerator.
 SPTabletEnum (String strTabletClass) throws SPSignwareException
 Create a Tablet object based on a tablet class.

Package Functions

final native int jniFree ()


Constructor & Destructor Documentation

de.softpro.signware.SPTabletEnum.SPTabletEnum String  strTabletClass  )  throws SPSignwareException
 

Create a Tablet object based on a tablet class.

Parameters:
strTabletClass [i] class name of the desired tablet driver, may be an empty string or null to enumerate all supported tablet classes
Exceptions:
SPSignwareException if an error occured
Operating Systems:
Windows (Win32)
See also:
SPTabletEnumCreateByClass
Since:
Version 3.2


Member Function Documentation

SPPropertyMap de.softpro.signware.SPTabletEnum.getDescriptor int  iIndex  )  throws SPSignwareException
 

Query the descriptor of a tablet in the enumerator.

Parameters:
iIndex [i] the zero based index in this enumerator
Returns:
SPPropertyMap the descriptor of the device at the specified index in this enumerator
Exceptions:
SPSignwareException if an error occured
Operating Systems:
Windows (Win32)
See also:
SPTabletEnumGetNumberTablets
Since:
Version 3.2

int de.softpro.signware.SPTabletEnum.getNumberTablets  )  throws SPSignwareException
 

Query the number of tablets in the enumerator.

Returns:
int the number of tablets in this enumerator
Exceptions:
SPSignwareException if an error occured
Operating Systems:
Windows (Win32)
See also:
SPTabletEnumGetDescriptor
Since:
Version 3.2

final native int de.softpro.signware.SPTabletEnum.jniFree  )  [package, virtual]
 

Implements de.softpro.signware.SPSignwareObject.


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