visit Kofax web site

de.softpro.signware.SPJGuiContainer Class Reference

List of all members.

Detailed Description

The container may hold one or more SignWare Gui (SPGuiAcqu, SPJGuiDisp or SPJGuiDyn) objects. The container includes a layout manager to display the objects horizontally tiled, vertically tiled or stacked.


Callbacks / event notifications are redirected from the capture object to the container, and then to the application.


Callbacks are called from the java message event thread.
Do not free the SPContainer object within a callback method.

Note:
The class SPJGuiContainer is implemented as a java component. All embedded objects create a java.awt.Panel as the main GUI component, which will be subclassed by the core Signware objects.
Operating Systems:
Windows (Win32)


Public Member Functions

void addObject (int iType) throws SPSignwareException
 Create a Signware object of type iType and insert it at the last position of the list.
void buttonCallback (int iIndex, int iButtonId)
 Callback function called when a hardware button is pressed.
void createObject (int iIndex, int iType) throws SPSignwareException
 Create a Signware object of type iType and insert it at the specified index of the list. If the list contains an object at the specified position then the existing object will be deleted and replaced by the new object.
void dispose ()
 free the SDK object(s)
void documentCallback (int iIndex, int iDocId, int iRectId)
 Callback function called when a virtual button (rectangle), that is assigned o a document, is clicked.
void freeObject (int iIndex) throws SPSignwareException
 Free a Signware object at the specified index of the list. If the list contains an object at the specified position then the existing object will be deleted.
boolean getBoolProperty (String strName) throws SPSignwareException
 Query a property.
int getIntProperty (String strName) throws SPSignwareException
 Query a property.
int getNumberObjects () throws SPSignwareException
 Query the number of Signware objects in the list.
SPSignwareObject getObject (int iIndex) throws SPSignwareException
 Get a reference to the Signware object at the specified index of the list. The returned object is either a SPJGuiAcqu, SPJGuiDisp or SPJGuiDyn instance.
int getObjectType (int iIndex) throws SPSignwareException
 Query the type of the Signware object at the specified index of the list.
Panel getPanel (int iIndex) throws SPSignwareException
 Get a reference to the Panel object at the specified index of the list.
void rectCallback (int iIndex, int iId)
 Callback function called when a virtual button (rectangle) is clicked.
void setActive (int iIndex) throws SPSignwareException
 Activate the object at the specified index of the list.
void setBoolProperty (String strName, boolean bValue) throws SPSignwareException
 Set a property.
void setIntProperty (String strName, int iValue) throws SPSignwareException
 Set a property.
 SPJGuiContainer () throws SPSignwareException
 Constructor.
void statusChanged (int iIndex, int iMajor, int iDetail)
 Callback function that is called on status changes.
void timeoutCallback (int iIndex)
 Callback function called after some time of inactivity.
void vectorCallback (int iIndex, int iX, int iY, int iP, int iT)
 Callback function that is called when the tablet sends a vector.

Static Public Attributes

static final int SP_JGUIACQU = 1
 Type identifyer for a SPJGuiAcqu object.
static final int SP_JGUIDISP = 2
 Type identifyer for a SPJGuiDisp object.
static final int SP_JGUIDYN = 3
 Type identifyer for a SPJGuiDyn object.
static final int SP_STACKED = 3
 Type identifyer for stacked layout, see Property "Layout".
static final int SP_TILED_HORZ = 1
 Type identifyer for horizontally tiled layout, see Property "Layout".
static final int SP_TILED_VERT = 2
 Type identifyer for vertically tiled layout, see Property "Layout".


Constructor & Destructor Documentation

de.softpro.signware.SPJGuiContainer.SPJGuiContainer  )  throws SPSignwareException
 

Constructor.

Operating Systems:
Windows (Win32)


Member Function Documentation

void de.softpro.signware.SPJGuiContainer.addObject int  iType  )  throws SPSignwareException
 

Create a Signware object of type iType and insert it at the last position of the list.

Parameters:
iType [i] object type
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)

void de.softpro.signware.SPJGuiContainer.buttonCallback int  iIndex,
int  iButtonId
 

Callback function called when a hardware button is pressed.

Override this method to do any action when a hardware button is pressed. Call acquireDone() for the according object to end acquiry mode.
The default implementation does nothing.

Parameters:
iIndex [i] zero based index in the list of embedded objects
iButtonId [i] a value identifying the button that was pressed. The value depends on the tablet, see Tablet Hardware button Assignment
See also:
acquireDone(), rectCallback()

void de.softpro.signware.SPJGuiContainer.createObject int  iIndex,
int  iType
throws SPSignwareException
 

Create a Signware object of type iType and insert it at the specified index of the list. If the list contains an object at the specified position then the existing object will be deleted and replaced by the new object.

Parameters:
iIndex [i] zero based index in the list
iType [i] object type
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)

void de.softpro.signware.SPJGuiContainer.dispose  ) 
 

free the SDK object(s)

The finalize method is called by the garbage collector, and should not be invoked from the application. Use dispose() to free a SDK object.

Operating Systems:
Windows (Win32)
See also:
dispose

void de.softpro.signware.SPJGuiContainer.documentCallback int  iIndex,
int  iDocId,
int  iRectId
 

Callback function called when a virtual button (rectangle), that is assigned o a document, is clicked.

Parameters:
iIndex [i] zero based index in the list of embedded objects
iDocId [i] Identifier of the associated document
iRectId [i] Identifier of the clicked Rectangle
Override this method to do any action when a virtual button (rectangle) is clicked. Call acquireDone() to end acquiry mode.

See also:
acquireDone(), registerDocumentRect()

void de.softpro.signware.SPJGuiContainer.freeObject int  iIndex  )  throws SPSignwareException
 

Free a Signware object at the specified index of the list. If the list contains an object at the specified position then the existing object will be deleted.

Note:
The indices of all successive objects will change. SPJGuiContainer inherits a property "ObjectId" when creating objects, the application may use the property "ObjectId" to keep track of objects in the container.
Parameters:
iIndex [i] zero based index in the list
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)

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

Query a property.

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

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

Query a property.

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

int de.softpro.signware.SPJGuiContainer.getNumberObjects  )  throws SPSignwareException
 

Query the number of Signware objects in the list.

Returns:
int the number of objects
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)

SPSignwareObject de.softpro.signware.SPJGuiContainer.getObject int  iIndex  )  throws SPSignwareException
 

Get a reference to the Signware object at the specified index of the list. The returned object is either a SPJGuiAcqu, SPJGuiDisp or SPJGuiDyn instance.

Parameters:
iIndex [i] zero based index in the list
Returns:
SPSignwareObject a reference to the object at the specified index
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)

int de.softpro.signware.SPJGuiContainer.getObjectType int  iIndex  )  throws SPSignwareException
 

Query the type of the Signware object at the specified index of the list.

Parameters:
iIndex [i] zero based index in the list
Returns:
int the object type
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)

Panel de.softpro.signware.SPJGuiContainer.getPanel int  iIndex  )  throws SPSignwareException
 

Get a reference to the Panel object at the specified index of the list.

Parameters:
iIndex [i] zero based index in the list
Returns:
Panel a reference to the panel at the specified index
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)

void de.softpro.signware.SPJGuiContainer.rectCallback int  iIndex,
int  iId
 

Callback function called when a virtual button (rectangle) is clicked.

Override this method to do any action when a virtual button is pressed. Call acquireDone() for the according object to end acquiry mode.
The default implementation does nothing.

Parameters:
iIndex [i] zero based index in the list of embedded objects
iId [i] Identifier of the clicked Rectangle

void de.softpro.signware.SPJGuiContainer.setActive int  iIndex  )  throws SPSignwareException
 

Activate the object at the specified index of the list.

The active object will be set visible and it will become the input focus.

Parameters:
iIndex [i] zero based index in the list
Exceptions:
SPSignwareException on errors
Operating Systems:
Windows (Win32)

void de.softpro.signware.SPJGuiContainer.setBoolProperty String  strName,
boolean  bValue
throws SPSignwareException
 

Set a property.

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

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

Set a property.

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

void de.softpro.signware.SPJGuiContainer.statusChanged int  iIndex,
int  iMajor,
int  iDetail
 

Callback function that is called on status changes.

Override this method to do any action on status changes.
The default implementation does nothing.
Please read tablet status change notifications for more details.

Parameters:
iIndex [i] zero based index in the list of embedded objects
iMajor [i] major event identifyer
iDetail [i] detailed event identifyer

void de.softpro.signware.SPJGuiContainer.timeoutCallback int  iIndex  ) 
 

Callback function called after some time of inactivity.

Override this method to do any action on timeout. Call acquireDone() for the according object to end acquiry mode.
The default implementation does nothing.

Parameters:
iIndex [i] zero based index in the list of embedded objects

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

Callback function that is called when the tablet sends a vector.

Override this method to do any action on vector events.
The default implementation does nothing.

Note:
Vectors are handled internally, typically the application does not need to process tablet vectors
Parameters:
iIndex [i] zero based index in the list of embedded objects
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.SPJGuiContainer.SP_JGUIACQU = 1 [static]
 

Type identifyer for a SPJGuiAcqu object.

final int de.softpro.signware.SPJGuiContainer.SP_JGUIDISP = 2 [static]
 

Type identifyer for a SPJGuiDisp object.

final int de.softpro.signware.SPJGuiContainer.SP_JGUIDYN = 3 [static]
 

Type identifyer for a SPJGuiDyn object.

final int de.softpro.signware.SPJGuiContainer.SP_STACKED = 3 [static]
 

Type identifyer for stacked layout, see Property "Layout".

final int de.softpro.signware.SPJGuiContainer.SP_TILED_HORZ = 1 [static]
 

Type identifyer for horizontally tiled layout, see Property "Layout".

final int de.softpro.signware.SPJGuiContainer.SP_TILED_VERT = 2 [static]
 

Type identifyer for vertically tiled layout, see Property "Layout".


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