SignDoc SDK (Java)
5.0.0
|
A bitmap image. More...
Public Member Functions | |
SignDocImage () | |
Constructor. More... | |
synchronized SignDocImage | clone () throws SignDocException |
Clone this object. More... | |
synchronized void | clear () throws SignDocException |
Remove the image from this object. More... | |
synchronized void | setEmpty (int aWidth, int aHeight, int aBitsPerPixel, int aColor) throws SignDocException |
Replace this image with an empty one of the specified size. More... | |
synchronized void | loadFromMemory (byte[] aBlob, int aIndex) throws SignDocException |
Load an image from a blob. More... | |
synchronized void | loadFromFile (String aPath, int aIndex) throws SignDocException |
Load an image from a file. More... | |
synchronized int | getBitsPerPixel () throws SignDocException |
Get the number of bits per pixel. More... | |
synchronized int | getNumberOfComponents () throws SignDocException |
Get the number of components. More... | |
synchronized int | getBitsPerComponent () throws SignDocException |
Get the number of bits per component. More... | |
synchronized int | getWidth () throws SignDocException |
Get the width of the image. More... | |
synchronized int | getHeight () throws SignDocException |
Get the height of the image. More... | |
synchronized int | getResolutionX () throws SignDocException |
Get the horizontal resolution of the image. More... | |
synchronized int | getResolutionY () throws SignDocException |
Get the vertical resolution of the image. More... | |
synchronized void | setResolution (int aResolutionX, int aResolutionY) throws SignDocException |
Set the resolution of the image. More... | |
synchronized void | resizeToResolution (int aResolutionX, int aResolutionY, String aFilter) throws SignDocException |
Resize the image. More... | |
synchronized void | crop (int aX, int aY, int aWidth, int aHeight) throws SignDocException |
Crop the image. More... | |
synchronized void | convertToBiLevel (SignDocImageParameters aImageParameters) throws SignDocException |
Convert the image to bi-level black and white. More... | |
synchronized void | convertToGrayscale () throws SignDocException |
Convert the image to 8-bit grayscale. More... | |
synchronized void | convertToTrueColor () throws SignDocException |
Convert the image to 24-bit RGB (8 bits per color channel). More... | |
synchronized void | invert (boolean aAuto) throws SignDocException |
Invert the image. More... | |
synchronized void | rotate (int aAngle, int aBackgroundColor) throws SignDocException |
Rotate the image. More... | |
synchronized void | mirrorX () throws SignDocException |
Mirror along the vertical axis (flip horizontally). More... | |
synchronized void | mirrorY () throws SignDocException |
Mirror along the horizontal axis (flip vertically). More... | |
synchronized int | getPixelValue (int aX, int aY) throws SignDocException |
Get the value of a pixel. More... | |
synchronized void | setPixelValue (int aX, int aY, int aValue) throws SignDocException |
Set the value of a pixel. More... | |
synchronized int | getPixelRGB (int aX, int aY) throws SignDocException |
Get the RGB color of a pixel. More... | |
synchronized void | setPixelRGB (int aX, int aY, int aColor) throws SignDocException |
Set the RGB color of a pixel. More... | |
synchronized void | drawLine (int aX1, int aY1, int aX2, int aY2, double aStrokeWidth, int aColor) throws SignDocException |
Draw a line. More... | |
synchronized void | drawRect (int aX1, int aY1, int aX2, int aY2, double aRadiusX, double aRadiusY, double aStrokeWidth, int aColor, boolean aFill) throws SignDocException |
Draw a rectangle (with both lines parallel to the axes). More... | |
synchronized void | drawRect (SignDocImageRect aRect, double aRadiusX, double aRadiusY, double aStrokeWidth, int aColor, boolean aFill) throws SignDocException |
Draw a rectangle (with both lines parallel to the axes). More... | |
synchronized int[] | getPalette () throws SignDocException |
Get the palette. More... | |
synchronized void | setPaletteAt (int aIndex, int aColor) throws SignDocException |
Set a palette entry. More... | |
synchronized int[] | getHistogram () throws SignDocException |
Compute a histogram. More... | |
synchronized int | getComplexity (SignDocImageParameters aImageParameters) throws SignDocException |
Compute the complexity of a signature image. More... | |
synchronized SignDocMatchResult | matchImage (SignDocImage aOther, SignDocMatchParameters aMatchParameters) throws SignDocException |
Match against a signature image. More... | |
synchronized SignDocMatchResult | matchSignature (SignDocSignatureData aOther, SignDocMatchParameters aMatchParameters, SignDocImageParameters aImageParameters) throws SignDocException |
Match against a signature. More... | |
synchronized SignDocMatchResult | matchReference (SignDocSignatureData aOther, SignDocMatchParameters aMatchParameters, SignDocImageParameters aImageParameters) throws SignDocException |
Match against a reference. More... | |
synchronized void | clean (SignDocImageParameters aImageParameters, SignDocCleanParameters aCleanParameters) throws SignDocException |
Clean a signature image according to the provided parameters. More... | |
synchronized SignDocImageRect | cleanSignature (SignDocImageParameters aImageParameters) throws SignDocException |
Clean a signature image. More... | |
synchronized void | cleanLines (SignDocImageParameters aImageParameters) throws SignDocException |
Clean lines. More... | |
synchronized SignDocImageRect | cleanDate (SignDocImageParameters aImageParameters) throws SignDocException |
Remove handwritten text from the signature image. More... | |
synchronized void | cleanFrames (SignDocImageParameters aImageParameters, double aTrust) throws SignDocException |
Clean frames. More... | |
synchronized SignDocImageRect | removeMargins (SignDocImageParameters aImageParameters) throws SignDocException |
Remove white margins. More... | |
synchronized SignDocWeightedFrame[] | getFrames (SignDocImageParameters aImageParameters) throws SignDocException |
Get the frames of the image. More... | |
synchronized int[] | getSplitPositions (SignDocImageParameters aImageParameters) throws SignDocException |
Get the vertical split positions of the image. More... | |
synchronized byte[] | saveToMemory (SignDocImageParameters aParameters) throws SignDocException |
Save this image as a blob. More... | |
synchronized byte[] | saveToMemory2 (String aFormat) throws SignDocException |
Save this image as a blob. More... | |
synchronized void | saveToFile (String aPath, SignDocImageParameters aParameters) throws SignDocException |
Save this image to a file. More... | |
synchronized void | saveToFile2 (String aPath, String aFormat) throws SignDocException |
Save this image to a file. More... | |
synchronized void | close () |
Destroy the underlying native object (for java.lang.AutoCloseable). More... | |
Static Public Member Functions | |
static int | getNumberOfPagesFromMemory (byte[] aBlob) throws SignDocException |
Get the number of subimages (pages) in a blob. More... | |
static int | getNumberOfPagesFromFile (String aPath) throws SignDocException |
Get the number of subimages (pages) in a file. More... | |
Protected Member Functions | |
void | finalize () throws Throwable |
Finalize this object. More... | |
A bitmap image.
This class supports images with 1 bit per pixel (bi-level, with RGB palette), 8 bits per pixel (indexed, with RGB palette), and 24 bits per pixel (RGB, 256 levels per color channel). RGB colors are specified as integers of the form 0x00rrggbb (rr is the red component, gg is the green component, bb is the blue component). All three components have values 0 (off) through 255 (on): 0x000000 is black, 0xffffff is white.
Some functions assume (for computing the intensity) that the color profile is sRGB.
Images that have transparent pixels are not supported.
The origin of the coordinate system is in the upper left corner, see Coordinate Systems.
SignDocImage | ( | ) |
Constructor.
This object won't contain an image, getWidth() and getHeight() will return 0.
synchronized void clean | ( | SignDocImageParameters | aImageParameters, |
SignDocCleanParameters | aCleanParameters | ||
) | throws SignDocException |
Clean a signature image according to the provided parameters.
This function performs multiple clean operations with a single call.
If the image is not a bi-level image, this function will create a bi-level image, clean the bi-level image, and then mask the original image with the cleaned bi-level image, making all parts white that are not considered part of the signature.
The width of the image must not exceed 1280 pixels, the height of the image must not exceed 960 pixels.
See Cleaning signature images for information about cleaning.
[in] | aImageParameters | Parameters controlling how images are converted to bi-level black and white. If this argument is null, all parameters will be set to their respective default value. |
[in] | aCleanParameters | Actions and parameters, must not be null. |
synchronized SignDocImageRect cleanDate | ( | SignDocImageParameters | aImageParameters | ) | throws SignDocException |
Remove handwritten text from the signature image.
Handwritten text (such as a date) will be removed from the signature image. Dirt, lines, and machine-printed text must be removed before calling this function.
After cleaning, the image will be cropped to the signature region.
If the image is not a bi-level image, this function will create a bi-level image, clean the bi-level image, and then crop the original image to the cleaned bi-level image.
If the height or width would become zero, the image will be replaced by a single white pixel (if the image uses a palette, the brightest color in the palette will be used).
The width of the image must not exceed 1280 pixels, the height of the image must not exceed 960 pixels.
See Cleaning signature images for information about cleaning.
[in] | aImageParameters | Parameters controlling how images are converted to bi-level black and white. If this argument is null, all parameters will be set to their respective default value. |
synchronized void cleanFrames | ( | SignDocImageParameters | aImageParameters, |
double | aTrust | ||
) | throws SignDocException |
Clean frames.
This function removes all frames that have a weight smaller than aTrust.
If the image is not a bi-level image, this function will create a bi-level image, clean the bi-level image, and then mask the original image with the cleaned bi-level image, making all parts white that are not considered part of the signature.
The width of the image must not exceed 1280 pixels, the height of the image must not exceed 960 pixels.
See Cleaning signature images for information about cleaning.
[in] | aImageParameters | Parameters controlling how images are converted to bi-level black and white. If this argument is null, all parameters will be set to their respective default value. |
[in] | aTrust | Minimum frame weight (0.0 through 1.0). 0.0 removes dirt, 1.0 removes all frames. |
synchronized void cleanLines | ( | SignDocImageParameters | aImageParameters | ) | throws SignDocException |
Clean lines.
Horizontal and vertical lines will be removed.
If the image is not a bi-level image, this function will create a bi-level image, clean the bi-level image, and then mask the original image with the cleaned bi-level image, making all parts white that are not considered part of the signature.
The width of the image must not exceed 1280 pixels, the height of the image must not exceed 960 pixels.
See Cleaning signature images for information about cleaning.
[in] | aImageParameters | Parameters controlling how images are converted to bi-level black and white. If this argument is null, all parameters will be set to their respective default value. |
synchronized SignDocImageRect cleanSignature | ( | SignDocImageParameters | aImageParameters | ) | throws SignDocException |
Clean a signature image.
This function cleans horizontal Lines, printed text, and dirt not being part of a signature.
After cleaning, the image will be cropped to the signature region.
If the image is not a bi-level image, this function will create a bi-level image, clean the bi-level image, and then crop the original image to the cleaned bi-level image.
If the height or width would become zero, the image will be replaced by a single white pixel (if the image uses a palette, the brightest color in the palette will be used).
The width of the image must not exceed 1280 pixels, the height of the image must not exceed 960 pixels.
See Cleaning signature images for information about cleaning.
[in] | aImageParameters | Parameters controlling how images are converted to bi-level black and white. If this argument is null, all parameters will be set to their respective default value. |
synchronized void clear | ( | ) | throws SignDocException |
Remove the image from this object.
synchronized SignDocImage clone | ( | ) | throws SignDocException |
Clone this object.
synchronized void close | ( | ) |
Destroy the underlying native object (for java.lang.AutoCloseable).
After calling this method, all methods but close() will throw SignDocUnexpectedErrorException.
synchronized void convertToBiLevel | ( | SignDocImageParameters | aImageParameters | ) | throws SignDocException |
Convert the image to bi-level black and white.
This function uses thresholding.
Unlike SignWare's SPImage.binarize(), this function never inverts the image.
[in] | aImageParameters | Parameters controlling how images are converted to bi-level black and white. If this argument is null, all parameters will be set to their respective default value. |
synchronized void convertToGrayscale | ( | ) | throws SignDocException |
Convert the image to 8-bit grayscale.
synchronized void convertToTrueColor | ( | ) | throws SignDocException |
Convert the image to 24-bit RGB (8 bits per color channel).
synchronized void crop | ( | int | aX, |
int | aY, | ||
int | aWidth, | ||
int | aHeight | ||
) | throws SignDocException |
Crop the image.
The the rectangle to be preserved must lie completely within the current image.
[in] | aX | The X coordinate of the upper left corner of the rectangle that will be preserved. |
[in] | aY | The Y coordinate of the upper left corner of the rectangle that will be preserved. |
[in] | aWidth | The width of the rectangle that will be preserved. Must be positive. |
[in] | aHeight | The height of the rectangle that will be preserved. Must be positive. |
synchronized void drawLine | ( | int | aX1, |
int | aY1, | ||
int | aX2, | ||
int | aY2, | ||
double | aStrokeWidth, | ||
int | aColor | ||
) | throws SignDocException |
Draw a line.
[in] | aX1 | X coordinate of the first endpoint of the line. |
[in] | aY1 | Y coordinate of the first endpoint of the line. |
[in] | aX2 | X coordinate of the second endpoint of the line. |
[in] | aY2 | Y coordinate of the second endpoint of the line. |
[in] | aStrokeWidth | Stroke width in pixels (need not be an integer, 0 for minimum width). |
[in] | aColor | The RGB color (0x00rrggbb). This function fails if the color does not exist in the palette of an indexed image. |
synchronized void drawRect | ( | int | aX1, |
int | aY1, | ||
int | aX2, | ||
int | aY2, | ||
double | aRadiusX, | ||
double | aRadiusY, | ||
double | aStrokeWidth, | ||
int | aColor, | ||
boolean | aFill | ||
) | throws SignDocException |
Draw a rectangle (with both lines parallel to the axes).
If aRadiusX and aRadiusY are positive, a quarter ellipse will be drawn in each corner. If aRadiusX or aRadiusY is zero, a normal rectangle will be drawn.
[in] | aX1 | X coordinate of the first corner of the rectangle. |
[in] | aY1 | Y coordinate of the first corner of the rectangle. |
[in] | aX2 | X coordinate of the opposite corner of the rectangle. |
[in] | aY2 | Y coordinate of the opposite corner of the rectangle. |
[in] | aRadiusX | Horizontal radius of quarter ellipse. |
[in] | aRadiusY | Vertical radius of quarter ellipse. |
[in] | aStrokeWidth | Stroke width in pixels (need not be an integer, 0 for minimum width). |
[in] | aColor | The RGB color (0x00rrggbb). This function fails if the color does not exist in the palette of an indexed image. |
[in] | aFill | true to fill interior of rectangle, false to stroke border. For filling you might want do use 0 for aStrokeWidth as the stroked rectangle will be filled, that is, the outer dimensions of the rectangle don't depend on aFill. |
synchronized void drawRect | ( | SignDocImageRect | aRect, |
double | aRadiusX, | ||
double | aRadiusY, | ||
double | aStrokeWidth, | ||
int | aColor, | ||
boolean | aFill | ||
) | throws SignDocException |
Draw a rectangle (with both lines parallel to the axes).
If aRadiusX and aRadiusY are positive, a quarter ellipse will be drawn in each corner. If aRadiusX or aRadiusY is zero, a normal rectangle will be drawn.
[in] | aRect | The rectangle (does not need to be normalized). |
[in] | aRadiusX | Horizontal radius of quarter ellipse. |
[in] | aRadiusY | Vertical radius of quarter ellipse. |
[in] | aStrokeWidth | Stroke width in pixels (need not be an integer, 0 for minimum width). |
[in] | aColor | The RGB color (0x00rrggbb). This function fails if the color does not exist in the palette of an indexed image. |
[in] | aFill | true to fill interior of rectangle, false to stroke border. For filling you might want do use 0 for aStrokeWidth as the stroked rectangle will be filled, that is, the outer dimensions of the rectangle don't depend on aFill. |
|
protected |
Finalize this object.
Do not call this method unless you know what you are doing.
synchronized int getBitsPerComponent | ( | ) | throws SignDocException |
Get the number of bits per component.
synchronized int getBitsPerPixel | ( | ) | throws SignDocException |
Get the number of bits per pixel.
This function returns the product of the return values of getNumberOfComponents() and getBitsPerComponent().
synchronized int getComplexity | ( | SignDocImageParameters | aImageParameters | ) | throws SignDocException |
Compute the complexity of a signature image.
The returned complexity is valid only if this object contains a clean signature image.
The width of the image must not exceed 1280 pixels, the height of the image must not exceed 960 pixels.
[in] | aImageParameters | Parameters controlling how images are converted to bi-level black and white. If this argument is null, all parameters will be set to their respective default value. |
synchronized SignDocWeightedFrame [] getFrames | ( | SignDocImageParameters | aImageParameters | ) | throws SignDocException |
Get the frames of the image.
This function computes the frames and their weights. Frame weights are floating-point numbers in the range 0.0 through 1.0: 0.0 identifies dirt, 1.0 identifies frames that are part of a signature.
If the image is not a bi-level image, this function will create a temporary bi-level image.
The width of the image must not exceed 1280 pixels, the height of the image must not exceed 960 pixels.
See Cleaning signature images for information about cleaning.
[in] | aImageParameters | Parameters controlling how images are converted to bi-level black and white. If this argument is null, all parameters will be set to their respective default value. |
synchronized int getHeight | ( | ) | throws SignDocException |
Get the height of the image.
synchronized int [] getHistogram | ( | ) | throws SignDocException |
Compute a histogram.
This function computes an array of integers the same size as the palette returned by getPalette(). Element i tells how many pixels use palette entry i.
synchronized int getNumberOfComponents | ( | ) | throws SignDocException |
Get the number of components.
|
static |
Get the number of subimages (pages) in a file.
This function opens the file, gets the number of subimages from the file, and closes the file.
[in] | aPath | The pathname of the file to be read. |
|
static |
Get the number of subimages (pages) in a blob.
[in] | aBlob | A blob containing an image in BMP (Windows bitmap), TIFF, PNG, or GIF format. |
synchronized int [] getPalette | ( | ) | throws SignDocException |
Get the palette.
This function gets the palette of the image as an array of integers representing RGB colors (0x00rrggbb). The array will contain 2 elements if getBitsPerPixel() returns 1, 256 elements if getBitsPerPixel() returns 8, or 0 elements otherwise (the image does not use a palette).
synchronized int getPixelRGB | ( | int | aX, |
int | aY | ||
) | throws SignDocException |
Get the RGB color of a pixel.
[in] | aX | X coordinate. |
[in] | aY | Y coordinate. |
synchronized int getPixelValue | ( | int | aX, |
int | aY | ||
) | throws SignDocException |
Get the value of a pixel.
[in] | aX | X coordinate. |
[in] | aY | Y coordinate. |
synchronized int getResolutionX | ( | ) | throws SignDocException |
Get the horizontal resolution of the image.
synchronized int getResolutionY | ( | ) | throws SignDocException |
Get the vertical resolution of the image.
synchronized int [] getSplitPositions | ( | SignDocImageParameters | aImageParameters | ) | throws SignDocException |
Get the vertical split positions of the image.
If the image is not a bi-level image, this function will create a temporary bi-level image.
The width of the image must not exceed 1280 pixels, the height of the image must not exceed 960 pixels.
See Cleaning signature images for information about cleaning.
[in] | aImageParameters | Parameters controlling how images are converted to bi-level black and white. If this argument is null, all parameters will be set to their respective default value. |
synchronized int getWidth | ( | ) | throws SignDocException |
Get the width of the image.
synchronized void invert | ( | boolean | aAuto | ) | throws SignDocException |
Invert the image.
It is unspecified whether inverting is done by modifying the palette or by modifying the pixels.
[in] | aAuto | false to invert the image unconditionally, true to invert the image only if more than half the pixels have brightness (0 through 255) less than 128. |
synchronized void loadFromFile | ( | String | aPath, |
int | aIndex | ||
) | throws SignDocException |
Load an image from a file.
This function opens the file, loads the image from the file, and closes the file.
[in] | aPath | The pathname of the file to be read. |
[in] | aIndex | 0-based page number for selecting a subimage (page) of the source image. |
synchronized void loadFromMemory | ( | byte[] | aBlob, |
int | aIndex | ||
) | throws SignDocException |
Load an image from a blob.
[in] | aBlob | A blob containing an image in BMP (Windows bitmap), TIFF, PNG, or GIF format. |
[in] | aIndex | 0-based page number for selecting a subimage (page) of the source image. |
synchronized SignDocMatchResult matchImage | ( | SignDocImage | aOther, |
SignDocMatchParameters | aMatchParameters | ||
) | throws SignDocException |
Match against a signature image.
The license must allow comparing signatures.
[in] | aOther | The signature image to match against. |
[in] | aMatchParameters | Parameters controlling how signature are matched. If this argument is null, all parameters will be set to their respective default value. |
synchronized SignDocMatchResult matchReference | ( | SignDocSignatureData | aOther, |
SignDocMatchParameters | aMatchParameters, | ||
SignDocImageParameters | aImageParameters | ||
) | throws SignDocException |
Match against a reference.
This function throws an exception if aOther does not have type #SignDocSignatureData.t_reference.
The license must allow comparing signatures.
[in] | aOther | The reference to match against. |
[in] | aMatchParameters | Parameters controlling how signature are matched. If this argument is null, all parameters will be set to their respective default value. |
[in] | aImageParameters | Parameters controlling how signature are rendered as images for static matching. If this argument is null, all parameters will be set to their respective default value. String parameter "Format" will be ignored. |
synchronized SignDocMatchResult matchSignature | ( | SignDocSignatureData | aOther, |
SignDocMatchParameters | aMatchParameters, | ||
SignDocImageParameters | aImageParameters | ||
) | throws SignDocException |
Match against a signature.
If aOther is a reference, SignDocSignatureData.selectSignature() must be called once for @ aOther before this function.
This function throws an exception if aOther has type SignDocSignatureData.t_empty.
The license must allow comparing signatures.
[in] | aOther | The signature or reference to match against. Only a single signature will be used. |
[in] | aMatchParameters | Parameters controlling how signature are matched. If this argument is null, all parameters will be set to their respective default value. |
[in] | aImageParameters | Parameters controlling how signature are rendered as images for static matching. If this argument is null, all parameters will be set to their respective default value. String parameter "Format" will be ignored. |
synchronized void mirrorX | ( | ) | throws SignDocException |
synchronized void mirrorY | ( | ) | throws SignDocException |
synchronized SignDocImageRect removeMargins | ( | SignDocImageParameters | aImageParameters | ) | throws SignDocException |
Remove white margins.
This function removes white margins ignoring single black pixels.
If the image is not a bi-level image, this function will create a bi-level image, clean the bi-level image, and then crop the original image to the cleaned bi-level image.
If the height or width would become zero, the image will be replaced by a single white pixel (if the image uses a palette, the brightest color in the palette will be used).
The width of the image must not exceed 1280 pixels, the height of the image must not exceed 960 pixels.
See Cleaning signature images for information about cleaning.
[in] | aImageParameters | Parameters controlling how images are converted to bi-level black and white. If this argument is null, all parameters will be set to their respective default value. |
synchronized void resizeToResolution | ( | int | aResolutionX, |
int | aResolutionY, | ||
String | aFilter | ||
) | throws SignDocException |
Resize the image.
This function may change the pixel format.
[in] | aResolutionX | The new horizontal resolution of the image in DPI. Must be positive. |
[in] | aResolutionY | The new vertical resolution of the image in DPI. Must be positive. |
[in] | aFilter | The resampling filter, an empty string for the default filter. The following filters are available (case-sensitive):
|
synchronized void rotate | ( | int | aAngle, |
int | aBackgroundColor | ||
) | throws SignDocException |
Rotate the image.
If the image has 1 bit per pixel, aAngle must be an integer multiple of 90.
The resolution of the image is adjusted only if aAngle is an even integer multiple of 90.
This function throws an exception if aAngle is not an integer multiple of 90, the image uses a palette, and aBackgroundColor is not a color in the palette.
[in] | aAngle | Rotation angle (degrees), positive for counter-clockwise, negative for clockwise. |
[in] | aBackgroundColor | The RGB color (0x00rrggbb) to be used for filling pixels that are not mapped from the source image. This value is used only if aAngle is not an integer multiple of 90. |
synchronized void saveToFile | ( | String | aPath, |
SignDocImageParameters | aParameters | ||
) | throws SignDocException |
Save this image to a file.
The following parameters of aParameters are used:
[in] | aPath | The pathname of the file to be created or overwritten. |
[in] | aParameters | Parameters controlling the format of the file. |
synchronized void saveToFile2 | ( | String | aPath, |
String | aFormat | ||
) | throws SignDocException |
Save this image to a file.
This is a simplified version of saveToFile().
[in] | aPath | The pathname of the file to be created or overwritten. |
[in] | aFormat | The format to be used for the image file:
|
synchronized byte [] saveToMemory | ( | SignDocImageParameters | aParameters | ) | throws SignDocException |
Save this image as a blob.
The following parameters of aParameters are used:
[in] | aParameters | Parameters controlling the format of the blob. |
synchronized byte [] saveToMemory2 | ( | String | aFormat | ) | throws SignDocException |
Save this image as a blob.
This is a simplified version of saveToMemory().
[in] | aFormat | The format to be used for the image blob:
|
synchronized void setEmpty | ( | int | aWidth, |
int | aHeight, | ||
int | aBitsPerPixel, | ||
int | aColor | ||
) | throws SignDocException |
Replace this image with an empty one of the specified size.
The resolution will be set to 72 dots per inch.
[in] | aWidth | The width of the image (in pixels). Must be positive. |
[in] | aHeight | The height of the image (in pixels). Must be positive. |
[in] | aBitsPerPixel | Number of bits per pixel: 1 (bi-level black and white), 8 (grayscale), or 24 (RGB). |
[in] | aColor | All pixels will be set to this color. If aBitsPerPixel is 24, this is an RGB color (0x00rrggbb), otherwise this is an index into the palette (0 is black). |
synchronized void setPaletteAt | ( | int | aIndex, |
int | aColor | ||
) | throws SignDocException |
Set a palette entry.
[in] | aIndex | The 0-based index of the palette entry (0 through 1 if getBitsPerPixel() returns 1, 0 through 255 if getBitsPerPixel() returns 8). |
[in] | aColor | The new color for the palette entry (0x00rrggbb). |
synchronized void setPixelRGB | ( | int | aX, |
int | aY, | ||
int | aColor | ||
) | throws SignDocException |
Set the RGB color of a pixel.
[in] | aX | X coordinate. |
[in] | aY | Y coordinate. |
[in] | aColor | The new RGB color of the pixel (0x00rrggbb). This function fails if the color does not exist in the palette of an indexed image. |
synchronized void setPixelValue | ( | int | aX, |
int | aY, | ||
int | aValue | ||
) | throws SignDocException |
Set the value of a pixel.
[in] | aX | X coordinate. |
[in] | aY | Y coordinate. |
[in] | aValue | The new value of the pixel. If getBitsPerPixel() returns 1 or 8, this is the index into the palette, if getBitsPerPixel() returns 24, this is the RGB color (0x00rrggbb). For bi-level images, any value greater than 1 has the same effect as 1. |
synchronized void setResolution | ( | int | aResolutionX, |
int | aResolutionY | ||
) | throws SignDocException |
Set the resolution of the image.
This function does not modify the pixels of the image. Use resizeToResolution() to change the size of the image.
[in] | aResolutionX | The new horizontal resolution of the image in DPI. Must be positive. |
[in] | aResolutionY | The new vertical resolution of the image in DPI. Must be positive. |