com.goldencode.p2j.ui

Interface Signature

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

SignatureWidget

public interface Signature

API definitions for SIGNATURE widget (FWD extension).

Method Summary

Modifier and Type	Method and Description
void	clearSignatureWindow(integer i) Erase data outside the signature window.
void	clearTablet() Clear the signature tablet.
memptr	getSignatureImage(character imgFormat, character pixelFormat) Get the signature image.
void	keypadAddHotSpot(integer hotspotId, integer coordinateMode, integer x, integer y, integer width, integer height) Set the keypad hotspot location.
void	keypadClearHotSpotList() Clear the hotspot points.
integer	keypadQueryHotSpot(integer i) Check if the OK hotspot is tapped.
void	lcdRefresh(integer clear, integer x, integer y, integer width, integer height) Refresh the tablet LCD.
void	lcdSetWindow(integer x, integer y, integer width, integer height) Set the LCD window coordinates.
void	lcdWriteString(integer mode, integer writeMode, integer x, integer y, character font, character text) Write a string to the LCD window.
integer	numberOfTabletPoints() Get the number of table points.
void	setImageFileFormat(integer i) Set the image file format.
void	setImagePenWidth(integer pixels) Set the pen width for the saved image.
void	setImageXSize(integer width) Set the image width.
void	setImageYSize(integer height) Set the image height.
void	setJustifyMode(integer mode) Set the justify mode.
void	setJustifyX(integer pixels) Set the horizontal justify.
void	setJustifyY(integer pixels) Set the vertical justify.
void	setLCDCaptureMode(integer mode) Set the LCD capture mode.
void	setSignatureWindow(integer mode, integer x, integer y, integer width, integer height) Set the coordinates for the signature window.
void	setTabletState(integer state) Set the tablet state.
void	setTranslateBitmapEnable(logical enable) Enable the bitmap translation.
character	tabletModelNumber() Get the table model number.

Method Detail

clearTablet

void clearTablet()

Clear the signature tablet.

numberOfTabletPoints

integer numberOfTabletPoints()

Get the number of table points.

Returns:

See above.

lcdRefresh

void lcdRefresh(integer clear,
                integer x,
                integer y,
                integer width,
                integer height)

Refresh the tablet LCD.

Parameters:

clear - Flag indicating the clear mode.

x - The x coordinate.

y - The y coordinate.

width - The width of the rectangle to clear.

height - The height of the rectangle to clear.

lcdWriteString

void lcdWriteString(integer mode,
                    integer writeMode,
                    integer x,
                    integer y,
                    character font,
                    character text)

Write a string to the LCD window.

Parameters:

mode - The location (0 for foreground).

writeMode - The write mode (2 for overwrite).

x - The x coordinate.

y - The y coordinate.

font - The font to use.

text - The text to write.

keypadAddHotSpot

void keypadAddHotSpot(integer hotspotId,
                      integer coordinateMode,
                      integer x,
                      integer y,
                      integer width,
                      integer height)

Set the keypad hotspot location.

Parameters:

hotspotId - The hotspot ID

coordinateMode - The coordinate mode (1 for LCD coordinates).

x - The x coordinate.

y - The y coordinate.

width - The width.

height - The height.

lcdSetWindow

void lcdSetWindow(integer x,
                  integer y,
                  integer width,
                  integer height)

Set the LCD window coordinates.

Parameters:

x - The x coordinate.

y - The y coordinate.

width - The window width.

height - The window height.

setSignatureWindow

void setSignatureWindow(integer mode,
                        integer x,
                        integer y,
                        integer width,
                        integer height)

Set the coordinates for the signature window.

Parameters:

mode - 1 for LCD coordinates.

x - The x coordinate.

y - The y coordinate.

width - The window width.

height - The window height.

setLCDCaptureMode

void setLCDCaptureMode(integer mode)

Set the LCD capture mode.

Parameters:

mode - The capture mode.

setTabletState

void setTabletState(integer state)

Set the tablet state.

Parameters:

state - 1 to turn on for signature collection.

tabletModelNumber

character tabletModelNumber()

Get the table model number.

Returns:

See above.

setTranslateBitmapEnable

void setTranslateBitmapEnable(logical enable)

Enable the bitmap translation.

Parameters:

enable - true to enable translation.

setImageFileFormat

void setImageFileFormat(integer i)

Set the image file format.

Parameters:

i - The image format (2 for BMP monochrome).

setImageXSize

void setImageXSize(integer width)

Set the image width.

Parameters:

width - The image width.

setImageYSize

void setImageYSize(integer height)

Set the image height.

Parameters:

height - The image height.

setImagePenWidth

void setImagePenWidth(integer pixels)

Set the pen width for the saved image.

Parameters:

pixels - The number of pixels.

setJustifyMode

void setJustifyMode(integer mode)

Set the justify mode.

Parameters:

mode - The justify mode (5 for central).

setJustifyX

void setJustifyX(integer pixels)

Set the horizontal justify.

Parameters:

pixels - The number of pixels.

setJustifyY

void setJustifyY(integer pixels)

Set the vertical justify.

Parameters:

pixels - The number of pixels.

getSignatureImage

memptr getSignatureImage(character imgFormat,
                         character pixelFormat)

Get the signature image.

Parameters:

imgFormat - The image format (BMP, JPEG, etc).

pixelFormat - The pixel format (i.e. Format1bppIndexed).

Returns:

The image bytes.

keypadQueryHotSpot

integer keypadQueryHotSpot(integer i)

Check if the OK hotspot is tapped.

Parameters:

i - Hotspot ID.

Returns:

See above.

clearSignatureWindow

void clearSignatureWindow(integer i)

Erase data outside the signature window.

Parameters:

i - Clear mode.

keypadClearHotSpotList

void keypadClearHotSpotList()

Clear the hotspot points.