com.topaz
Class SigPlus
java.lang.Object
|
+--java.awt.Component
|
+--java.awt.Canvas
|
+--com.topaz.SigPlus
public class SigPlus
- extends java.lang.Object
SigPlus Pro Java is the Topaz software tool for Java developers. This native Java bean provides all the functionality required for customized capture and encryption of electronic handwritten biometric signatures. The SigPlus Pro Java bean allows for cross-platform Java implementation.
Method Summary |
public void |
autoKeyData (string) |
|
Adds data to the auto key generation function. |
|
public void |
|
public void |
autoKeyStart () |
|
Initializes the automatic key generation function. |
|
public void |
clearTablet () |
|
Causes the signature to clear from the object. |
|
public boolean |
exportSigFile (string fileName) |
|
Control writes out a signature file in the Topaz image-free raw tablet data vector file (.sig extension). |
|
public string |
|
public boolean |
|
public int |
|
public int |
getDisplayAnnotationX() |
|
Returns the X position in pixels of the start of the Annotation string in the signature box. |
|
public int |
getDisplayAnnotationY () |
|
Returns the Y position in pixels of the start of the Annotation string in the signature box. |
|
public int |
|
public int |
|
public int |
|
public int |
|
public int |
|
public boolean |
|
public int |
|
public int |
getDisplayTimeStampX () |
|
Returns the X position in pixels of the start of the Time Stamp in the signature box. |
|
public int |
getDisplayTimeStampY() |
|
Returns the Y position in pixels of the start of the Time Stamp in the signature box. |
|
public boolean |
|
public int |
|
public boolean |
|
public int |
|
public int |
getImageAnnotationX () |
|
Returns the X position in pixels of the start of the Annotation as it applies to public image sigImage () method. |
|
public int |
getImageAnnotationY () |
|
Returns the Y position in pixels of the start of the Annotation as it applies to public image sigImage () method. |
|
public int |
|
public int |
|
public int |
|
public int |
|
public int |
|
public boolean |
getImageTimeStamp () |
|
Returns true or false whether the Time Stamp is being displayed as it applies to public image sigImage () method. |
|
public int |
|
public int |
getImageTimeStampX () |
|
Returns the X position in pixels of the start of the Time Stamp as it applies to public image sigImage () method. |
|
public int |
getImageTimeStampY () |
|
Returns the Y position in pixels of the start of the Time Stamp as it applies to public image sigImage () method. |
|
public boolean |
|
public int |
getImageXSize () |
|
Returns the number of X pixels in the image provided by public image sigImage () method. |
|
public int |
getImageYSize () |
|
Returns the number of Y pixels in the image provided by public image sigImage () method. |
|
public string |
getKeyString() |
|
Provides a hash of the encrytption data in ASCII compatible format. |
|
public int |
|
public short |
getNumberOfStrokes () |
|
Returns the total number of strokes in the current signature and can be used to detect if a signature is present or not. |
|
public short |
|
public short |
getPointXValue (short StrokeIdx, short PointIdx) |
|
Returns the X coordinate value for the specified point. The value is in Logical Tablet Coordinates. |
|
public short |
getPointYValue (short StrokeIdx, short PointIdx) |
|
Returns the Y coordinate value for the specified point in Logical Tablet Coordinates. |
|
public int |
|
public string |
getSigPlusVersion () |
|
Returns the current version of the SigPlus JAR file as a String. |
|
public long |
getSigReceipt() |
|
Returns a 32 bit receipt similar to the key reciept. |
|
public string |
getSigReceiptAscii(short Strokeldx, short Pointldx) |
|
Same as getKeyReceiptAscii, but for Sig Receipt. |
|
public string |
|
public int |
|
public boolean |
|
public string |
|
public boolean |
|
public int |
|
public int |
|
public boolean |
|
public int |
|
public int |
|
public int |
getTabletLCDXStart () |
|
Returns current X pos in Logical Tablet Coordinates of left most pixel. |
|
public int |
getTabletLCDXStop () |
|
Returns current X pos in Logical Tablet Coordinates of right most pixel. |
|
public int |
|
public int |
getTabletLCDYStart () |
|
Returns current Y pos in Logical Tablet Coordinates of top most pixel. |
|
public int |
getTabletLCDYStop () |
|
Returns current Y pos in Logical Tablet Coordinates of bottom most pixel. |
|
public int |
getTabletLogicalXSize () |
|
Returns the range of horizontal values to be added in representing signatures in Logical Tablet Coordinates. |
|
public int |
getTabletLogicalYSize () |
|
Returns the range of vertical values to be used in representing signatures in Logical Tablet Coordinates. |
|
public string |
|
public int |
|
public int |
|
public int |
|
public int |
|
public int |
getTabletXStart () |
|
Returns the X position of the top left corner of the signature box in Logical Tablet Coordinates. |
|
public int |
getTabletXStop () |
|
Returns the X position of the bottom right corner of the signature box in Logical Tablet Coordinates. |
|
public int |
getTabletYStart () |
|
Returns the Y position of the top left corner of the signature box in Logical Tablet Coordinates. |
|
public int |
getTabletYStop () |
|
Returns the Y position of the bottom right corner of the signature box in Logical Tablet Coordinates. |
|
public string |
getTimeStamp () |
|
Returns the Time Stamp string for the signature. |
|
public short |
getXExtent () |
|
Returns the exact width in pixels of the current signature. |
|
public short |
getYExtent () |
|
Returns the exact height in pixels of the current signature. |
|
public boolean |
importSigFile (string fileName) |
|
Control Clears the current signature, reads in a signature file in the Topaz vector file format, and displays it. |
|
public void |
keyPadAddHotSpot (int keyCode, int coords, int xPos, int yPos, int xSize, int ySize) |
|
Defines in software the location of a tablet HotSpot. |
|
public void |
|
public void |
keyPadClearSigWindow (int inside) |
|
Erases data either inside or outside of sig window based on value of int inside. |
|
public int |
keyPadQueryHotSpot (int keyCode) |
|
Queries whether the specified HotSpot has been tapped by the user. |
|
public void |
keyPadSetSigWindow (int coords, int xpos, int ypos, int xsize, int ysize) |
|
Sets a signature window that restricts the ink of the SigPlus object to said window. |
|
public boolean |
lcdRefresh ( int mode, int xPos, int yPos, int xSize, int ySize) |
|
Sends refresh command to tablet. |
|
public boolean |
lcdSetWindow (int xPos, int yPos, int xSize, int ySize) |
|
Sets a signature window that restricts the ink of the SigPlus object to said window on the LCD itself. |
|
public boolean |
lcdWriteImage (int dest, int mode, int xPos, int yPos, int xSize, int ySize, Image imageData) |
|
Writes jpeg image to the LCD Display at the location specified by the combination of dest, xPos, and yPos. |
|
public int |
numberOfTabletPoints() |
|
Returns the total number of points in the current signature and can be used to detect if a singature is present or not. |
|
public void |
|
public void |
|
public void |
setDisplayAnnotationSize(int displayAnnotationSize) |
|
Sets the Y size in pixels of the Annotation start of the Time Stamp in the signature box. |
|
public void |
setDisplayAnnotationX (int displayAnnotationX) |
|
Sets the X position in pixels of the start of the Annotation string in the signature box. |
|
public void |
setDisplayAnnotationY(int displayAnnotationY) |
|
Sets the Y position in pixels of the start of the Annotation string in the signature box. |
|
public void |
setDisplayJustifyMode (int displayJustifyMode) |
|
Sets the justification mode for how the signature is going to be sized and positioned in the signature box. |
|
public void |
setDisplayJustifyX (int displayJustifyX) |
|
Sets justification X coordinate in Logical Tablet Coordinates. |
|
public void |
setDisplayJustifyY (int displayJustifyY) |
|
Sets justification Y coordinate in Logical Tablet Coordinates. |
|
public void |
setDisplayPenWidth (int displayPenWidth) |
|
Sets pen width for displayed signatures in pixels. |
|
public void |
setDisplayRotation (int displayRotation) |
|
Sets mode allowing signature rotation ofter capture. |
|
public void |
|
public void |
setDisplayTimeStampSize (int displayTimeStampSize) |
|
Sets the Y size in pixels of the Time Stamp in the signature box. |
|
public void |
setDisplayTimeStampX (int displayTimeStampX) |
|
Sets the X position in pixels of the start of the Time Stamp in the signature box. |
|
public void |
setDisplayTimeStampY (int displayTimeStampy) |
|
Sets the Y position in pixels of the start of the Time Stamp in the signature box. |
|
public void |
setDisplayTransparentMode (boolean displayTransparentMode) |
|
Sets whether the signature is displayed on a transparent background. |
|
public void |
setEncryptionMode(int encryptionMode) |
|
Sets the encryption mode used for capturing signatures. |
|
public void |
setImageAnnotation (boolean imageAnnotation) |
|
Sets whether or not the annotation is being displayed as it applies to public image sigImage () method. |
|
public void |
|
public void |
setImageAnnotationX (int imageAnnotationX) |
|
Sets the X position in pixels of the start of the Annotation string as it applies to public image sigImage () method. |
|
public void |
setImageAnnotationY (int imageAnnotationY) |
|
Sets the Y position in pixels of the start of the Annotation string as it applies to public image sigImage () method. |
|
public void |
|
public void |
|
public void |
|
public void |
setImagePenWidth (int imagePenWidth) |
|
Sets pen width for the image in pixels as it applies to public image sigImage () method. |
|
public void |
setImageRotation (int imageRotation) |
|
Sets the mode allowing for signature rotation after capture as it applies to public image sigImage () method. |
|
public void |
setImageTimeStamp (boolean imageTimeStamp) |
|
Sets the bean to display the Time Stamp as it applies to public image sigImage () method. |
|
public void |
|
public void |
setImageTimeStampX (int imageTimeStampX) |
|
Sets the X position in pixels of the start of the Time Stamp as it applies to public image sigImage () method. |
|
public void |
setImageTimeStampY (int imageTimeStampY) |
|
Sets the Y position in pixels of the start of the Time Stamp as it applies to public image sigImage () method. |
|
public void |
setImageTransparentMode (boolean imageTransparenMode) |
|
Sets whether the signature is displayed on a transparent background as it applies to public image sigImage () method. |
|
public void |
setImageXSize (int imageXSize) |
|
Sets the number of X pixels in the image provided by public image sigImage () method. |
|
public void |
setImageYSize (int imageYSize) |
|
Sets the number of Y pixels in the image provided by public image sigImage () method. |
|
public void |
setLCDTabletMap (int newLCDType, int newLCDXSize, int newLCDYSize, int newLCDYStart, int newLCDXStop, int newLCDYStop) |
|
Overrides the default values of the LCD parameters at run time. |
|
public void |
|
public void |
setSaveSigInfo (boolean) |
|
Enables/Disables the saving of TimeStamp and Annotate data in the signature. |
|
public void |
|
public void |
setSigString(string sigString) |
|
Sets the signature string into the bean. |
|
public void |
|
public void |
setTabletClippingMode (boolean tabletClippingMode) |
|
Sets mode where signature points outside the set display area are not reported. |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
setTabletLCDXStart (int tabletLCDXStart) |
|
Sets X pos in Logical Tablet Coordinates of left most pixel. |
|
public void |
setTabletLCDXStop (int TabletLCDXStop) |
|
Sets X pos in Logical Tablet Coordinates of right most pixel. |
|
public void |
|
public void |
setTabletLCDYStart (int tabletLCDYStart) |
|
Sets Y pos in Logical Tablet Coordinates of top most pixel. |
|
public void |
setTabletLCDYStop (int TabletLCDYStop) |
|
Sets Y pos in Logical Tablet Coordinates of bottom most pixel. |
|
public void |
setTabletModel (string TabletModel) |
|
Sets the model for the signature tablet. |
|
public void |
|
public void |
setTabletRotation (int tabletRotation) |
|
Sets the orientation on a 360 degree axis for display of tablet data. |
|
public void |
setTabletState (int tabletState) |
|
Opens port to enable signature capture. |
|
public void |
|
public void |
setTabletXStart (int tabletXStart) |
|
Sets the X position of the top left corner of the signature box in Logical Tablet Coordinates. |
|
public void |
setTabletXStop (int tabletXStop) |
|
Sets the X position of the bottom right corner of the signature box in Logical Tablet Coordinates. |
|
public void |
setTabletYStart (int tabletYStart) |
|
Sets the Y position of the top left corner of the signature box in Logical Tablet Coordinates. |
|
public void |
setTabletYStop (int tabletYStop) |
|
Sets the Y position of the bottom right corner of the signature box in Logical Tablet Coordinates. |
|
public void |
setTimeStamp (string timeStamp) |
|
Sets the Time Stamp for the signature. |
|
public image |
sigImage () |
|
Returns a Java buffered image of the current signature using the image properties. |
|
SigPlus
Public SigPlus() {}
- SigPlus sigObj = null;
- ClassLoader cl = (com.topaz.sigplus.SigPlus.class).getClassLoader();
- sigObj = (SigPlus)Beans.instantiate( cl, "com.topaz.sigplus.SigPlus" );
keyPadSetSigWindow
public void keyPadSetSigWindow (int coords,
int xPos,
int yPos,
int xSize,
int ySize)
- Sets a signature window that restricts the ink of the SigPlus object to said window. The functions behave as follows:
JustifyMode
will only operate on points inside of this window. ExportSigFile
will only operate on points inside the window. SigString
only operates on points inside the window.
-
- Parameters:
coords
- Value of 0 equals Logical Tablet Coordinates. 1 equals LCD setting.
xpos-
Location in Logical Tablet Coordinates, upper left = 0,0.
ypos-
Same
xsize-
XSize in logical tablet pixels.
ysize-
YSize in logical tablet pixels.
keyPadClearSigWindow
public void keyPadClearSigWindow(int inside)
- Parameters:
inside-
if=0 then signature data is erased (in window), if =1 then data outside sig window is erased.
keyPadAddHotSpot
public void keyPadAddHotSpot(int keyCode,
int coords,
int xPos,
int yPos,
int xSize,
int ySize)
- Defines in software the location of a tablet HotSpot which is used by the developer to detect user pen taps. To use LCD coordinates, the LCD coordinate map is set using
setlcdTabletMap
-
- Parameters:
keyCode
-integer value defining the HotSpot
coords-
coordinate system used for this HotSpot
xPos-
location (upper left- 0,0)
yPos-
same
xSize-
x size in pixels
ySize-
y size in pixels
keyPadClearHotSpotList
public void keyPadClearHotSpotList()
- Clears the controls internal list of HotSpots created using
keyPadAddHotSpot
keyPadQueryHotSpot
public int keyPadQueryHotSpot (int keyCode )
- Queries whether the specified HotSpot has been tapped by the user. Returns a true if the control contains data that is within the definition of the
keyCode
on the tablet.
- Parameters:
-
keyCode-
Mapped Logical Tablet Coordinates
- Returns:
- Number of points within the
keyCode
definition.
getLCDCaptureMode
public int getLCDCaptureMode()
- Gets the current LCD Capture Mode for the tablet
- Returns:
- Mode of the LCD tablet
setLCDCaptureMode
public void setLCDCaptureMode (int newMode)
- Sets the current LCD mode for the tablet.
- Parameters:
newMode-
the new mode the LCD is set to capture signatures in, Mode 0 no LCD commands are sent to the tablet, Mode 1-sets capture mode to be active with Autoerase in the tablet, Mode 2-sets the tablet to persistent ink capture without autoerase, Mode 3-signature ink is displayed inverted on a suitable dark background set using the Graphic functions.
setLCDTabletMap
public void setLCDTabletMap (int newLCDType,
int newLCDXsize,
int newLCDYsize,
int newLCDXstart,
int newLCDYstart,
int newLCDXstop,
int newLCDYstop)
- Overrides the default values for the LCD parameters at run time.
- Parameters:
newLCDType-
specifies LCD type and format, 0 for 240x128
newLCDXsize-
X size of LCD display, in pixels
newLCDYsize-
Y size of LCD display, in pixels
newLCDXstart-
X pos in Logical Tablet Coordinates of LCD
newLCDYstart-
Y pos in Logical Tablet Coordinates of LCD
newLCDXstop-
X pos in Logical Tablet Coordinates of LCD
newLCDYstop-
Y pos in Logical Tablet Coordinates of LCD
lcdSetWindow
public boolean lcdSetWindow (int xPos,
int yPos,
int xSize,
int ySize)
- Sets a signature window that restricts the ink of the SigPlus object to said window on the LCD itself (see
setLCDCaptureMode
)
- Parameters:
xPos-
Location in LCD coordinates (upper left- 0,0)
yPos-
Same
xSize-
X size in LCD pixels
ysize-
Ysize in LCD pixels
- Returns:
- True if checksum received and verified, false if no or incorrect checksum received from tablet.
lcdWriteImage
public boolean lcdWriteImage (int dest,
int mode,
int xPos,
int yPos,
int xSize,
int ySize,
image ImageData)
- Writes windows jpeg data to the LCD display. The data is written at the location specified by the combination of
dest, xPos, and yPos,
and mode
determines how the data is written.
Mode 0-the display is cleared at the specified location. Mode 1- Complement, complemented at the specific location, Mode 2-WriteOpaque, contents of the background memory in the tablet are transferred to the LCD Display
overwriting the contents of the LCD display. Mode 3- Write Transparent, contents of the background memory in the tablet are combined with and transferred to the visible LCD memory.
- Parameters:
dest-
0=foreground, 1=background memory in tablet
mode-
0,1,2,3 defined as above
xPos-
Location in LCD coords to draw at
yPos-
same
xSize-
Width in LCD pixels
ySize-
Height in LCD pixels
- Returns:
- True if checksum received and verified, false if no or incorrect checksum received from tablet.
lcdRefresh
public boolean lcdRefresh (int mode,
int xPos,
int yPos,
int xSize,
int ySize)
- Sends tablet a refresh command with 4 possible modes. Mode 0-Clear, display is cleared at the specified location. Mode 1-Complement, complements display at the specifiedd location. Mode 2-WriteOpaque, transfers contents of the background memory to the LCD display, overwriting the content of the LCD display.
Mode 3-WriteTransparent, transfers contents of the background memor in the tableb to the LCD display and combined in the contents of the LCD display.
- Parameters:
mode-
defined as above (0-4)
xPos-
Location in LCD Coordinates (upper left-0,0)
yPos-
Same
xSize-
X size in LCD pixels
ySize-
Y size in LCD pixels
- Returns:
- True if checksum received and verified, False if no or incorrect checksum received from tablet
getSigReceipt
public long getSigReceipt ()
- Returns a 32 bit reciept similiar to the key receipt. Forms receipt by using the auto key generation algorithm on the signature file and the result can be used to verify that the signature has not been modified.
- Returns:
- 32 bit binary receipt
getSigReceiptAscii
public string getSigReceiptAscii (short strokeIdx,
short pointIdx)
- Same as
getKeyReceiptAscii
, but for Sig receipt.
- Parameters:
strokeIdx-
stroke in the signature
pointIdx-
points that make up the stroke
- Returns:
- The ASCII string
SigReceipt
getKeyString
public string getKeyString ()
- Provides hash of the encryption data in ASCII compatible format
- Returns:
Hash of encryption data
numberOfTabletPoints
public int numberOfTabletPoints ()
- Returns the total number of points in the current signature, can be used to detect if a signature is present or not.
- Returns:
- Decimal value of number of points in the signature.
autoKeyFinish
public void autoKeyFinish ()
- Completes the auto key generation function, after this call the key is ready to be used in saving an encrypted file.
autoKeyStart
public void autoKeyStart ()
- Initializes the automatic key generation function which derives a key from the data fed to it via
autoKeyData (string)
, when all data is input then autoKeyFinish ()
must be called to compete key generation. If the autoKeyStart
method is not called, then the autoKeyData
method is used to pass the path to a file, which is then used to encrypt the signature, when autoKeyStart
is called then autoKeyData
is used to pass in string literals as data.
autoKeyData
public void autoKeyData (String)
- Adds data to the auto key generation function dependent on use of the
autoKeyStart
method
- Parameters:
String-
Data or file path that signature gets bound to.
sigImage
public Image sigImage ()
- Returns:
- Returns a Java buffered image of the current signature rendered using the Image properties.
clearTablet
public void clearTablet ()
- Clears the signature object of ink
exportSigFile
public boolean esportSigFile (string fileName)
- Writes out a signature file in the Topaz image-free raw tablet data vector file format (.sig extension)
- Returns:
- True if successful, false if not succesful
importSigFile
public boolean importSigFile (string fileName)
- Clears the current signature, read in a signature file in the Topaz vector file format, and display it.
- Parameters:
Filename-
Contains the path and filename that is to be read from
- Returns:
- True if successful, False if not succesful
getSigPlusVersion
public string getSigPlusVersion ()
- Returns:
- The current version of the SigPlus JAR file
setSaveSigInfo
public void setSaveSigInfo (boolean)
- Enables/Disables the saving of TimeStamp and Annotate data in the signature.
- Parameters:
boolean-
If True then SigInfo will be saved (default), if False then the info will not be saved
getNumberOfStrokes
public short getNumberOfStrokes()
- Returns total number of strokes in the current signature, can be used to detect if a signature is present or not.
- Returns:
- decimal value of number of strokes in signature
getNumPointsForStroke
public short getNumPointsForStroke (strokeNumber)
- Parameters:
strokeNumber-
Number of the stroke to inquire about
- Returns:
- decimal value of number of points in the stroke
getPointXValue
public short getPointXValue (short strokeIdx,
short pointIdx)
- Returns the X coordinates value for the specified point in Logical Tablet Coordinates.
- Parameters:
strokeIdx-
the index of the stroke for the point desired
pointIdx-
the index of the point in the stroke
- Returns:
- Decimal value of the X coordinate for the point
getPointYValue
public short getPointYValue (short strokeIdy,
short pointIdy)
- Returns the Y coordinates value for the specified point in Logical Tablet Coordinates.
- Paramters:
strokeIdy-
index of the stroke for the point desired
pointIdy-
index of the point in the stroke
- Returns:
- Decimal value of the X coordinate for the point.
getXextent
public short getXextent ()
-
- Returns:
- Width of the current signature in pixels.
getYextent
public short getYextent ()
-
- Returns:
- Height of the current signature in pixels.
getTabletModel
public string getTabletModel ()
- Gets the current table model setting.
- Returns:
- Current tablet model
setTabletModel
public void setTabletModel (string TabletModel)
- Sets the tablet model.
- Parameters:
TableModel-
Any of the following values, SignatureGem1X5, SignatureGemLCD1X5,
SignatureGem4X5, ClipGem, ClipGem19200, ClipGemLGL, for SigLite1X5 use SignarureGem1X5, for SignatureGemLCD4X3 use SignatureGemLCD4X3New, SignatureGemLCD4X5
getTimeStamp
public string getTimeStamp ()
- Gets the current Time Stamp string for the signature.
- Returns:
- ASCII new line character
setTimeStamp
public void setTimeStamp (string TimeStamp)
- Sets the TimeStamp string for the signature.
- Parameters:
TimeStamp-
ASCII new line character
getAnnotation
public string getAnnotation ()
- Returns:
- Returns current ASCII Annotation string
setAnnotation
public void setAnnotation (string Annotation)
- Sets Annotation string.
- Parameters:
Annotation-
ASCII line character
getSigString
public string getSigString ()
- Returns signature as an ASCII hex string.
- Returns:
- SigString as ASCII hex string
setSigString
public void setSigString (string SigString)
- Puts signature into the bean.
- Parameters:
SigString-
Signature in ASCII format
getTabletState
public int getTabletState ()
- Indicates capture state of the tablet.
- Returns:
- Value of 1 enables the bean to access the selected COM or USB port and access the tablet for signature capture, 0 disables the tablet for capture
setTabletState
public void setTabletState (int TabletState)
- Enables tablet to acess the COM or USB port to capture signatures or not.
- Parameters:
TabletState-
setting to 1 enables the tablet to capture signatures as above, setting to 0 disables signature capture
getSigCompressionMode
public int getSigCompressionMode ()
- Returns compression mode for signatures.
- Returns:
- Numeric value of current compression mode (see
setSigCompressionMode
)
setSigCompressionMode
public void setSigCompressionMode (int SigCompressionMode)
- Sets the current compression mode for signatures.
- Parameters:
SigCompressionMode-
Mode for compression of signature, where 0= no compression, 1= lossless compression with compacted data format, 2-8= compression ratio of signature stored in in .sig file where 2=1KB typ, 4=500 byte typ, and 8=250 byte typ. Topaz Systems does not recommend compressing beyond setting 1 unless size is more improtant than signature quality
getEncryptionMode
public int getEncryptionMode ()
- Returns current EncryptionMode.
- Returms:
- Numeric value for current EncryptionMode (see
setEncryptionMode
)
setEncryptionMode
public void setEncrytpionMode (int EncryptionMode)
- Sets EncryptionMode
- Parameters:
EncryptionMode-
0= no encryption, 1= medium encryption, 2=higher security encryption mode
getTabletLogicalXSize
public int getLogicalTabletXSize ()
- Returns:
- Current horizontal values used in representing signatures in Logical Tablet Coordinates
setTabletLogicalXSize
public void setTabletLogicalXSize (int TabletLogicalXSize)
- Sets the horizontal values to be used in representing signatures in Logical Tablet Coordinates.
- Parameters:
TabletLogicalXSize-
the horizontal values used in representing signatures in Logical Tablet Coordinates which by default are set to TabletXStop
minus TabletXStart
getTabletLogicalYSize
public int getTabletLogicalYSize()
- Returns:
- Current vertical values used in representing signatures in Logical Tablet Coordinates
setTabletLogicalYSize
public void setTabletLogicalYSize (int TabletLogicalYSize)
- Sets the range of vertical values to be used in representing signatures in Logical Tablet Coordinates.
- Parameters:
TabletLogicalYSize-
vertical values used in representing signatures in tablet coordinates which are set by default to TabletYStop
minus TabletYStart
getTabletXStart
public int getTabletXStart()
- Returns:
- Current X position in Logical Tablet Coordinates of the upper left hand corner of the bean signature box
setTabletXStart
public void setTabletXStart (int TabletXStart)
- Sets the X position in Logical Tablet Coordinates of the upper left hand corner of the bean signature box which is automatically set by the TabletModel property.
- Parameters:
TabletXStart-
X coordinate of the upper left corner of the signature box
getTabletXStop
pubic int getTabletXStop ()
- Returns:
- Current X position in Logical Tablet Coordinates of the lower right hand corner of the bean signature box.
setTabletXStop
public void setTabletXStop (int TabletXStop)
- Sets the X position in Logical Tablet Coordinates of the lower right corner of the bean signature box which is automatically set by the TabletModel property.
- Parameters:
TabletXStop-
X coordinate for the lower right corner of the signature box
getTabletYStart
public int TabletYStart ()
- Returns:
- Current Y position in Logical Tablet Coordinates of the upper left corner of the bean signature box.
setTabletYStart
public void setTabletYStart (int TabletYStart)
- Sets the Y position in Logical Tablet Coordinates of the upper left corner of the bean signature box which is automatically set by the TabletModel property.
- Parameters:
TabletXStop-
Y coordinate for the upper left corner of the signature box
getTabletYStop
public int getTabletYStop ()
- Returns:
- Current Y position in tablet coordinates of the lower right corner of the bean signature box.
setTabletYStop
public void setTabletYStop (int TabletYStop)
- Sets the Y position in Logical Tablet Coordinates of the lower right corner of the bean signature box which is automatically set by the TabletModel property.
- Parameters:
TabletYStop-
Y coordinate for the lower right corner of the signature box
getTabletTimingAdvance
public int getTabletTimingAdvance ()
- Returns:
- Current TabletTimingAdvance
setTabletTimingAdvance
public void setTabletTimingAdvance (int TabletTimingAdvance)
- Sets
TabletTimingAdvance
, an internal property associated with tablet model and set by the TabletModel property.
- Parameters:
TabletTimingAdvance-
internal tablet property
getTabletFilterPoints
public int getTabletFilterPoints ()
- Returns:
- Current TabletFilterPoints
setTabletFilterPoints
public void setTabletFilterPoints (int TabletFilterPoints)
- Sets
TabletFilterPoints
, an internal property associated with tablet model and set by the TabletModel property.
- Parameters:
TabletFilterPoints-
internal tablet property
getTabletBaudRate
public int getTabletBaudRate ()
- Returns:
- Current TabletBaudRate
setTabletBaudRate
public void setTabletBaudRate (int TabletBaudRate)
- Sets
TabletBaudRate
, an internal property associated with tablet model and set by the TabletModel property.
- Parameters:
TabletBaudRate-
internal tablet property
getTabletResolution
public int getTabletResolution ()
- Returns:
- Current TabletResolution
setTabletResolution
public void setTabletResolution (int TabletResolution)
- Sets
TableResolution
, an internal property associated with tablet model and set by the TabletModel property, based on hardware tablet resolution is 410 dpi, (excluding ClipGem which is 275 dpi) but can be changed at the risk of affecting signature capture.
- Parameters:
TabletResolution-
internal tablet property
getTabletRotation
public int getTabletRotation ()
- Gets the current orientation on a 360 degree axis for display of tablet data. The data in the sig representation is stored in the native tablet orientation.
- Returns:
- Current tablet orientation
SetTabletRotation
public void setTabletRotation (int TabletRotation)
- Sets the orientation on a 360 degree axis for display of tablet data. The data in the sig representation is stored in the native tablet orientation
- Parameters:
TabletRotation-
Display orientation, allowed values are 0, 90, 180, 270
getTabletComPort
public string getTabletComPort ()
- Gets the current COM port setting.
- Returns:
- Current COM port setting
setTabletComPort
public void setTabletComPort (string TabletComPort)
- Sets the COM port to use using a string. The SigPlus Java bean does not lock up a port as is the case with mouse-type drivers. Only set COM port when tablet state is OFF.
- Parameters:
TabletComPort-
COM port tablet uses. For USB connection (v.2.06 and above) use the string value "USB1", for HSB connection (v.2.12 and above) use the string value "HID1"
getTabletComTest
public boolean getTabletComTest ()
- Gets current harware check mode, can be used to determine if tablet is connected or which port tablet is connected to.
- Returns:
- Current hardware check mode, True if active, False if not active
setTabletComTest
public void setTabletComTest (boolean TabletComTest)
- Sets harware check mode. When this mode is active and Topaz tablet plugged into selected COM port (or USB) TabletState can be set to 1(ON).
If tablet cannot be set to 1.
- Parameters:
TabletComTest-
Hardware check mode,
getTabletClippingMode
public boolean getTabletClippingMode ()
- Gets current TabletClippingMode, mode where signature points are not reported if the points are drawn outside the bean signature box.
- Returns:
- True if clipping mode is active, false if clipping mode is inactive
setTabletClippingMode
public void setTabletClippingMode (boolean TabletClippingMode)
- Sets mode where signature points are not reported if outside the bean signature box when active.
- Parameters:
TabletClippingMode-
Tablet mode where points outside the signature box are not reported
getTabletInvisible
public boolean getTabletInvisible ()
- Returns whether or not SigPlus is in transparent mode.
- Returns:
- True if Invisible mode is active, False if mode is not active
setTabletInvisible
public void setTabletInvisible (boolean TabletInvisible)
- Sets SigPlus to run windowless.
- Parameters:
TabletInvisible-
Mode to be set to allow windowless operation
getTabletFormat
public int getTabletFormat ()
- Gets current tablet format.
- Returns:
- Current tablet format
setTabletFormat
public void setTabletFormat (int TabletFormat)
- Sets tablet format.
- Paramters:
TabletFormat-
Tablet format to be set
getTabletLCDType
pulic int getTabletLCDType ()
- Gets current LCD format.
- Returns:
- 1 for 128X64, 0 for 240X128,
S
setTabletLCDType
public void setTabletLCDType (int TabletLCDType)
- Sets LCD format.
- Parameters:
TabletLCDType-
Format of LCD to be set, for values see getTabletLCDType
getTabletLCDXSize
public int getTabletLCDXSize ()
- Gets current width of LCD in pixels.
- Returns:
- Current width of LCD in pixels
setTabletLCDXsize
public void setTabletLCDXSize (int TabletLCDXSize)
- Sets width of the LCD tablet in pixels.
- Parameters:
TabletLCDXSize-
Width of LCD to be set
getTabletLCDYSize
public int getTabletLCDYSize ()
- Gets current height of LCD in pixels.
- Returns:
- Height of LCD in pixels
setTabletLCDYSize
public void setTabletLCDYSize (int TabletLCDYSize)
- Sets height of LCD in pixels.
- Parameters:
TabletLCDYSize-
Height of LCD to be set
getTabletLCDXStart
public int getTabletLCDXStart ()
- Gets current X pos in Logical Tablet Coordinates of left most pixel.
- Returns:
- Current left most pixel
setTabletLCDXStart
public void setTabletLCDXStart (int TabletLCDXStart)
- Sets X pos in Logical Tablet Coordinates of left most pixel.
- Paramters:
TabletLCDXStart-
Left most pixel to be set
getTabletLCDXStop
public int getTabletLCDXStop ()
- Gets the X pos in Logical Tablet Coordinates of the right most X pixel.
- Returns:
- The X pos of the right most pixel
setTabletLCDXStop
public void setTabletLCDXStop (int TabletLCDXStop)
- Sets the X pos in Logical Tablet Coordinates of the right most pixel.
- Parameters:
TabletLCDXStop-
The right most LCD pixel to be set
getTabletLCDYStart
public int getTabletLCDYStart ()
- Gets the current Y pos in Logical Tablet Coordinates of the top most pixel.
- Returns:
- The Y pos of the top most pixel
setTabletLCDYStart
public void setTabletLCDYStart (int TabletLCDYStart)
- Sets the Y pos in Logical Tablet Coordinates of the top most pixel.
- Paramters:
TabletLCDYStart-
Top most LCD pixel to be set
getTabletLCDYStop
public int getTabletLCDYStop ()
- Gets the current Y pos in Logical Tablet Coordinates of the bottom most pixel.
- Returns:
- Y pos of bottom most pixel
setTabletLCDYStop
public void setTabletLCDYStop(int TabletLCDYStop)
- Sets the Y pos in Logical Tablet Coordinates of the bottom most pixel.
- Parameters:
TabletLCDYStop-
Bottom most pixel to be set
getDisplayPenWidth
public int getDisplayPenWidth ()
- Returns:
- Current pen ink width for the displayed signature in pixels
setDisplayPenWidth
public void setPenDisplayWidth (int PenDisplayWidth)
- Sets pen ink width for the displayed signature in pixels.
- Parameters:
DisplayPenWidth-
Pen width for the displayed signature in pixels
getDisplayTransparentMode
public boolean getDisplayTransparentMode ()
- Returns:
- True if active, signature is displayed on a transparent background, False if inactive, displayed on an opaque background
setDisplayTransparentMode
public void setDisplayTransparentMode (boolean DisplayTransparentMode)
- Sets whether the signature is displayed on an opaque or transparent background.
- Parameters:
DisplayTransparentMode-
Mode that controls background color of opaque or transparent
getDisplayRotation
public int getDisplayRotation ()
- Returns:
- Value of rotation on a 360 degree axis for signature display
setDisplayRotation
public void setDisplayRotation (int DisplayRotation)
- Sets mode allowing signature rotation in the control after capture for Display only, does not save the .sig info rotated. During capture rotation set by
TabletRotation property.
- Parameters:
setDisplayRotation-
Orientation for display of signature after capture
getDisplayJustifyX
public int getDisplayJustifyX ()
- Returns:
- Justification X buffer size in pixels for display
setDisplayJustifyX
public void setDisplayJustifyX (int DisplayJustifyX)
- Sets the buffer size in Logical Tablet Coordinates of "dead space" of left and right edge of SigPlus object if
DisplayJustifyMode
is 1-5.
- Parameters:
DisplayJustifyX-
Justification X buffer size for display
getDisplayJustifyY
public int getDisplayJustifyY ()
- Returns:
- Justification Y buffers size in pixels for display
setDisplayJustifyY
public void setDisplayJustifyY (int DisplayJustifyY)
- Sets the buffer size in Logical Tablet Coordinates of "dead space" of top and bottom edge of SigPlus object if
DisplayJustifyMode
is 1-5.
- Parameters:
DisplayJustifyY-
Justification Y buffer size for display
getDisplayJustifyMode
public int getDisplayJustifyMode ()
- Gets the current justification mode- how the signature is sized and positioned in the signature box.
- Returns:
- Justification mode, 0-normal no justification,
1-justify and zoom signature (upper left corner)
2-justify and zoom signature (upper right corner)
3-justify and zoom signature (lower left corner)
4-justify and zoom signature (lower right corner)
5-justify and zoom signature (center of control)
setDisplayJustifyMode
public void setDisplayJustifyMode (int DisplayJustifyMode)
- Sets justification mode- how the signature is sized and positioned in the signature box.
- Parameters:
DisplayJustifyMode-
The justification mode to be set, 0-5 (see getJustifyMode
)
getDisplayTimeStampX
public int getDisplayTimeStampX ()
- Gets X position of the start of the time stamp in the signature box.
- Returns:
- X value in pixels relative to the left edge, if 0 then 5% in from left side of signature box
setDisplayTimeStampX
public void setDisplayTimeStampX (int DisplayTimeStampX)
- Sets the X position in pixels of the start of the Time Stamp in the signature box.
- Parameters:
DisplayTimeStampX-
X position to be set for start of display of Time Stamp
getDisplayTimeStampY
public int getDisplayTimeStampY ()
- Gets Y position of the start of the Time Stamp in the signature box.
- Returns:
- Y value in pixels relative to the bottom edge, if 0 then 5% from bottom edge of signature box
setDisplayTimeStampY
public void setDisplayTimeStampY (int Display TimeStampY)
- Sets the Y position in pixels of the start of the Time Stamp in the signature box.
- Parameters:
DisplayTimeStampY-
Y position to be set for start of display of Time Stamp
getDisplayTimeStampSize
public int getDisplayTimeStampSize ()
- Gets the Y size in pixels of the Time Stamp in the signature box.
- Returns:
- Time Stamp size in pixels, if 0 then text size is 7.5% of y size of signature box
setDisplayTimeStampSize
public void setDisplayTimeStampSize (int DisplayTimeStampSize)
- Sets the Y size in pixels of the Time Stamp in the signature box.
- Parameters:
DisplayTimeStampSize-
Size of Time Stamp to set
getDisplayAnnotationX
public int getDisplayAnnotationX ()
- Gets the current X position for the start of the Annotation String in the signature box.
- Returns:
- X position for start of the Annotation string, if 0 then text is positioned 5% in from right side of signature box
setDisplayAnnotationX
public void setDisplayAnnotationX (int DispalyAnnotationX)
- Sets the X position in pixels of the start of the Annotation String in the signature box.
- Parameters:
DisplayAnnotationX-
X position for the start of the Annotation String to be set
getDisplayAnnotationY
public int getDisplayAnnotationY ()
- Gets the current Y position for the start of the Annotation String in the signature box.
- Returns:
- Y position for the start of the Annotation String, if 0 then text is positioned 5% in from bottom edge of signature box
setDisplayAnnotationY
public void setDisplayAnnotationY (int DisplayAnnotationY)
- Sets the Y position in pixels of the start of the Annotation String in the signature box.
- Parameters:
DisplayAnnotationY-
Y position for the start of the Annotation String to be set
getDisplayAnnotationSize
public int getDisplayAnnotationSize ()
- Gets current Y size in pixels of the Annotation start in the signature box.
- Returns:
- Text size of the Annotation in pixels, if 0 then the text size is 7.5% of the Y size of the signature box
setDisplayAnnotationSize
public void setDisplayAnnotationSize (int DisplayAnnotationSize)
- Sets the Y size of the Annotation start of the Time Stamp in the signature box.
- Parameters:
DisplayAnnotationSize-
Y Size of Annotation text in pixels
getDisplayTimeStamp
public booleant getDisplayTimeStamp ()
- Gets the current setting for bean to display Time Stamp.
- Returns:
- True if Time Stamp is displayed, False if not displayed
setDisplayTimeStamp
public void setDisplayTimeStamp (boolean DisplayTimeStamp)>
- Sets the bean to display the developer provided Time Stamp string.
- Parameters:
DisplayTimeStamp-
Bean to be set to display Time Stamp
getDisplayAnnotation
public boolean getDisplayAnnotation ()
- Gets the current setting to display Annotation.
- Returns:
- True if Annotation is displayed, false if not displayed
setDisplayAnnotation
public void setDisplayAnnotation (boolean DisplayAnnotation)
- Sets the bean to display the Annotation string.
- Parameters:
DisplayAnnotation-
Bean to display Annotation string
getImageXSize
public int getImageXSize ()
- Gets the current width in X pixels of the image provided by
public Image sigImage ().
- Returns:
- Number of X pixels of image
setImageXSize
public void setImageXSize (int ImageXSize)
- Sets the number of X pixels in the image provide by
public Image sigImage ().
- Parameters:
imageXSize-
Size in X pixels of the Image width
getImageYSize
public int getImageYSize ()
- Gets the current height in Y pixels of the image provided by
public Image sigImage ().
- Returns:
- number of Y pixels in Image height
setImageYSize
public void setImageYSize (int ImageYSize)
- Sets the number of Y pixels in the Image height as provided by
public Image sigImage ().
- Parameters:
ImageYSize-
Size in y pixels of the Image height
getImagePenWidth
public int ImagePenWidth ()
- Gets current pen ink width as it applies to
public Image sigImage ().
- Returns:
- Pen ink width for Image
setImagePenWidth
public void setImagePenWidth (int ImagePenWidth)
- Sets pen ink width as it applies to
public Image sigImage ().
- Paramters:
ImagePenWidth-
Pen ink width for Image
getImageTransparentMode
public boolean getImageTransparentMode ()
- Returns the current setting for transparent mode as it applies to
public Image sigImage ().
- Returns:
- True when transparent mode is active, false when not
setImageTransparentMode
public void setImageTransparentMode (boolean ImageTransparentMode)
- Sets whether the signature is displayed on an opaque or transparent background as it applies to
public Image sigImage ().
- Parameters:
ImageTransparentMode-
Mode that controls the background color of opaque or transparent
getImageRotation
public int getImageRotation ()
- Gets current rotation on a 360 degree axis as it applies to
public Image sigImage ().
- Returns:
- Value of rotation for Imageon a 360 degree axis
setImageRotation
public void setImageRotation (int ImageRotation)
- Sets rotation on a 360 degree axis for Image as it applies to
public Image sigImage ().
- Parameters:
ImageRotation-
Orientation for Image on a 360 degree axis
getImageJustifyX
public int getImageJustifyX ()
- Returns the buffer size in Logical Tablet Coordinates of "dead space" of left and right edge of SigPlus object as it applies to
public Image sigImage ().
- Returns:
- Justification X buffer size in pixels for Image
setImageJustifyX
public void setImageJustifyX ()
- Sets the buffer size in Logical Tablet Coordinates of "dead space" of left and right edge of SigPlus object if
ImageJustifyMode
is 1-5 public Image sigamage ().
- Parameters:
ImageJustifyX-
Justification X buffer size in pixels to be set for Image
getImageJustifyY
public int getImageJustifyY ()
- Gets current justification Y coordinate for Image as it applies to
public Image sigImage ().
- Returns:
- Justification Y buffer size in pixels for Image
setImageJustifyY
public void setImageJustifyY (int ImageJustifyY)
- Sets the buffer size in Logical Tablet Coordinates of "dead space" of top and bottom edge of SigPlus object if
ImageJustifyMode
is 1-5 for Image as it applies to public Image sigImage ().
- Parameters:
- ImageJustifyY- Justification Y buffer size in pixels to be set for Image
getImageJustifyMode
public int getImageJustifyMode ()
- Gets the current justification mode as it applies to
public Image sigImage ().
- Returns:
- Justification mode for Image, see
public int getDisplayJustifyMode ()
setImageJustifyMode
public void setImageJustifyMode (int ImageJustifyMode)
- Sets the justification mode as it applies to
public Image sigImage ().
- Parameters:
ImageJustifyMode-
Justification mode to be set 0-5, see public int getDisplayJustifyMode ()
getImageTimeStampX
public int getImageTimeStampX ()
- Gets X position of the start of the Time Stamp in the signature box as it applies to
public Image sigImage ().
- Returns:
- X value in pixels relative to the left edge, if 0 then 5% in from the left side of signature box
setImageTimeStampX
public void setImageTimeStampX (int TimeStampX)
- Sets the X position in pixels of the start of the Time Stamp as it applies to
public Image sigImage ().
- Parameters:
ImageTimeStampX-
X position to be set for start of Time Stamp for Image
getImageTimeStampY
public int getImageTimeStampY ()
- Gets the current Y position in pixels for the start of the Time Stamp as it applies to
public Image sigImage ().
- Returns:
- Y value in pixels relative to the left edge, if 0 then 5% from the bottom edge of the signature box
setImageTimeStampY
public void setImageTimeStampY (int TimeStampY)
- Sets the Y poistion in pixels of the start of the Time Stamp as it applies to
public Image sigImage ().
- Paramters:
ImageTimeStampY-
Y position to be set for start of Time Stamp for Image
getImageTimeStampSize
public int getImageTimeStampSize ()
- Gets the Y size in pixels of the Time Stamp in the signature box as it applies to
public Image sigImage ().
- Return:
- Time Stamp size in pixels, if 0 then text size is 7.5% of Y size of signature box
setImageTimeStampSize
public void setImageTimeStampSize (int TimeStampSize)
- Sets the Y size in pixels of the Time Stamp in the signature box as it applies to
public Image sigImage ().
- Paramters:
ImageTimeStampSize-
Size of Time Stamp to set for Image
getImageAnnotationSize
public int getImageAnnotationSize ()
- Gets current Y size in pixels of the Annotation start in the signature box as it applies to
public Image sigImage ().
- Returns:
- Text size of the Annotation in pixels, if 0 then test size is 7.5% of the Y size of the signature box.
setImageAnnotationSize
public void setImageAnnotationSize (int ImageAnnotationSize)
- Sets the Y size of the Annotation start in the signature box as it applies to
public Image sigImage ().
- Parameters:
ImageAnnotationSize-
Y size of Annotation text in pixels for Image
getImageAnnotationX
public int getImageAnnotationX ()
- Gets the current X poistion for the start of the Annotation String in the signature box as it applies to
public Image sigImage ().
- Returns:
- X position for start of the Annotation string, if 0 then text is positioned 5% in from right side of signature box for Image
setImageAnnotationX
public void setImageAnnotationX (int ImageAnnotationX)
- Sets the X position in pixels of the start of the Annotation String in the signature box as it applies to
public Image sigImage ().
- Parameters:
ImageAnnotationX-
X position for the start of the Annotation String to be set for Image
getImageAnnotationY
public int getImageAnnotationY ()
- Gets the current Y posiiton for the start of the Annotation String in the signature box as it applies to
public Image sigImage ().
- Returns:
- Y position for the start of the Annotation String, if 0 then test is positioned 5% in from bottom edge of signature box
setImageAnnotationY
public void setImageAnnotationY (int ImageAnnotationY)
- Sets the Y position in pixels of the start of the Annotation String in the signature box as it applies to
public Image sigImage ().
- Parameters:
ImageAnnotationY-
Y position for the start of the Annotation String to be set for Image
getImageTimeStamp
public boolean get ImageTimeStamp ()
- Gets the current setting for bean to display Time Stamp as it applies to
public Image sigImage ().
- Returns:
- True if Time Stamp is displayed, False if not displayed for Image
setImageTimeStamp
public void setImageTimeStamp (boolean ImageTImeStamp)
- Sets the bean to display the Time Stamp as it applies to
public Image sigImage ().
- Parameters:
ImageTimeStamp-
Bean to be set to display developer provided Time Stamp.
getImageAnnotation
public boolean getImageAnnotation ()
- Gets the current setting for bean to display Annotation as it applies to
public Image sigImage ().
- Returns
- True if Annotation is displayed, false if not displayed for Image
setImageAnnotation
public void setImageAnnotation (boolean ImageAnnotation)
- Sets the bean to display the Annotation string as it applies to
public Image sigImage ().
- Parameters:
ImageAnnotation-
Bean to be set to display Annotation string in the Image
Copyright © 2004 Topaz Systems, Inc. All rights reserved. Use is subject to license terms.