visit Kofax web site
de.softpro.signware.SPBackgroundObjects

de.softpro.signware.SPBackgroundObjects Class Reference

Inheritance diagram for de.softpro.signware.SPBackgroundObjects:

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

Detailed Description

Container for tablet background objects.

SPBackgroundObjects holds background descriptors for different tablets, the methods SPAcquire.setBackgroundObjects and SPGuiAcqu.setBackgroundObjects will select and copy the descriptor that matches the active tablet.
The matching algorithm differs between tablets with (external) LCD and tablets without LCD:

The tabletname is resolved from the tablet object, see SPTablet.getDeviceStr. The descriptorname is resolved from Attribute Device in the element SPSWDevice.

Please see sec_SignWareDTD for a full description of all background elements, see SPBackgroundObjects.h for details of the core implementation

Operating Systems:
Windows (Win32)


Public Member Functions

void readFile (String strFile, String strLanguage) throws SPSignwareException
 Read the objects from a file.
void readXML (byte[] baDescription) throws SPSignwareException
 Read the objects from a XML byte array.
void readXML (String strDescription) throws SPSignwareException
 Read the objects from a String.
 SPBackgroundObjects () throws SPSignwareException
 Constructor.

Constructor & Destructor Documentation

de.softpro.signware.SPBackgroundObjects.SPBackgroundObjects (   )  throws SPSignwareException
 

Constructor.

Operating Systems:
Windows (Win32)
Exceptions:
SPSignwareException on error

Member Function Documentation

void de.softpro.signware.SPBackgroundObjects.readFile (  String  strFile,
String  strLanguage
)  throws SPSignwareException
 

Read the objects from a file.

Parameters:
strFile [i] name of the file to read. If the strFile does not contain a fully qualified path then the search order is:
  • %USERPROFILE%\SOFTPRO
  • %USERPROFILE%
  • %HOMEPATH%\SOFTPRO
  • %HOMEPATH%
  • %ALLUSERSPROFILE%\SOFTPRO
  • %ALLUSERSPROFILE%
  • %APPDATA%\SOFTPRO
  • %APPDATA%
  • %PATH%
  • SystemDirectory, only Windows
  • WindowsDirectory, only Windows
strLanguage [i] two-digit language code, may be null
Exceptions:
SPSignwareException on error
  • SP_UNSUPPORTEDERR the tablet does not support images
  • SP_PARAMERR any parameter was was wrong, or the image could not be read
  • SP_OPENERR the file is not accessible or does not exist
  • SP_FILEERR the file cannot be read
  • SP_LINKLIBRARYERR external modules could not be loaded
Operating Systems:
Windows (Win32)
See also:
SPBackgroundObjectsCreateFromFile

void de.softpro.signware.SPBackgroundObjects.readXML (  byte[]  baDescription  )  throws SPSignwareException
 

Read the objects from a XML byte array.

Parameters:
baDescription [i] the background objects field(s) description, the root element must be SPSWDeviceFields, see sec_SignWareDTD. Supported encodings in the XML declaration are ASCII, UTF-8, and ISO-8859-1
Exceptions:
SPSignwareException on error
  • SP_UNSUPPORTEDERR the tablet does not support images
  • SP_PARAMERR any parameter was was wrong, or the image could not be read
  • SP_LINKLIBRARYERR external modules could not be loaded
Operating Systems:
Windows (Win32)
See also:
SPBackgroundObjectsCreateFromXML

void de.softpro.signware.SPBackgroundObjects.readXML (  String  strDescription  )  throws SPSignwareException
 

Read the objects from a String.

Parameters:
strDescription [i] the background objects field(s) description, the root element must be SPSWDeviceFields, see sec_SignWareDTD. Supported encodings in the XML declaration is UTF-8
Exceptions:
SPSignwareException on error
  • SP_UNSUPPORTEDERR the tablet does not support images
  • SP_PARAMERR any parameter was was wrong, or the image could not be read
  • SP_LINKLIBRARYERR external modules could not be loaded
Operating Systems:
Windows (Win32)
See also:
SPBackgroundObjectsCreateFromXML

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