eSeal
eSeal
This class provides the eSeal capture functionality.
Full qualification: com.florentis.signature.eSeal
Summary
| Method | |
|---|---|
| capture | |
| close | |
| Property | |
|---|---|
| url | |
| hAlign | |
| vAlign | |
| hScale | |
| vScale | |
| transparency | |
| cacheImage | |
| width | |
| height | |
| name | |
| id | |
| licence | |
Methods
capture
This method inserts an eSeal and optionally captures a handwritten signature.
| public native int capture(SigCtl sigCtl, int captureMode, String who, String why, Hash what, Key key) | |
|---|---|
| Parameters | |
| sigCtl | Required SigCtl |
| captureMode | Required int, may be one of: |
| who | Required signatory name |
| why | Required reason for signing |
| what | Optional Hash object (may be null) |
| key | Optional Key object (may be null) |
| Return Value | |
int esealCaptureReturn | |
| 0 | Signature captured successfully. |
| 1 | Signature not captured because user cancelled |
| 100 | No capture service available |
| 101 | Pad Error |
| 200 | Error - unable to parse document contents |
| 300 | Error - unable to load eSeal image |
close
This method "Closes" the object, releasing the underlying COM object (and thus freeing resources).
| public native void close() | |
|---|---|
| Parameters | |
| None | |
| Return Value | |
| None |
Properties
| Property | Property Type | Description |
|---|---|---|
url | String | Read/Write String contains the URL of the image in a standard format: JPEG, PNG, TIF, GIF, BMP |
hAlign | int | Read/Write int defines horizontal alignment of the image as one of: eSeal.esLeft, eSeal.esCentre (default), eSeal.esCenter, eSeal.esRight |
vAlign | int | Read/Write int defines vertical alignment of the image as one of: eSeal.esTop, eSeal.esCentre (default), eSeal.esCenter, eSeal.esBottom |
hScale | int | Read/Write int defines percentage of X dimension (defaults to 100) |
vScale | int | Read/Write int defines percentage of Y dimension (defaults to 100) |
transparency | int | Read/Write int defines percentage of transparency: 100 = maximum, not visible; 0 = minimum, unchanged (default) |
cacheImage | boolean | Read/Write Boolean false if URL is to be accessed at time of signing, true if image is saved within the eSeal object. Defaults to false. For internal use only. |
width | int | Read-only int width of image in HIMETRIC 0.01mm units |
height | int | Read-only int height of image in HIMETRIC 0.01mm units |
name | String | Read/Write String name for internal use only |
id | String | Read-only String for internal use only |
licence | String | The read/write property contains a licence string |