visit Kofax web site

de.softpro.signware.SPJGuiDisp Class Reference

Inheritance diagram for de.softpro.signware.SPJGuiDisp:

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
SPImage getImage () 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 setImage (SPImage aImage) throws SPSignwareException
void setIntProperty (String aKey, int aValue) throws SPSignwareException
void setSignature (SPSignature aSigno) throws SPSignwareException
void setSplitLines (java.util.Vector< Integer > vSplits) throws SPSignwareException
void setWeight (double dWeight) throws SPSignwareException
void setWeightedFrames (java.util.Vector< SPWeightedFrame > vFrames) throws SPSignwareException
 SPJGuiDisp () throws SPSignwareException

Package Functions

SPWeightedFrame getFrame (java.util.Vector< SPWeightedFrame > vFrames, int iIndex)
int getLine (java.util.Vector< Integer > vSplits, int iIndex)
final native int jniFree ()


Constructor & Destructor Documentation

de.softpro.signware.SPJGuiDisp.SPJGuiDisp  )  throws SPSignwareException
 

Create a new SPJGuiDisp 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:
SPGuiDispNew


Member Function Documentation

boolean de.softpro.signware.SPJGuiDisp.getBoolProperty String  aKey  )  throws SPSignwareException
 

Query the value of an boolean property in a SPJGuiDisp 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:
SPGuiDispGetBoolProperty, getBoolProperty

SPWeightedFrame de.softpro.signware.SPJGuiDisp.getFrame java.util.Vector< SPWeightedFrame vFrames,
int  iIndex
[package]
 

Helper method invoked from native code

Parameters:
vFrames [i] vector of frames
iIndex [i] zero based index
Returns:
SPWeightedFrame frame at iIndex

SPImage de.softpro.signware.SPJGuiDisp.getImage  )  throws SPSignwareException
 

Query the image in a SPJGuiDisp object

Returns:
SPImage the Image
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDispGetImage, setImage

int de.softpro.signware.SPJGuiDisp.getIntProperty String  aKey  )  throws SPSignwareException
 

Query the value of an integer property in a SPJGuiDisp 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:
SPGuiDispGetIntProperty, setIntProperty

int de.softpro.signware.SPJGuiDisp.getLine java.util.Vector< Integer >  vSplits,
int  iIndex
[package]
 

Helper method invoked from native code

Parameters:
vSplits [i] vector of split positions
iIndex [i] zero based index
Returns:
int split position at iIndex

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

Query the signature in a SPJGuiDisp object

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

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

Implements de.softpro.signware.SPSignwareObject.

void de.softpro.signware.SPJGuiDisp.paint java.awt.Panel  aClient  ) 
 

Handle painting in the object

If the application draws in the Panel which hosts the SPGuiDisp 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 SPGuiDisp 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.SPJGuiDisp.setBoolProperty String  aKey,
boolean  aValue
throws SPSignwareException
 

Set an boolean property in a SPJGuiDisp 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:
SPGuiDispSetBoolProperty, getBoolProperty

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

Create the visible components of a SPJGuiDisp 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:
SPGuiDispSetClient, setParent

void de.softpro.signware.SPJGuiDisp.setImage SPImage  aImage  )  throws SPSignwareException
 

Set the image in a SPJGuiDisp object

Any weighted frames or split linew will be reset.

Parameters:
aImage [i] the image
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDispSetImage, getImage

void de.softpro.signware.SPJGuiDisp.setIntProperty String  aKey,
int  aValue
throws SPSignwareException
 

Set an integer property in a SPJGuiDisp 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:
SPGuiDispSetIntProperty, getIntProperty

void de.softpro.signware.SPJGuiDisp.setSignature SPSignature  aSigno  )  throws SPSignwareException
 

Set the signature in a SPJGuiDisp 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:
SPGuiDispSetSignature, getSignature

void de.softpro.signware.SPJGuiDisp.setSplitLines java.util.Vector< Integer >  vSplits  )  throws SPSignwareException
 

Set split lines in a SPJGuiDisp object

Parameters:
vSplits [i] the split lines
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDispSetSplitLines

void de.softpro.signware.SPJGuiDisp.setWeight double  dWeight  )  throws SPSignwareException
 

Set the weight of the frames that will be visible in a SPJGuiDisp object

Parameters:
dWeight [i] the weight of visible frames
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDispSetSplitLines

void de.softpro.signware.SPJGuiDisp.setWeightedFrames java.util.Vector< SPWeightedFrame vFrames  )  throws SPSignwareException
 

Set weighted frames in a SPJGuiDisp object

Parameters:
vFrames [i] the weighted frames
Exceptions:
SPSignwareException on error
Operating Systems:
Windows (Win32)
See also:
SPGuiDispSetSplitLines


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