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
|
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.
|
Member Function Documentation
|
Start acquiry mode.
|
|
End acquiry mode.
|
|
Add one or more Documents in the background image.
|
|
Add one or more Documents in the background image.
|
|
Add one or more Images in the background image.
|
|
Add one or more Images in the background image.
|
|
Add one or more image and text fields in the background image.
|
|
Add one or more image and text fields in the background image.
|
|
Add one or more text fields in the background image.
|
|
Add one or more text fields in the background image.
|
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
|
a hardware button was pressed, call the handler
|
|
check if the component is a heavy component
|
|
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.
|
|
|
|
|
|
Connect to the associated SPTablet object. Please read Tablet creation options for enumerating tablets
|
|
Connect to the associated SPTablet object. Please read Tablet creation options for resolving the Alias
|
|
Connect to the associated SPTablet object. Please read Tablet creation options for a list of supported options
|
|
Connect to the associated SPTablet object. Please read Tablet creation options
|
|
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. Please read Tablet creation options for enumerating tablets
|
|
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. Please read Tablet creation options for resolving the Alias
|
|
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. Please read Tablet creation options for a list of supported options
|
|
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. Please read Tablet creation options
|
|
Disonnect from the associated SPTablet object.
|
|
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.
|
|
Callback for a virtual button assigned to a document. Override this method to do any action on document events. |
|
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.
|
|
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.
|
|
Query the background text as it is displayed on the tablet.
|
|
Query a property.
|
|
Get the draw mode.
|
|
Get the size of the java Component associated with the SPGuiAcqu object.
|
|
Query a property.
|
|
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.
|
|
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).
|
|
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).
|
|
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.
|
|
Get the size of the tablet rectangle within the java Component.
|
|
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
|
|
Paint this panel. Overrides Panel.paint(java.awt.Graphics). The native implementation send a Paint message to the native window
|
|
Register an action for hardware button events.
|
|
Register a virtual button.
|
|
Register a virtual button.
|
|
Register a button component.
|
|
Register a button component. Supported components:
|
|
Register a virtual button in a document.
|
|
Register a virtual button in a document.
|
|
Remove all text and image background objects.
|
|
Activate / deactivate the acquiry mode.
|
|
Set the background color of this canvas.
|
|
Set the background image of a tablet that includes a LCD display.
|
|
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
|
|
Set a property.
|
|
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.
|
|
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.
|
|
Set the draw mode.
|
|
Set the foreground color of this canvas.
|
|
Set a property.
|
|
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.
|
|
Set an inactivity timeout. SignWare will call the method timeout when the time [in msecs] has passed without any tablet action
|
|
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
|
|
Callback after some time of inactivity. Override this method to do any action on a timeout. |
|
Unregister all registered components.
|
|
Unregister a button component.
|
|
Unregister a button component.
|
|
Callback that is invoked on tablet vectors. Override this method to do any action on tablet vectors
|
Member Data Documentation
|
Constant for acquireDone Result Cancel.
|
|
Constant for acquireDone Result OK.
|
|
Flag to disable drawing a cursor at the pen position.
|
|
Display the background image on the SPGuiAcqu screen and on the tablet, else display the background image on the tablet screen only.
|
|
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
|
|
Mirror the tablet contents.
|
|
Flags in registerRect: draw the rectangle on the screen of the tablet device. This flag only applies to tablets with integrated lcd screen.
|
|
Flags in registerRect: draw the object on the PC screen.
|
|
Flag to draw a border around the tablet region within the draw area.
|
|
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.
|
|
Flag to draw a border around the draw area.
|
|
Flag to draw the cursor.
|
|
Flag to erase the background.
|
|
Flags in registerRect: Ignore the rectangle if the tablet does not integrate a separate lcd screen.
|
|
Flag to turn off acquiry when the process lost focus.
|
|
Flags in registerRect: The coordinates are based on the tablet outline.
|
|
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.
|
|
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.
|
The documentation for this class was generated from the following file: