com.scriptel.easyscript

Class EasyScript

java.lang.Object

com.scriptel.easyscript.EasyScript

public final class EasyScript
extends java.lang.Object

This is a utility class that can be used to interact with Scriptel ScripTouch EasyScript products. It is capable of parsing and rendering keyboard strings generated when the digitizer is signed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LIBRARY_BUILD_DATE This contains the date on which the library was built (YYYY-MM-DD HH:MM:SS).
static java.lang.String	LIBRARY_VERSION This contains the current version of the library.

Constructor Summary

Constructors

Constructor and Description
EasyScript() Constructor, creates a new instance of this type.
EasyScript(SignatureProtocol signatureProtocol, CardSwipeProtocol cardProtocol) Constructor, creates a new instance of this type.

Method Summary

Modifier and Type	Method and Description
void	addListener(EasyScriptEventListener cr) Adds a listener interested in EasyScript events to the list of listeners to notify.
CardSwipeProtocol	getCardProtocol() Gets the current card protocol.
SignatureProtocol	getSignatureProtocol() Gets the current signature protocol.
void	parse(char chr) This method allows you to stream in a set of characters and the library will attempt to decode signatures and card swipes as the characters are passed in.
void	parse(java.awt.event.KeyEvent evt) This method attempts to parse a stream of keyboard events coming into a JFrame and turning them into characters which then get passed to parse(char c).
CardSwipe	parseCardSwipe(java.lang.String swipe) This method attempts to parse a magnetic card swipe from a ScripTouch device with a magnetic strip reader.
Signature	parseSignature(java.lang.String sig) This method takes an EasyScript string and attempts to parse it into a signature object.
void	removeListener(EasyScriptEventListener cr) Removes a listener interested in EasyScript events from the list of listeners to notify.
java.awt.image.BufferedImage	renderSignature(Signature s, java.awt.Color foreColor, java.awt.Color backColor, int lineThickness, float scale) This method will take a signature and will attempt to render it onto a buffered image object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LIBRARY_VERSION

public static final java.lang.String LIBRARY_VERSION

This contains the current version of the library.

See Also:

Constant Field Values

LIBRARY_BUILD_DATE

public static final java.lang.String LIBRARY_BUILD_DATE

This contains the date on which the library was built (YYYY-MM-DD HH:MM:SS).

See Also:

Constant Field Values

Constructor Detail

EasyScript

public EasyScript()

Constructor, creates a new instance of this type.

EasyScript

public EasyScript(SignatureProtocol signatureProtocol,
                  CardSwipeProtocol cardProtocol)

Constructor, creates a new instance of this type. Pass in the protocol of the device that you're using.

Parameters:

signatureProtocol - Protocol for the device you're trying to decode signatures for.

cardProtocol - Protocol for the device you're trying to decode card swipes for.

Method Detail

renderSignature

public java.awt.image.BufferedImage renderSignature(Signature s,
                                                    java.awt.Color foreColor,
                                                    java.awt.Color backColor,
                                                    int lineThickness,
                                                    float scale)

This method will take a signature and will attempt to render it onto a buffered image object.

Parameters:

s - Signature to render

foreColor - Foreground color (signature color) to use.

backColor - Background color, null for transparent.

lineThickness - The thickness of each stroke in pixels (not scaled).

scale - How much to scale the resulting image.

Returns:

Buffered Image containing the rendered signature.

parseCardSwipe

public CardSwipe parseCardSwipe(java.lang.String swipe)
                         throws CardSwipeInvalidException

This method attempts to parse a magnetic card swipe from a ScripTouch device with a magnetic strip reader.

Parameters:

swipe - ScripTouch magnetic strip data.

Returns:

Parsed card swipe.

Throws:

CardSwipeInvalidException - Thrown in the event the card couldn't be properly parsed.

parseSignature

public Signature parseSignature(java.lang.String sig)
                         throws SignatureInvalidException

This method takes an EasyScript string and attempts to parse it into a signature object.

Parameters:

sig - Signature string to parse.

Returns:

Parsed signature, unless the signature was canceled, then null.

Throws:

SignatureInvalidException - Thrown in the event there is something wrong with the string.

parse

public void parse(char chr)
           throws SignatureInvalidException

This method allows you to stream in a set of characters and the library will attempt to decode signatures and card swipes as the characters are passed in. To use this method be sure to implement your own EasyScriptEventListener and pass it to addListener() prior to passing characters to this function. This listener will be called when specific events are generated by decoding the stream.

Parameters:

chr - Next character in the stream to parse.

Throws:

SignatureInvalidException - Thrown in the event an unexpected condition occurs while parsing the stream.

parse

public void parse(java.awt.event.KeyEvent evt)
           throws SignatureInvalidException

This method attempts to parse a stream of keyboard events coming into a JFrame and turning them into characters which then get passed to parse(char c).

Parameters:

evt - Keyboard event to evaluate.

Throws:

SignatureInvalidException - Thrown in the event of an unexpected condition.

getSignatureProtocol

public SignatureProtocol getSignatureProtocol()

Gets the current signature protocol.

Returns:

the signature protocol

getCardProtocol

public CardSwipeProtocol getCardProtocol()

Gets the current card protocol.

Returns:

the cardProtocol

addListener

public void addListener(EasyScriptEventListener cr)

Adds a listener interested in EasyScript events to the list of listeners to notify.

Parameters:

cr - The listener to add to the list.

removeListener

public void removeListener(EasyScriptEventListener cr)

Removes a listener interested in EasyScript events from the list of listeners to notify.

Parameters:

cr - The listener to remove from the list.