visit Kofax web site
de.softpro.signware.SPBitmap

de.softpro.signware.SPBitmap Class Reference

List of all members.

Detailed Description

Create a standard image from a signware, SPSignature, SPReference, SPTemplate or SPImage object.

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


Public Member Functions

byte[] getData ()
 Query the data of this bitmap object.
 SPBitmap (SPTemplate spTemplate, int iResolution, int iFormat) throws SPSignwareException
 Create a standard image from a SPTemplate object.
 SPBitmap (SPImage pImage, int iFormat) throws SPSignwareException
 Create a standard image from a SPImage object.
 SPBitmap (byte[] baPicture) throws SPSignwareException
 Create a SPBitmap object from a standard picture as a byte array.
 SPBitmap (byte[] spFlatFile, int iResolution, int iFormat) throws SPSignwareException
 Create a standard image from a SPFlatfile object.
 SPBitmap (SPReference spReference, int iResolution, int iFormat) throws SPSignwareException
 Create a standard image from a SPSignature object.
 SPBitmap (SPSignature spSignature, int iResolution, int iFormat) throws SPSignwareException
 Create a standard image from a SPSignature object.

Static Public Attributes

static final int SP_IMAGE_BLACKWHITE = 0x010000
 Image flag: create a black white image.
static final int SP_IMAGE_BLACKWHITE_1BPP = 0x200000
 Image flag: create a compressed image with 1 bit per pixel, implies SP_IMAGE_BLACKWHITE.
static final int SP_IMAGE_BMP_WIN = 1
 Image format windows bitmap.
static final int SP_IMAGE_CCITT4 = 5
 Image format CCITT4.
static final int SP_IMAGE_COLOR = 0x400000
 Image flag: create a color image.
static final int SP_IMAGE_CROSSED = 0x020000
 Image flag: draw a cross in the resulting image.
static final int SP_IMAGE_GIF = 4
 Image format gif.
static final int SP_IMAGE_JPEG = 3
 Image format jpeg.
static final int SP_IMAGE_PNG = 8
 Image format windows png.
static final int SP_IMAGE_TIFF = 6
 Image format tiff.

Constructor & Destructor Documentation

de.softpro.signware.SPBitmap.SPBitmap (  SPSignature  spSignature,
int  iResolution,
int  iFormat
)  throws SPSignwareException
 

Create a standard image from a SPSignature object.

It is an error to query an image with higher resolution than it was recorded.

Parameters:
spSignature [i] the signature object
iResolution [i] resolution of the resulting image
iFormat [i] desired image format
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPBitmapCreateFromSignature

SPBitmap.SP_IMAGE_GIF, SPBitmap.SP_IMAGE_CCITT4, SPBitmap.SP_IMAGE_TIFF, SPBitmap.SP_IMAGE_BMP_WIN, SPBitmap.SP_IMAGE_PNG

SPBitmap.SP_IMAGE_BLACKWHITE, SPBitmap.SP_IMAGE_BLACKWHITE_1BPP and SPBitmap.SP_IMAGE_CROSSED

de.softpro.signware.SPBitmap.SPBitmap (  SPReference  spReference,
int  iResolution,
int  iFormat
)  throws SPSignwareException
 

Create a standard image from a SPSignature object.

It is an error to query an image with higher resolution than it was recorded.

Parameters:
spReference [i] the reference object
iResolution [i] resolution of the resulting image
iFormat [i] desired image format
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPBitmapCreateFromReference

SPBitmap.SP_IMAGE_GIF, SPBitmap.SP_IMAGE_CCITT4, SPBitmap.SP_IMAGE_TIFF, SPBitmap.SP_IMAGE_BMP_WIN, SPBitmap.SP_IMAGE_PNG

SPBitmap.SP_IMAGE_BLACKWHITE, SPBitmap.SP_IMAGE_BLACKWHITE_1BPP, and SPBitmap.SP_IMAGE_CROSSED

de.softpro.signware.SPBitmap.SPBitmap (  byte[]  spFlatFile,
int  iResolution,
int  iFormat
)  throws SPSignwareException
 

Create a standard image from a SPFlatfile object.

Note:
It is an error to query an image with higher resolution than it was recorded.
Parameters:
spFlatFile [i] the flatfile object
iResolution [i] resolution of the resulting image
iFormat [i] desired image format, see SPBitmapCreateFromFlatFile
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPBitmapCreateFromFlatFile

SPBitmap.SP_IMAGE_GIF, SPBitmap.SP_IMAGE_CCITT4, SPBitmap.SP_IMAGE_TIFF, SPBitmap.SP_IMAGE_BMP_WIN, SPBitmap.SP_IMAGE_PNG

SPBitmap.SP_IMAGE_BLACKWHITE, SPBitmap.SP_IMAGE_BLACKWHITE_1BPP, and SPBitmap.SP_IMAGE_CROSSED

de.softpro.signware.SPBitmap.SPBitmap (  byte[]  baPicture  )  throws SPSignwareException
 

Create a SPBitmap object from a standard picture as a byte array.

Supported formats include:

Parameters:
baPicture [i] the picture as a byte array
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPBitmapCreateFromReference

de.softpro.signware.SPBitmap.SPBitmap (  SPImage  pImage,
int  iFormat
)  throws SPSignwareException
 

Create a standard image from a SPImage object.

Parameters:
pImage [i] the image object
iFormat [i] desired image format
Returns:
byte[] the serialized reference data
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPBitmap.SP_IMAGE_BMP_WIN, SPBitmap.SP_IMAGE_JPEG

SPBitmap.SP_IMAGE_GIF, SPBitmap.SP_IMAGE_CCITT4, SPBitmap.SP_IMAGE_TIFF, SPBitmap.SP_IMAGE_PNG

SPBitmap.SP_IMAGE_BLACKWHITE, SPBitmap.SP_IMAGE_BLACKWHITE_1BPP and SPBitmap.SP_IMAGE_COLOR

de.softpro.signware.SPBitmap.SPBitmap (  SPTemplate  spTemplate,
int  iResolution,
int  iFormat
)  throws SPSignwareException
 

Create a standard image from a SPTemplate object.

It is an error to query an image with higher resolution than it was recorded.

Parameters:
spTemplate [i] the template object
iResolution [i] resolution of the resulting image
iFormat [i] desired image format
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
See also:
SPBitmapCreateFromReference

SPBitmap.SP_IMAGE_GIF, SPBitmap.SP_IMAGE_CCITT4, SPBitmap.SP_IMAGE_TIFF, SPBitmap.SP_IMAGE_BMP_WIN, SPBitmap.SP_IMAGE_PNG

SPBitmap.SP_IMAGE_BLACKWHITE, SPBitmap.SP_IMAGE_BLACKWHITE_1BPP and SPBitmap.SP_IMAGE_CROSSED

Member Function Documentation

byte [] de.softpro.signware.SPBitmap.getData (   ) 
 

Query the data of this bitmap object.

Returns:
byte[] the image as a byte array
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)

Member Data Documentation

final int de.softpro.signware.SPBitmap.SP_IMAGE_BLACKWHITE = 0x010000 [static]
 

Image flag: create a black white image.

final int de.softpro.signware.SPBitmap.SP_IMAGE_BLACKWHITE_1BPP = 0x200000 [static]
 

Image flag: create a compressed image with 1 bit per pixel, implies SP_IMAGE_BLACKWHITE.

final int de.softpro.signware.SPBitmap.SP_IMAGE_BMP_WIN = 1 [static]
 

Image format windows bitmap.

final int de.softpro.signware.SPBitmap.SP_IMAGE_CCITT4 = 5 [static]
 

Image format CCITT4.

Note:
CCITT4 is optimized for black white images

final int de.softpro.signware.SPBitmap.SP_IMAGE_COLOR = 0x400000 [static]
 

Image flag: create a color image.

final int de.softpro.signware.SPBitmap.SP_IMAGE_CROSSED = 0x020000 [static]
 

Image flag: draw a cross in the resulting image.

final int de.softpro.signware.SPBitmap.SP_IMAGE_GIF = 4 [static]
 

Image format gif.

final int de.softpro.signware.SPBitmap.SP_IMAGE_JPEG = 3 [static]
 

Image format jpeg.

Note:
JPEG might add artifacts in the image, it is not recommended for signature images

final int de.softpro.signware.SPBitmap.SP_IMAGE_PNG = 8 [static]
 

Image format windows png.

final int de.softpro.signware.SPBitmap.SP_IMAGE_TIFF = 6 [static]
 

Image format tiff.

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