visit Kofax web site

de.softpro.signware.SPGuiAcqu Class Reference

List of all members.

Detailed Description

Acquire a signature / reference.

This class encapsulates tablet entry within a canvas. It extends a java.awt.Canvas, all native calls are delegated to an XSPGuiAcquNative object that will be created internally. The XSPGuiAcquNative objects requires a native peer. Any calls to the XSPGuiAcquNative object will fail as long as the native peer is not yet setup. A SPSignwareException(SPSignwareException.APPLERR) will be thrown in that case.
You should not overload the function addNotify() for the above reason. If you have to override addNotify() then call super.addNotify()!

Heavy weight components overwrite light weight components (and vice versa), that means you cannot mix light weight components such as a javax.swing.JButton and heavy weight component. This applies especially when you register components that should be reachable with the tablet. Use heavy weight components such as a java.awt.Button instead.

See http://java.sun.com/developer/technicalArticles/GUI/mixing_components/index.html and http://java.sun.com/products/jfc/tsc/articles/mixing/ for mixing heavy and leight weight components

Signware also includes an object to capture signatures / references without native GUI, please read secGuiAcquVsAcquire for a comparison of SPAcquire and SPGuiAcqu.

Operating Systems:
Windows (Win32)


Public Member Functions

void acquire () throws SPSignwareException
 Start acquiry mode.
void acquireDone (int iResult) throws SPSignwareException
 End acquiry mode.
void addBackgroundDocument (String strDescription) throws SPSignwareException
 Add one or more Documents in the background image.
void addBackgroundDocument (byte[] baDescription) throws SPSignwareException
 Add one or more Documents in the background image.
void addBackgroundImage (String strDescription) throws SPSignwareException
 Add one or more Images in the background image.
void addBackgroundImage (byte[] baDescription) throws SPSignwareException
 Add one or more Images in the background image.
void addBackgroundObject (String strDescription) throws SPSignwareException
 Add one or more image and text fields in the background image.
void addBackgroundObject (byte[] baDescription) throws SPSignwareException
 Add one or more image and text fields in the background image.
void addBackgroundText (String strDescription) throws SPSignwareException
 Add one or more text fields in the background image.
void addBackgroundText (byte[] baDescription) throws SPSignwareException
 Add one or more text fields in the background image.
void addNotify ()
void clearEntries (int iFlags) throws SPSignwareException
 Clear all internal signature data of any acquiries within this object.
void connect (SPPropertyMap spDescriptor) throws SPSignwareException
 Connect to the associated SPTablet object.
void connect (String strTabletAlias) throws SPSignwareException
 Connect to the associated SPTablet object.
void connect (String strTabletClass, String strConfig) throws SPSignwareException
 Connect to the associated SPTablet object.
void connect (int iDriver) throws SPSignwareException
 Connect to the associated SPTablet object.
void createTablet (SPPropertyMap spDescriptor) throws SPSignwareException
 Create the associated SPTablet object base on an enumeration.
void createTablet (String strTabletAlias) throws SPSignwareException
 Create the associated SPTablet object base on an Alias.
void createTablet (String strTabletClass, String strConfig) throws SPSignwareException
 Create the associated SPTablet object.
void createTablet (int iDriver) throws SPSignwareException
 Create the associated SPTablet object.
void disconnect () throws SPSignwareException
 Disonnect from the associated SPTablet object.
void dispose ()
 Free the SDK object.
void documentCallback (int iDocId, int iRectId)
 Callback for a virtual button assigned to a document.
SPImage getBackgroundImage (int iSource) throws SPSignwareException
 Query the background image as it is displayed on the tablet or the PC screen.
String getBackgroundText (int iSource) throws SPSignwareException
 Query the background text as it is displayed on the tablet.
boolean getBoolProperty (String strName) throws SPSignwareException
 Query a property.
int getDrawMode () throws SPSignwareException
 Get the draw mode.
java.awt.Rectangle getHwndRect () throws SPSignwareException
 Get the size of the java Component associated with the SPGuiAcqu object.
int getIntProperty (String strName) throws SPSignwareException
 Query a property.
SPReference getReference () throws SPSignwareException
 Query the reference after a signature or reference signature acquiry.
SPSignature getSignature () throws SPSignwareException
 Query the signature during acquiry mode.
SPTablet getTablet () throws SPSignwareException
 Get the associated SPTablet object.
java.awt.Rectangle getTabletRect () throws SPSignwareException
 Get the size of the tablet rectangle within the java Component.
boolean isDoubleBuffered ()
 Turn off double buffering.
void paint (java.awt.Graphics g)
 Paint this panel.
void registerButtonAction (int iId, javax.swing.Action action)
 Register an action for hardware button events.
int registerComponent (java.awt.Rectangle rcl, int iFlags, javax.swing.Action action, int iId) throws SPSignwareException
 Register a virtual button.
int registerComponent (java.lang.String strDescription, javax.swing.Action action, int iId) throws SPSignwareException
 Register a virtual button.
int registerComponent (byte[] baDescription, javax.swing.Action action, int iId) throws SPSignwareException
 Register a button component.
int registerComponent (java.awt.Component component, int iFlags, javax.swing.Action action) throws SPSignwareException
 Register a button component.
void registerDocumentRect (int aId, byte[] baVirtualButtonDescription) throws SPSignwareException
 Register a virtual button in a document.
void registerDocumentRect (int aId, String strVirtualButtonDescription) throws SPSignwareException
 Register a virtual button in a document.
void removeBackgroundObjects () throws SPSignwareException
 Remove all text and image background objects.
void setActive (boolean bActive) throws SPSignwareException
 Activate / deactivate the acquiry mode.
void setBackground (java.awt.Color col)
 Set the background color of this canvas.
void setBackgroundImage (byte[] pucImage) throws SPSignwareException
 Set the background image of a tablet that includes a LCD display.
void setBackgroundObjects (SPBackgroundObjects spBackgroundObjects) throws SPSignwareException
 Set images, text fields or rectangles to the tablet LCD screen.
void setBoolProperty (String strName, boolean aValue) throws SPSignwareException
 Set a property.
void setDocumentContent (int aId, byte[] baContent) throws SPSignwareException
 Set the content of a document.
void setDocumentContent (int aId, String strContent) throws SPSignwareException
 Set the content of a document.
void setDrawMode (int iDrawMode) throws SPSignwareException
 Set the draw mode.
void setForeground (java.awt.Color col)
 Set the foreground color of this canvas.
void setIntProperty (String strName, int iValue) throws SPSignwareException
 Set a property.
void setTicket (SPTicket spTicket) throws SPSignwareException
 Pass a license for one or more signature captures.
void setTimeout (int iTimeout) throws SPSignwareException
 Set an inactivity timeout.
 SPGuiAcqu () throws SPSignwareException
 Instantiate an acquiry object with graphical representation.
void statusChanged (int iMajor, int iDetail)
 Callback that is invoked on hardware status changes, please read tablet status change notifications for more details.
void timeout ()
 Callback after some time of inactivity.
void unregisterAllComponents () throws SPSignwareException
 Unregister all registered components.
void unregisterComponent (int iId) throws SPSignwareException
 Unregister a button component.
void unregisterComponent (java.awt.Component component) throws SPSignwareException
 Unregister a button component.
void vectorCallback (int iX, int iY, int iP, int iT)
 Callback that is invoked on tablet vectors.

Static Public Attributes

static final int IDCANCEL = 2
 Constant for acquireDone Result Cancel.
static final int IDOK = 1
 Constant for acquireDone Result OK.
static final int SP_DISABLE_CURSOR = 0x20
 Flag to disable drawing a cursor at the pen position.
static final int SP_DRAW_BACKGROUND_IMAGE = 0x40
 Display the background image on the SPGuiAcqu screen and on the tablet, else display the background image on the tablet screen only.
static final int SP_DRAW_BUFFERED = 0x800
 Draw on buffer.
static final int SP_DRAW_MIRROR_TABLET = 0x400
 Mirror the tablet contents.
static final int SP_DRAW_ON_EXT_LCD = 0x00000002
 Flags in registerRect: draw the rectangle on the screen of the tablet device.
static final int SP_DRAW_ON_SCREEN = 0x00000004
 Flags in registerRect: draw the object on the PC screen.
static final int SP_DRAW_TABLET_BORDER = 1
 Flag to draw a border around the tablet region within the draw area.
static final int SP_DRAW_TABLET_IMAGE_IN_WINDOW = 0x100
 Draw mode flag: draw the tablet image in the acquiry window.
static final int SP_DRAW_WND_BORDER = 2
 Flag to draw a border around the draw area.
static final int SP_EMULATE_PEN_CURSOR = 0x10
 Flag to draw the cursor.
static final int SP_ERASE_BACKGROUND = 8
 Flag to erase the background.
static final int SP_ONLY_FOR_EXT_LCD = 0x00000008
 Flags in registerRect: Ignore the rectangle if the tablet does not integrate a separate lcd screen.
static final int SP_RELEASE_FOCUS = 4
 Flag to turn off acquiry when the process lost focus.
static final int SP_TABLET_COORDINATE = 0x00000001
 Flags in registerRect: The coordinates are based on the tablet outline.
static final int SP_VIRTUAL_BUTTON_CLICK = 0x200
 Draw mode flag: virtual button click mode.
static final int SP_VIRTUAL_BUTTON_MODE = 0x80
 Virtual button mode, do not display / process any vectors that do not refer to any virtual buttons.

Protected Member Functions

void checkHeavyWeight (java.awt.Component component, String strFct) throws SPSignwareException
 check if the component is a heavy component
void finalize () throws Throwable
 free the SDK object

Package Functions

void buttonPressed (int iId, int iPress)
 a hardware button was pressed, call the handler
void clicked (int iId)
XSPGuiAcquNative getNative ()
 Query the native object.

Static Package Functions

static int colorref (java.awt.Color col)


Constructor & Destructor Documentation

de.softpro.signware.SPGuiAcqu.SPGuiAcqu  )  throws SPSignwareException
 

Instantiate an acquiry object with graphical representation.

The acquiry object will draw directly on this component. SPGuiAcqu extends a heavy weight component (java.awt.Canvas) which is required by the native modules.

Operating Systems:
Windows (Win32)
See also:
SPGuiAcquCreate SPGuiAcqu comments


Member Function Documentation

void de.softpro.signware.SPGuiAcqu.acquire  )  throws SPSignwareException
 

Start acquiry mode.

Note:
Acquire mode may be dispatched and activated within the message processing thread (this restriction is required by some toblet drivers, e. g. MS TabletPC). This means that errors that occur while processing the state switch may not be passed to the application.
The application may set a timer to check the state of the tablet object, the state will be SP_TABLET_STATE_ACQUIRE on success
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquAcquire

void de.softpro.signware.SPGuiAcqu.acquireDone int  iResult  )  throws SPSignwareException
 

End acquiry mode.

Parameters:
iResult [i] result of the signature capture,
  • SP_IDOK signature is be accepted
  • SP_IDCANCEL signature is not accepted and will be ignored
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquAcquireDone, SP_IDOK, SP_IDCANCEL

void de.softpro.signware.SPGuiAcqu.addBackgroundDocument String  strDescription  )  throws SPSignwareException
 

Add one or more Documents in the background image.

Parameters:
strDescription [i] the document description, sec_XML_Data, sec_DocumentDescriptionDTD. The only supported encoding 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:
SPGuiAcquAddBackgroundDocument

void de.softpro.signware.SPGuiAcqu.addBackgroundDocument byte[]  baDescription  )  throws SPSignwareException
 

Add one or more Documents in the background image.

Parameters:
baDescription [i] the document description, sec_XML_Data, sec_DocumentDescriptionDTD. 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:
SPGuiAcquAddBackgroundDocument

void de.softpro.signware.SPGuiAcqu.addBackgroundImage String  strDescription  )  throws SPSignwareException
 

Add one or more Images in the background image.

Parameters:
strDescription [i] the image description, sec_XML_Data, sec_ImageDescriptionDTD. The only supported encoding 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:
SPGuiAcquAddBackgroundImage

void de.softpro.signware.SPGuiAcqu.addBackgroundImage byte[]  baDescription  )  throws SPSignwareException
 

Add one or more Images in the background image.

Parameters:
baDescription [i] the image description, sec_XML_Data, sec_ImageDescriptionDTD. 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:
SPGuiAcquAddBackgroundImage

void de.softpro.signware.SPGuiAcqu.addBackgroundObject String  strDescription  )  throws SPSignwareException
 

Add one or more image and text fields in the background image.

Parameters:
strDescription [i] the text field(s) description, see sec_XML_Data, sec_ObjectDescriptionDTD. The only supported encoding 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:
SPGuiAcquAddBackgroundObject

void de.softpro.signware.SPGuiAcqu.addBackgroundObject byte[]  baDescription  )  throws SPSignwareException
 

Add one or more image and text fields in the background image.

Parameters:
baDescription [i] the text field(s) description, see sec_XML_Data, sec_ObjectDescriptionDTD. 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:
SPGuiAcquAddBackgroundObject

void de.softpro.signware.SPGuiAcqu.addBackgroundText String  strDescription  )  throws SPSignwareException
 

Add one or more text fields in the background image.

Parameters:
strDescription [i] the text field(s) description, see sec_XML_Data, sec_TextDescriptionDTD. The only supported encoding 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:
SPGuiAcquAddBackgroundText

void de.softpro.signware.SPGuiAcqu.addBackgroundText byte[]  baDescription  )  throws SPSignwareException
 

Add one or more text fields in the background image.

Parameters:
baDescription [i] the text field(s) description, see sec_XML_Data, sec_TextDescriptionDTD. 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:
SPGuiAcquAddBackgroundText

void Component de::softpro::signware.SPGuiAcqu::addNotify  ) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Note:
Call super.addNotify() if you override this method!
Operating Systems:
Windows (Win32)

void de.softpro.signware.SPGuiAcqu.buttonPressed int  iId,
int  iPress
[package]
 

a hardware button was pressed, call the handler

void de.softpro.signware.SPGuiAcqu.checkHeavyWeight java.awt.Component  component,
String  strFct
throws SPSignwareException [protected]
 

check if the component is a heavy component

Parameters:
component [i] the component to check
strFct [i] name of the calling function (only for traces)
Exceptions:
SPSignwareException if the component is a lightweight component
Operating Systems:
Windows (Win32)

void de.softpro.signware.SPGuiAcqu.clearEntries int  iFlags  )  throws SPSignwareException
 

Clear all internal signature data of any acquiries within this object.

This function may be required to reenter a signature / reference when the prior entry was not accepted e.g. because the reference did not satisfy the quality criterias.

Operating Systems:
Windows (Win32)
Todo:
document iFlags

void de.softpro.signware.SPGuiAcqu.clicked int  iId  )  [package]
 

static int de.softpro.signware.SPGuiAcqu.colorref java.awt.Color  col  )  [static, package]
 

void de.softpro.signware.SPGuiAcqu.connect SPPropertyMap  spDescriptor  )  throws SPSignwareException
 

Connect to the associated SPTablet object.

Please read Tablet creation options for enumerating tablets

Note:
This function connects with the default tablet if spDescriptor is null
Parameters:
spDescriptor [i] descriptor of the desired tablet
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquConnectEx

void de.softpro.signware.SPGuiAcqu.connect String  strTabletAlias  )  throws SPSignwareException
 

Connect to the associated SPTablet object.

Please read Tablet creation options for resolving the Alias

Parameters:
strTabletAlias [i] alias name of the desired tablet
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquConnectEx

void de.softpro.signware.SPGuiAcqu.connect String  strTabletClass,
String  strConfig
throws SPSignwareException
 

Connect to the associated SPTablet object.

Please read Tablet creation options for a list of supported options

Parameters:
strTabletClass [i] class name of Kofax tablet access module
strConfig [i] pass optional configuration data. Configuration data depends on the detected hardware driver, see Installation and configuration of various pads
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquConnectEx

void de.softpro.signware.SPGuiAcqu.connect int  iDriver  )  throws SPSignwareException
 

Connect to the associated SPTablet object.

Please read Tablet creation options

Parameters:
iDriver [i] Driver number, pass SPTablet.SP_UNKNOWN_DRV to use any driver
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquConnect

void de.softpro.signware.SPGuiAcqu.createTablet SPPropertyMap  spDescriptor  )  throws SPSignwareException
 

Create the associated SPTablet object base on an enumeration.

This is a convenience function provided for applications that might need to access the tablet driver before it is connected. The tablet driver object will be created when it is internally required, the application does not have to call this function.
A typical sample could be to select an image per tablet device. Create the tablet driver object, query the device id, pass the device specific image and then connect to the tablet.

Please read Tablet creation options for enumerating tablets

Note:
This function creates a default tablet if spDescriptor is null
Parameters:
spDescriptor [i] descriptor of the desired tablet
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquCreateTabletByEnum

void de.softpro.signware.SPGuiAcqu.createTablet String  strTabletAlias  )  throws SPSignwareException
 

Create the associated SPTablet object base on an Alias.

This is a convenience function provided for applications that might need to access the tablet driver before it is connected. The tablet driver object will be created when it is internally required, the application does not have to call this function.
A typical sample could be to select an image per tablet device. Create the tablet driver object, query the device id, pass the device specific image and then connect to the tablet.

Please read Tablet creation options for resolving the Alias

Parameters:
strTabletAlias [i] alias name of the desired tablet
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquCreateTabletByAlias

void de.softpro.signware.SPGuiAcqu.createTablet String  strTabletClass,
String  strConfig
throws SPSignwareException
 

Create the associated SPTablet object.

This is a convenience function provided for applications that might need to access the tablet driver before it is connected. The tablet driver object will be created when it is internally required, the application does not have to call this function.
A typical sample could be to select an image per tablet device. Create the tablet driver object, query the device id, pass the device specific image and then connect to the tablet.

Please read Tablet creation options for a list of supported options

Parameters:
strTabletClass [i] class name of Kofax tablet access module.
strConfig [i] pass optional configuration data. Configuration data depends on the detected hardware driver, see Installation and configuration of various pads
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquCreateTabletEx

void de.softpro.signware.SPGuiAcqu.createTablet int  iDriver  )  throws SPSignwareException
 

Create the associated SPTablet object.

This is a convenience function provided for applications that might need to access the tablet driver before it is connected. The tablet driver object will be created when it is internally required, the application does not have to call this function.
A typical sample could be to select an image per tablet device. Create the tablet driver object, query the device id, pass the device specific image and then connect to the tablet.

Please read Tablet creation options

Parameters:
iDriver [i] Driver number, pass SPTablet.SP_UNKNOWN_DRV to use any driver
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquCreateTablet

void de.softpro.signware.SPGuiAcqu.disconnect  )  throws SPSignwareException
 

Disonnect from the associated SPTablet object.

Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquDisconnect

void de.softpro.signware.SPGuiAcqu.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)

void de.softpro.signware.SPGuiAcqu.documentCallback int  iDocId,
int  iRectId
 

Callback for a virtual button assigned to a document.

Override this method to do any action on document events.

void de.softpro.signware.SPGuiAcqu.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.

See also:
dispose

SPImage de.softpro.signware.SPGuiAcqu.getBackgroundImage int  iSource  )  throws SPSignwareException
 

Query the background image as it is displayed on the tablet or the PC screen.

The image will not contain any partial or fully entered signature strokes.

Parameters:
iSource [i] select the source of the image
  • 1 PC screen
  • 2 Tablet LCD
Returns:
the resulting image as a SPImage object
Exceptions:
SPSignwareException on error
  • SP_PARAMERR any parameter was was wrong
  • SP_MEMERR out of memory
  • SP_LINKLIBRARYERR external modules could not be loaded
Operating Systems:
Windows (Win32)

String de.softpro.signware.SPGuiAcqu.getBackgroundText int  iSource  )  throws SPSignwareException
 

Query the background text as it is displayed on the tablet.

Parameters:
iSource [i] select the source of the text
  • 1 PC screen
  • 2 Tablet LCD
Returns:
the resulting text
Exceptions:
SPSignwareException on error
  • SP_MEMERR out of memory
  • SP_LINKLIBRARYERR external modules could not be loaded
Operating Systems:
Windows (Win32)
See also:
SPAcquireGetBackgroundText

boolean de.softpro.signware.SPGuiAcqu.getBoolProperty String  strName  )  throws SPSignwareException
 

Query a property.

Parameters:
strName [i] Name of the property, see SPGuiAcqu Properties
Returns:
boolean, the value of the property
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
Since:
SPSignware Version 3.2

int de.softpro.signware.SPGuiAcqu.getDrawMode  )  throws SPSignwareException
 

Get the draw mode.

Returns:
int the draw mode, a ccombination of these flags:
  • SP_DRAW_TABLET_BORDER
  • SP_DRAW_HWND_BORDER
  • SP_ERASE_BACKGROUND
  • SP_RELEASE_FOCUS
  • SP_EMULATE_PEN_CURSOR
  • SP_DRAW_BACKGROUND_IMAGE
  • SP_VIRTUAL_BUTTON_MODE
  • SP_DRAW_TABLET_IMAGE_IN_WINDOW
  • SP_DRAW_MIRROR_TABLET
  • SP_VIRTUAL_BUTTON_CLICK
  • SP_DRAW_BUFFERED
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquGetDrawMode, getBoolProperty

java.awt.Rectangle de.softpro.signware.SPGuiAcqu.getHwndRect  )  throws SPSignwareException
 

Get the size of the java Component associated with the SPGuiAcqu object.

Returns:
java.awt.Rectangle the size of the java Component
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquGetHwndRect

int de.softpro.signware.SPGuiAcqu.getIntProperty String  strName  )  throws SPSignwareException
 

Query a property.

Parameters:
strName [i] Name of the property, see SPGuiAcqu Properties
Returns:
int, the value of the property
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)

XSPGuiAcquNative de.softpro.signware.SPGuiAcqu.getNative  )  [package]
 

Query the native object.

Applications should not need to call this method. Please contact Kofax if your application needs to access the native object before using the native object.

Returns:
XSPGuiAcquNative the native object
Operating Systems:
Windows (Win32)

SPReference de.softpro.signware.SPGuiAcqu.getReference  )  throws SPSignwareException
 

Query the reference after a signature or reference signature acquiry.

The returned Reference may contain a single signature, in this case a signature was captured, or multiple signatures when a true reference was captured. It is the responsability of the application to convert the reference to a signature, if the returned object includes a single signature.

This is a convenience function which behaves exactly like SPReference(SPGuiAcqu).

Returns:
the actual acquired refence or signature returned as a reference
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)

SPSignature de.softpro.signware.SPGuiAcqu.getSignature  )  throws SPSignwareException
 

Query the signature during acquiry mode.

The returned signature need not contain all captured vectors. This function is provided to check for empty signatures BEFORE accepting the signature (see SPGuiAcquAcquireDone).

This is a convenience function which behaves exactly like SPSignature(SPGuiAcqu).

Note:
An error will be thrown when not in acquiry mode.
Returns:
SPSignature: the actual acquired signature
Operating Systems:
Windows (Win32)
Exceptions:
SPSignwareException on error

SPTablet de.softpro.signware.SPGuiAcqu.getTablet  )  throws SPSignwareException
 

Get the associated SPTablet object.

The returned tablet object is intended to query additional information such as sample rate etc, but you cannot use it to set listeners or to start acquiry mode directly.

Returns:
SPTablet the tablet object
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquGetTablet

java.awt.Rectangle de.softpro.signware.SPGuiAcqu.getTabletRect  )  throws SPSignwareException
 

Get the size of the tablet rectangle within the java Component.

Returns:
java.awt.Rectangle the size of the tablet rectangle
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquGetTabletRect

boolean de.softpro.signware.SPGuiAcqu.isDoubleBuffered  ) 
 

Turn off double buffering.

Overrides Component.isDoubleBuffered. The implementation is optimized for direct drawing on the graphics context, and should thus turn off double buffering

Returns:
boolean always false

void de.softpro.signware.SPGuiAcqu.paint java.awt.Graphics  g  ) 
 

Paint this panel.

Overrides Panel.paint(java.awt.Graphics). The native implementation send a Paint message to the native window

Parameters:
g [io] the graphics context

void de.softpro.signware.SPGuiAcqu.registerButtonAction int  iId,
javax.swing.Action  action
 

Register an action for hardware button events.


The action will be called when a hardware button is pressed on the tablet. The ID - assignment may depend on the connected tablet.
Please call registerComponent to create and register virtual buttons

Parameters:
iId [i] the identification of the button. The value depends on the tablet, see Tablet Hardware button Assignment
action [i] the action to call when the button is pressed
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquSetButtonListener, SPTabletSetButtonListener

int de.softpro.signware.SPGuiAcqu.registerComponent java.awt.Rectangle  rcl,
int  iFlags,
javax.swing.Action  action,
int  iId
throws SPSignwareException
 

Register a virtual button.

Parameters:
rcl [i] the rectangle of the button to be registered
iFlags [i] drawing flags for the component
  • SP_TABLET_COORDINATE
  • SP_DRAW_ON_EXT_LCD
  • SP_DRAW_ON_SCREEN
  • SP_ONLY_FOR_EXT_LCD
action [i] the action to call when the tablet clicks the component
iId [i] a unique id of the registered rectangle.
  • If iId is 0 then a new virtual button will be created. registerComponent will return the actual Id that was assigned to the button.
  • If iId is not 0 and a virtual button with the same Id is already registered then the existing virtual button will be updated
  • If iId is not 0 and a virtual button with the same Id is not yet registered then a new virtual button will be created. The Id of the new virtual button will be returned.
Returns:
int the registered unique id of the rectangle
Exceptions:
SPSignwareException on error
Deprecated:
Please use de.softpro.signware.SPGuiAcqu.registerComponent(java.lang.String, javax.swing.Action, int) instead
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquRegisterRect

unregisterComponent SPGuiAcqu comments

int de.softpro.signware.SPGuiAcqu.registerComponent java.lang.String  strDescription,
javax.swing.Action  action,
int  iId
throws SPSignwareException
 

Register a virtual button.

Parameters:
strDescription [i] the XML description of the virtual button to be registered, sec_XML_Data, sec_VirtualButtonDescriptionDTD. The only supported encoding in the XML declaration is UTF-8
action [i] the action to call when the tablet clicks the component
iId [i] a unique id of the registered rectangle.
  • If iId is 0 then a new virtual button will be created. registerComponent will return the actual Id that was assigned to the button.
  • If iId is not 0 and a virtual button with the same Id is already registered then the existing virtual button will be updated with the passed descriptor
  • If iId is not 0 and a virtual button with the same Id is not yet registered then a new virtual button will be created. The Id of the new virtual button will be returned.
Returns:
int the registered unique id of the virtual button
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquRegisterRect2, unregisterComponent SPGuiAcqu comments

int de.softpro.signware.SPGuiAcqu.registerComponent byte[]  baDescription,
javax.swing.Action  action,
int  iId
throws SPSignwareException
 

Register a button component.

Parameters:
baDescription [i] the XML description of the rectangle to be registered, sec_XML_Data, sec_VirtualButtonDescriptionDTD. Supported encodings in the XML declaration are ASCII, UTF-8, and ISO-8859-1
action [i] the action to call when the tablet clicks the component
iId [i] a unique id of the virtual button.
  • If iId is 0 then a new virtual button will be created. registerRect will return the actual Id that was assigned to the button.
  • If iId is not 0 and a virtual button with the same Id is already registered then the existing virtual button will be updated with the passed descriptor
  • If iId is not 0 and a virtual button with the same Id is not yet registered then a new virtual button will be created. The Id of the new virtual button will be returned.
Returns:
int the registered unique id of the rectangle
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquRegisterRect2, unregisterComponent
SPGuiAcqu comments

int de.softpro.signware.SPGuiAcqu.registerComponent java.awt.Component  component,
int  iFlags,
javax.swing.Action  action
throws SPSignwareException
 

Register a button component.

Supported components:

  • javax.swing.AbstractButton and all its inherited classes
Parameters:
component [i] the component to be registered
iFlags [i] drawing flags for the component
  • SP_TABLET_COORDINATE
  • SP_DRAW_ON_EXT_LCD
  • SP_DRAW_ON_SCREEN
  • SP_ONLY_FOR_EXT_LCD
action [i] the action to call when the tablet clicks the component
Returns:
int the registered unique id of the rectangle
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquRegisterComponent

unregisterComponent SPGuiAcqu comments

void de.softpro.signware.SPGuiAcqu.registerDocumentRect int  aId,
byte[]  baVirtualButtonDescription
throws SPSignwareException
 

Register a virtual button in a document.

Note:
The virtual button description includes an id which may not be 0. The button id should be a unique id for each button. Subsequent registrations of virtual buttons with the same id will modify the already registered virtual button, e. g. set an icon, or move the button.
Parameters:
aId [i] the unique identifyer of the document
baVirtualButtonDescription [i] description of the rectangle position, size, text, font etc. Please see element SPSWVirtualButton in sec_VirtualButtonDescriptionDTD for details.
Returns:
SP_NOERR on success, else error code:
See also:
setDocumentContent, addBackgroundDocument, SPGuiAcquRegisterDocumentRect

sec_DocumentDescriptionDTD

void de.softpro.signware.SPGuiAcqu.registerDocumentRect int  aId,
String  strVirtualButtonDescription
throws SPSignwareException
 

Register a virtual button in a document.

Note:
The virtual button description includes an id which may not be 0. The button id should be a unique id for each button. Subsequent registrations of virtual buttons with the same id will modify the already registered virtual button, e. g. set an icon, or move the button.
Parameters:
aId [i] the unique identifyer of the document
strVirtualButtonDescription [i] description of the rectangle position, size, text, font etc. Please see element SPSWVirtualButton in sec_VirtualButtonDescriptionDTD for details. The only supported encoding in the XML declaration is UTF-8
Returns:
SP_NOERR on success, else error code:
See also:
setDocumentContent, addBackgroundDocument, SPGuiAcquRegisterDocumentRect

sec_DocumentDescriptionDTD

void de.softpro.signware.SPGuiAcqu.removeBackgroundObjects  )  throws SPSignwareException
 

Remove all text and image background objects.

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:
SPGuiAcquRemoveBackgroundObjects

void de.softpro.signware.SPGuiAcqu.setActive boolean  bActive  )  throws SPSignwareException
 

Activate / deactivate the acquiry mode.

Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquSetActive

void de.softpro.signware.SPGuiAcqu.setBackground java.awt.Color  col  ) 
 

Set the background color of this canvas.

Parameters:
col [i] the background color
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquSetBackgroundColor

void de.softpro.signware.SPGuiAcqu.setBackgroundImage byte[]  pucImage  )  throws SPSignwareException
 

Set the background image of a tablet that includes a LCD display.

Parameters:
pucImage [i] the image data, most standard image formats such as BMP, TIF, JPG, GIF CCITT4 etc are supported
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)

void de.softpro.signware.SPGuiAcqu.setBackgroundObjects SPBackgroundObjects  spBackgroundObjects  )  throws SPSignwareException
 

Set images, text fields or rectangles to the tablet LCD screen.

Use SPBackgroundObjects.readFile or SPBackgroundObjects.readXML to create the background objects container. The proper objects will be selected based on the created tablet type, and all elements of the selected objects will be copied to the background

Note:
This object must have a vald tablet object, see createTablet, connect and must not be in aquiry state.
All existing background objects will be deleted and the new objects will be added, see removeBackgroundObjects
Parameters:
spBackgroundObjects [i] a SPBackgroundObjects object.
Exceptions:
SPSignwareException on error
  • SP_PARAMERR invalid parameter
  • SP_APPLERR cannot change background in acquiry mode or no tablet instantiated
Operating Systems:
Windows (Win32)

void de.softpro.signware.SPGuiAcqu.setBoolProperty String  strName,
boolean  aValue
throws SPSignwareException
 

Set a property.

Parameters:
strName [i] Name of the property, see SPGuiAcqu Properties
aValue [i] the value of the property
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)
Since:
SPSignware Version 3.2

void de.softpro.signware.SPGuiAcqu.setDocumentContent int  aId,
byte[]  baContent
throws SPSignwareException
 

Set the content of a document.

Use addBackgroundDocument or addBackgroundObject or setBackgroundObjects to define the layout of a document view. setDocumentContent may the be used to dynamically set the document content.

Parameters:
aId [i] the unique identifyer of the document
baContent [i] document contents as a byte array
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
addBackgroundObject, addBackgroundDocument, removeBackgroundObjects

SPGuiAcquSetDocumentContent

void de.softpro.signware.SPGuiAcqu.setDocumentContent int  aId,
String  strContent
throws SPSignwareException
 

Set the content of a document.

Use addBackgroundDocument or addBackgroundObject or setBackgroundObjects to define the layout of a document view. setDocumentContent may the be used to dynamically set the document content.

Parameters:
aId [i] the unique identifyer of the document
strContent [i] fully qualified file name of the document
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32)
See also:
addBackgroundObject, addBackgroundDocument, removeBackgroundObjects

SPGuiAcquSetDocumentContent

void de.softpro.signware.SPGuiAcqu.setDrawMode int  iDrawMode  )  throws SPSignwareException
 

Set the draw mode.

Note:
In a java environment the emulated mouse cursor may not be erased in all cases, it is thus not recommended to use SP_EMULATE_PEN_CURSOR.

On Tablet PCs it might be useful to turn off pen cursors (

See also:
SP_DISABLE_CURSOR)
Parameters:
iDrawMode [i] the draw mode, a combination of the flags:
  • SP_DRAW_TABLET_BORDER
  • SP_DRAW_HWND_BORDER
  • SP_ERASE_BACKGROUND
  • SP_RELEASE_FOCUS
  • SP_EMULATE_PEN_CURSOR
  • SP_DRAW_BACKGROUND_IMAGE
  • SP_VIRTUAL_BUTTON_MODE
  • SP_DRAW_TABLET_IMAGE_IN_WINDOW
  • SP_DRAW_MIRROR_TABLET
  • SP_VIRTUAL_BUTTON_CLICK
  • SP_DRAW_BUFFERED
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquGetDrawMode, setBoolProperty

void de.softpro.signware.SPGuiAcqu.setForeground java.awt.Color  col  ) 
 

Set the foreground color of this canvas.

Parameters:
col [i] the foreground color
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquSetForegroundColor

void de.softpro.signware.SPGuiAcqu.setIntProperty String  strName,
int  iValue
throws SPSignwareException
 

Set a property.

Parameters:
strName [i] Name of the property, see SPGuiAcqu Properties
iValue [i] the value of the property
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)

void de.softpro.signware.SPGuiAcqu.setTicket SPTicket  spTicket  )  throws SPSignwareException
 

Pass a license for one or more signature captures.

You must pass the ticket before you connect with the tablet. The ticket must have been charged for usage SPTicket.ticket_capture.

Deprecated:
Please use a license key.
Parameters:
spTicket [i] a valid and charged ticket
Exceptions:
SPSignwareException 
Deprecated:
Use de.softpro.signware.SPSignware.setTicket instead
Operating Systems:
Windows (Win32)

void de.softpro.signware.SPGuiAcqu.setTimeout int  iTimeout  )  throws SPSignwareException
 

Set an inactivity timeout.

SignWare will call the method timeout when the time [in msecs] has passed without any tablet action

Parameters:
iTimeout [i] timeout in mseconds
Operating Systems:
Windows (Win32)

void de.softpro.signware.SPGuiAcqu.statusChanged int  iMajor,
int  iDetail
 

Callback that is invoked on hardware status changes, please read tablet status change notifications for more details.

Override this method to do any action on hardware status changes

Parameters:
iMajor [i] major event descriptor
iDetail [i] detailled event description

void de.softpro.signware.SPGuiAcqu.timeout  ) 
 

Callback after some time of inactivity.

Override this method to do any action on a timeout.

void de.softpro.signware.SPGuiAcqu.unregisterAllComponents  )  throws SPSignwareException
 

Unregister all registered components.

Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquUnregisterAllComponents

void de.softpro.signware.SPGuiAcqu.unregisterComponent int  iId  )  throws SPSignwareException
 

Unregister a button component.

Note:
The identification of a component is returned in the registerComponent call.
Parameters:
iId [i] the id of the component to be unregistered
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquUnregisterComponent

registerComponent

void de.softpro.signware.SPGuiAcqu.unregisterComponent java.awt.Component  component  )  throws SPSignwareException
 

Unregister a button component.

Parameters:
component [i] the component to be unregistered
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiAcquUnregisterComponent

registerComponent SPGuiAcqu

void de.softpro.signware.SPGuiAcqu.vectorCallback int  iX,
int  iY,
int  iP,
int  iT
 

Callback that is invoked on tablet vectors.

Override this method to do any action on tablet vectors

Note:
Tablet vectors are handled internally, normally the application ignores tablet vectors
Parameters:
iX [i] x-coordinate
iY [i] y-coordinate
iP [i] pressure level
iT [i] timestamp, may be -1 if not measured


Member Data Documentation

final int de.softpro.signware.SPGuiAcqu.IDCANCEL = 2 [static]
 

Constant for acquireDone Result Cancel.

final int de.softpro.signware.SPGuiAcqu.IDOK = 1 [static]
 

Constant for acquireDone Result OK.

final int de.softpro.signware.SPGuiAcqu.SP_DISABLE_CURSOR = 0x20 [static]
 

Flag to disable drawing a cursor at the pen position.

See also:
SPSignware.SP_DISABLE_CURSOR

setDrawMode

final int de.softpro.signware.SPGuiAcqu.SP_DRAW_BACKGROUND_IMAGE = 0x40 [static]
 

Display the background image on the SPGuiAcqu screen and on the tablet, else display the background image on the tablet screen only.

See also:
setDrawMode, SPSignware.SP_DRAW_ON_SCREEN
Note:
SP_DRAW_ON_SCREEN and SP_DRAW_BACKGROUND_IMAGE are exclusive flags, the button will always be drawn on the screen if SP_DRAW_BACKGROUND_IMAGE is set

final int de.softpro.signware.SPGuiAcqu.SP_DRAW_BUFFERED = 0x800 [static]
 

Draw on buffer.

Draw the contents of the entry window on a memory device context and copy the final image to the screen context to prevent flicker when updating the screen

See also:
setDrawMode, SPSignware.SP_DRAW_BUFFERED

final int de.softpro.signware.SPGuiAcqu.SP_DRAW_MIRROR_TABLET = 0x400 [static]
 

Mirror the tablet contents.

Note:
This flag will be ignored on full screen devices (such as TabletPC). It will mirror (exactly rotate by 180 degrees) the contents of LCD screen on the pad (if applicable) and mirror all vectors from the pad.
With this flag you may use the pad 'upside down'.
See also:
setDrawMode, SPSignware.SP_DRAW_MIRROR_TABLET

final int de.softpro.signware.SPGuiAcqu.SP_DRAW_ON_EXT_LCD = 0x00000002 [static]
 

Flags in registerRect: draw the rectangle on the screen of the tablet device.

This flag only applies to tablets with integrated lcd screen.

See also:
registerComponent(java.awt.Rectangle, int, javax.swing.Action, int), registerComponent(java.awt.Component, int, javax.swing.Action)

final int de.softpro.signware.SPGuiAcqu.SP_DRAW_ON_SCREEN = 0x00000004 [static]
 

Flags in registerRect: draw the object on the PC screen.

See also:
registerComponent(java.awt.Rectangle, int, javax.swing.Action, int), registerComponent(java.awt.Component, int, javax.swing.Action)

final int de.softpro.signware.SPGuiAcqu.SP_DRAW_TABLET_BORDER = 1 [static]
 

Flag to draw a border around the tablet region within the draw area.

See also:
SPSignware.SP_DRAW_TABLET_BORDER

setDrawMode

final int de.softpro.signware.SPGuiAcqu.SP_DRAW_TABLET_IMAGE_IN_WINDOW = 0x100 [static]
 

Draw mode flag: draw the tablet image in the acquiry window.

If this flag is set, then a copy of the image that was sent to the tablet will be rendered in the acquiry window.

Note:
This flag should normally not be set because it looks nicer if, e.g., text is directly rendered into the window. It may however be useful to see the tablet's display on the PC for debugging purposes.
See also:
setDrawMode, SPSignware.SP_DRAW_TABLET_IMAGE_IN_WINDOW

final int de.softpro.signware.SPGuiAcqu.SP_DRAW_WND_BORDER = 2 [static]
 

Flag to draw a border around the draw area.

See also:
SPSignware.SP_DRAW_WND_BORDER

setDrawMode

final int de.softpro.signware.SPGuiAcqu.SP_EMULATE_PEN_CURSOR = 0x10 [static]
 

Flag to draw the cursor.

See also:
SPSignware.SP_DRAW_EMULATE_CURSOR

setDrawMode

final int de.softpro.signware.SPGuiAcqu.SP_ERASE_BACKGROUND = 8 [static]
 

Flag to erase the background.

See also:
SPSignware.SP_ERASE_BACKGROUND

setDrawMode

final int de.softpro.signware.SPGuiAcqu.SP_ONLY_FOR_EXT_LCD = 0x00000008 [static]
 

Flags in registerRect: Ignore the rectangle if the tablet does not integrate a separate lcd screen.

See also:
registerComponent(java.awt.Rectangle, int, javax.swing.Action, int), registerComponent(java.awt.Component, int, javax.swing.Action)

final int de.softpro.signware.SPGuiAcqu.SP_RELEASE_FOCUS = 4 [static]
 

Flag to turn off acquiry when the process lost focus.

See also:
SPSignware.SP_RELEASE_FOCUS

setDrawMode

final int de.softpro.signware.SPGuiAcqu.SP_TABLET_COORDINATE = 0x00000001 [static]
 

Flags in registerRect: The coordinates are based on the tablet outline.

See also:
registerComponent(java.awt.Rectangle, int, javax.swing.Action, int), registerComponent(java.awt.Component, int, javax.swing.Action)

final int de.softpro.signware.SPGuiAcqu.SP_VIRTUAL_BUTTON_CLICK = 0x200 [static]
 

Draw mode flag: virtual button click mode.

if this flag is set then virtual buttons are clicked when the pen is pressed and released in the virtual button region.
if this flag is not set then virtual buttons are clicked when the pen is pressed in the virtual button region

See also:
setDrawMode, SPSignware.SP_VIRTUAL_BUTTON_CLICK

final int de.softpro.signware.SPGuiAcqu.SP_VIRTUAL_BUTTON_MODE = 0x80 [static]
 

Virtual button mode, do not display / process any vectors that do not refer to any virtual buttons.

You may define virtual buttons, and they will send events when clicked, but no strokes will be displayed.

See also:
setDrawMode, SPSignware.SP_VIRTUAL_BUTTON_MODE
Note:
Most tablets with LCD screen will echo strokes to the integrated LCD even when this flag is set. Kofax is in cotact with the tablet manufacturers to add supporting this feature in future versions.


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