visit Kofax web site

de.softpro.signware.SPTellerImage Class Reference

Inheritance diagram for de.softpro.signware.SPTellerImage:

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

Detailed Description

Reperesentation of a SignBase® Teller Image
The interface allows for accessing SignBase® functionality within SignWare®.
This class is not serializable, please serialize the SPSignature / SPReference / SPImage, and instantiate a SPTellerImageObject from the serialized SPSignature / SPReference / SPImage.

Operating Systems:
Windows (Win32)


Public Member Functions

char getSource () throws SPSignwareException
 Query the image source.
char getType () throws SPSignwareException
 Query the image type.
byte[] getXML (int iIndent) throws SPSignwareException
 Convert this SPTellerImage object to a XML string, that confirms with signplus.dtd.
void setSource (char chSource) throws SPSignwareException
 Set the image source.
 SPTellerImage (byte baXML[]) throws SPSignwareException
 Create a teller image that is based on an image contained in element SignPlusSignature according to signplus.dtd.
 SPTellerImage (SPImage pImage) throws SPSignwareException
 Create a teller image that includes a static image.
 SPTellerImage (SPSignature pSignature) throws SPSignwareException
 Create a teller image that includes a dynamic signature.
 SPTellerImage (SPReference pReference) throws SPSignwareException
 Create a teller image that includes a dynamic reference.

Package Functions

native final int jniFree ()


Constructor & Destructor Documentation

de.softpro.signware.SPTellerImage.SPTellerImage SPReference  pReference  )  throws SPSignwareException
 

Create a teller image that includes a dynamic reference.

Parameters:
pReference [i] The reference object to be converted to a teller image
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerImageCreateFromReference

de.softpro.signware.SPTellerImage.SPTellerImage SPSignature  pSignature  )  throws SPSignwareException
 

Create a teller image that includes a dynamic signature.

Parameters:
pSignature [i] The signature object to be converted to a teller image
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerImageCreateFromReference

de.softpro.signware.SPTellerImage.SPTellerImage SPImage  pImage  )  throws SPSignwareException
 

Create a teller image that includes a static image.

Parameters:
pImage [i] The image object to be converted to a teller image
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerImageCreateFromReference

de.softpro.signware.SPTellerImage.SPTellerImage byte  baXML[]  )  throws SPSignwareException
 

Create a teller image that is based on an image contained in element SignPlusSignature according to signplus.dtd.

Parameters:
baXML [i] the xml data stream
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerImageCreateFromReference


Member Function Documentation

char de.softpro.signware.SPTellerImage.getSource  )  throws SPSignwareException
 

Query the image source.

Returns:
char the image source, see SPTellerImageGetSource for details
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerImageGetSource

char de.softpro.signware.SPTellerImage.getType  )  throws SPSignwareException
 

Query the image type.

Returns:
char the image type, see SPTellerImageGetType for details
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerImageGetType

byte [] de.softpro.signware.SPTellerImage.getXML int  iIndent  )  throws SPSignwareException
 

Convert this SPTellerImage object to a XML string, that confirms with signplus.dtd.

Parameters:
iIndent [i] The number of spaces to indent, may be 0
Returns:
the xml data array
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerImageGetXML

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

Implements de.softpro.signware.SPSignwareObject.

void de.softpro.signware.SPTellerImage.setSource char  chSource  )  throws SPSignwareException
 

Set the image source.

Parameters:
chSource [i] the image source, see SPTellerImageSetSource for details
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
See also:
SPTellerImageSetSource


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