visit Kofax web site
de.softpro.signware.SPJGuiDyn

de.softpro.signware.SPJGuiDyn Class Reference

Inheritance diagram for de.softpro.signware.SPJGuiDyn:

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

Detailed Description

Display a signature / image in a java panel.

This class encapsulates signature image display within a canvas.

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.

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 display the dynamic feature of a signature, please read SPJGuiDyn

Operating Systems:
Windows (Win32)


Public Member Functions

boolean getBoolProperty (String aKey) throws SPSignwareException
int getIntProperty (String aKey) throws SPSignwareException
SPSignature getSignature () throws SPSignwareException
void paint (java.awt.Panel aClient)
void setBoolProperty (String aKey, boolean aValue) throws SPSignwareException
void setClient (java.awt.Panel pClient) throws SPSignwareException
void setIntProperty (String aKey, int aValue) throws SPSignwareException
void setSignature (SPSignature aSigno) throws SPSignwareException
 SPJGuiDyn () throws SPSignwareException

Package Functions

final native int jniFree ()

Constructor & Destructor Documentation

de.softpro.signware.SPJGuiDyn.SPJGuiDyn (   )  throws SPSignwareException
 

Create a new SPJGuiDyn object

Note:
the native object is created without visible components, call setClient as soon as the parent component or the client component becomes visible
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDynNew

Member Function Documentation

boolean de.softpro.signware.SPJGuiDyn.getBoolProperty (  String  aKey  )  throws SPSignwareException
 

Query the value of an boolean property in a SPJGuiDyn object

Parameters:
aKey [i] the name of the property
Returns:
boolean the Value of the property
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDynGetBoolProperty, getBoolProperty

int de.softpro.signware.SPJGuiDyn.getIntProperty (  String  aKey  )  throws SPSignwareException
 

Query the value of an integer property in a SPJGuiDyn object

Parameters:
aKey [i] the name of the property
Returns:
int the Value of the property
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDynGetIntProperty, setIntProperty

SPSignature de.softpro.signware.SPJGuiDyn.getSignature (   )  throws SPSignwareException
 

Query the signature in a SPJGuiDyn object

Returns:
SPSignature the signature
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDynGetSignature, setSignature

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

Implements de.softpro.signware.SPSignwareObject.

void de.softpro.signware.SPJGuiDyn.paint (  java.awt.Panel  aClient  ) 
 

Handle painting in the object

If the application draws in the Panel which hosts the SPGuiDyn object, then the application must set the bool property "JavaDrawInPanel" to true and invoke the paint method whenever the application needs to draw on the component.

Note:
The application may have to override the paint method of the panel, that hosts the SPGuiDyn object to fix possible refresh issues.
Parameters:
aClient [i] the client component that hosts this object
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)

void de.softpro.signware.SPJGuiDyn.setBoolProperty (  String  aKey,
boolean  aValue
)  throws SPSignwareException
 

Set an boolean property in a SPJGuiDyn object

Parameters:
aKey [i] the name of the property
aValue [i] the value of the property
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDynSetBoolProperty, getBoolProperty

void de.softpro.signware.SPJGuiDyn.setClient (  java.awt.Panel  pClient  )  throws SPSignwareException
 

Create the visible components of a SPJGuiDyn object

Note:
Use the component pClient to draw the signature / image
Parameters:
pClient [i] the client component
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDynSetClient, setParent

void de.softpro.signware.SPJGuiDyn.setIntProperty (  String  aKey,
int  aValue
)  throws SPSignwareException
 

Set an integer property in a SPJGuiDyn object

Parameters:
aKey [i] the name of the property
aValue [i] the value of the property
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDynSetIntProperty, getIntProperty

void de.softpro.signware.SPJGuiDyn.setSignature (  SPSignature  aSigno  )  throws SPSignwareException
 

Set the signature in a SPJGuiDyn object

Any weighted frames or split linew will be reset.

Parameters:
aSigno [i] the signature
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDynSetSignature, getSignature

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