ClearImageJNI
Class ICiImage

java.lang.Object
  ClearImageJNI.CiSuperObject
      ClearImageJNI.ICiImage

public class ICiImage
extends CiSuperObject

ICiImage Interface.

This class corresponds to a COM interface. Objects of this class are not created directly, but are obtained by calling methods of other COM objects.

Field Summary

Fields inherited from class ClearImageJNI.CiSuperObject

lockObject

Constructor Summary

ICiImage(long oIn)

Method Summary

void	Append(java.lang.String FileName, EFileFormat Format) Append image to file.
void	Clear() Set all pixels to white.
void	Close() Close image.
void	Copy(ICiImage ImageFrom) Copy image to another image.
void	CopyToClipboard() Copy image to clipboard.
void	Create(int Width, int Height) Create a Bitonal image.
void	CreateBpp(int Width, int Height, int BitsPerPixel) Create an image (bpp = 1, 8, 24).
ICiImage	CreateZone(int left, int top, int right, int bottom) Create new Zone within image.
ICiImage	CreateZoneRect(ICiRect Rect) Create new Zone within image.
void	Crop(int left, int top, int right, int bottom) Crop rectangle.
void	Dispose() Dispose object
ICiImage	Duplicate() Create a duplicate of this CiImage object.
void	Flip() Rotate image upside down.
void	FlipHorz() Flip image around horizontal axis.
void	FlipVert() Flip image around vertical axis.
int	getBitsPerPixel() Number of bits to store each pixel.
int	getCx2l(int i) property cx2l.
java.lang.String	getFileName() Image file name.
EFileFormat	getFormat() Image file format.
int	getHeight() Image height in pixels.
int	getHorzDpi() Horizontal resolution in dots-per-inch.
java.lang.String	getInfo(java.lang.String Type)
EBoolean	getIsModified() Image was modified flag.
EBoolean	getIsValid() Image is opened.
EBoolean	getIsZone() Object represents a zone on another image.
int	getJpegQuality() Quality of Jpeg Compression 0-100.
int	getLineBytes() Image memory line width in bytes.
int	getPageCount() Number of pages in image file.
int	getPageNumber() Image page number in image file.
ICiImage	getParent() Object containing image memory of this object.
EComprBitonal	getPComprBitonal() TIFF/PDF Compression to save Bitonal image.
EComprColor	getPComprColor() TIFF/PDF Compression to save Color/GS image.
ICiPdf	getPdf() property Pdf.
int	getVertDpi() Vertical resolution in dots-per-inch.
int	getWidth() Image width in pixels.
ICiRect	getZone() Current zone coordinates.
void	Invert() Invert image pixels.
void	LoadFromMemory(byte[] data) Load image data from byte array (ClearImage COM - compatible)
void	LoadFromMemoryEx(byte[] data) Load image data from byte array (extended)
void	Open(java.lang.String FileName, int PageNumber) Create image from image file.
void	OpenFromBitmap(int hBitmap) Create image from Windows Bitmap.
void	OpenFromClipboard() Create image from Clipboard.
boolean	OpenFromFileBMP(java.lang.String FileName) Create image from BMP image file.
void	RotateLeft() Rotate image to the left.
void	RotateRight() Rotate image to the right.
void	Save() Save image into its image file.
void	SaveAs(java.lang.String FileName, EFileFormat Format) Save image in new file.
int	SaveToBitmap() Copy image to new Windows Bitmap.
int	SaveToDIB() Copy image to new Windows DIB.
void	SaveToFileBMP(java.lang.String FileName) Save image in new BMP file.
byte[]	SaveToMemory() Copy image data to byte array
byte[]	SaveToMemoryEx(int LineWidth) Copy image data to byte array (extended)
void	setCx2l(int i, int arg) property cx2l.
void	setHorzDpi(int arg) Horizontal resolution in dots-per-inch.
void	setInfo(java.lang.String Type, java.lang.String arg)
void	setJpegQuality(int arg) Quality of Jpeg Compression 0-100.
void	setPComprBitonal(EComprBitonal arg) TIFF/PDF Compression to save Bitonal image.
void	setPComprColor(EComprColor arg) TIFF/PDF Compression to save Color/GS image.
void	setVertDpi(int arg) Vertical resolution in dots-per-inch.
void	ToBitonal() method ToBitonal.
void	ToGrayscale() method ToGrayscale.

Methods inherited from class ClearImageJNI.CiSuperObject

CleanUp

Methods inherited from class java.lang.Object

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

Constructor Detail

ICiImage

public ICiImage(long oIn)

Method Detail

Create

public void Create(int Width,
                   int Height)
            throws CiException

Create a Bitonal image.

Throws:

CiException

Close

public void Close()
           throws CiException

Close image.

Throws:

CiException

Open

public void Open(java.lang.String FileName,
                 int PageNumber)
          throws CiException

Create image from image file.

Throws:

CiException

OpenFromFileBMP

public boolean OpenFromFileBMP(java.lang.String FileName)

Create image from BMP image file.

getZone

public ICiRect getZone()
                throws CiException

Current zone coordinates.

Throws:

CiException

SaveAs

public void SaveAs(java.lang.String FileName,
                   EFileFormat Format)
            throws CiException

Save image in new file.

Throws:

CiException

SaveToFileBMP

public void SaveToFileBMP(java.lang.String FileName)
                   throws CiException

Save image in new BMP file.

Throws:

CiException

Invert

public void Invert()
            throws CiException

Invert image pixels.

Throws:

CiException

Clear

public void Clear()
           throws CiException

Set all pixels to white.

Throws:

CiException

FlipVert

public void FlipVert()
              throws CiException

Flip image around vertical axis.

Throws:

CiException

FlipHorz

public void FlipHorz()
              throws CiException

Flip image around horizontal axis.

Throws:

CiException

RotateRight

public void RotateRight()
                 throws CiException

Rotate image to the right.

Throws:

CiException

RotateLeft

public void RotateLeft()
                throws CiException

Rotate image to the left.

Throws:

CiException

Flip

public void Flip()
          throws CiException

Rotate image upside down.

Throws:

CiException

Append

public void Append(java.lang.String FileName,
                   EFileFormat Format)
            throws CiException

Append image to file.

Throws:

CiException

getWidth

public int getWidth()
             throws CiException

Image width in pixels.

Throws:

CiException

getHeight

public int getHeight()
              throws CiException

Image height in pixels.

Throws:

CiException

setHorzDpi

public void setHorzDpi(int arg)
                throws CiException

Horizontal resolution in dots-per-inch.

Throws:

CiException

getHorzDpi

public int getHorzDpi()
               throws CiException

Horizontal resolution in dots-per-inch.

Throws:

CiException

getVertDpi

public int getVertDpi()
               throws CiException

Vertical resolution in dots-per-inch.

Throws:

CiException

setVertDpi

public void setVertDpi(int arg)
                throws CiException

Vertical resolution in dots-per-inch.

Throws:

CiException

Copy

public void Copy(ICiImage ImageFrom)
          throws CiException

Copy image to another image.

Throws:

CiException

getIsModified

public EBoolean getIsModified()
                       throws CiException

Image was modified flag.

Throws:

CiException

getFileName

public java.lang.String getFileName()
                             throws CiException

Image file name.

Throws:

CiException

getPageNumber

public int getPageNumber()
                  throws CiException

Image page number in image file.

Throws:

CiException

getPageCount

public int getPageCount()
                 throws CiException

Number of pages in image file.

Throws:

CiException

Save

public void Save()
          throws CiException

Save image into its image file.

Throws:

CiException

CopyToClipboard

public void CopyToClipboard()
                     throws CiException

Copy image to clipboard.

Throws:

CiException

SaveToBitmap

public int SaveToBitmap()
                 throws CiException

Copy image to new Windows Bitmap.

Throws:

CiException

SaveToDIB

public int SaveToDIB()
              throws CiException

Copy image to new Windows DIB.

Throws:

CiException

SaveToMemory

public byte[] SaveToMemory()
                    throws CiException

Copy image data to byte array

Returns:

byte array with image data - Bitonal: each pixel is represented by one bit Bit value for white pixel is 1, for black pixel is 0 Data start with the first line. - Grayscale image each pixel is represented by one byte Byte value from 0x00 (black) to 0xFF (white) Data start with the last line. - Color: each pixel is represented by 3 bytes (RGB) Byte value from 0x00 (lowest brightness) to 0xFF (highest brightness) Data start with the last line.

Throws:

CiException

SaveToMemoryEx

public byte[] SaveToMemoryEx(int LineWidth)
                      throws CiException

Copy image data to byte array (extended)

Parameters:

LineWidth - - requested number of bytes per line. If set to 0 (zero) returned buffer is 4-bytes aligned

Returns:

byte array with image data - data start with the first line. Bitonal: each pixel is represented by one bit Bit value for white pixel is 1, for black pixel is 0 Grayscale: each pixel is represented by one byte Byte value from 0x00 (black) to 0xFF (white) Color: each pixel is represented by 3 bytes (RGB) Byte value from 0x00 (lowest brightness) to 0xFF (highest brightness)

Throws:

CiException

OpenFromClipboard

public void OpenFromClipboard()
                       throws CiException

Create image from Clipboard.

Throws:

CiException

OpenFromBitmap

public void OpenFromBitmap(int hBitmap)
                    throws CiException

Create image from Windows Bitmap.

Throws:

CiException

LoadFromMemory

public void LoadFromMemory(byte[] data)
                    throws CiException

Load image data from byte array (ClearImage COM - compatible)

Parameters:

data - - image data. data.length should be multiples if ICiImage.getHeight() - Bitonal: each pixel is represented by one bit Bit value for white pixel is 1, for black pixel is 0 Data start with the first line. - Grayscale image each pixel is represented by one byte Byte value from 0x00 (black) to 0xFF (white) Data start with the last line. - Color: each pixel is represented by 3 bytes (RGB) Byte value from 0x00 (lowest brightness) to 0xFF (highest brightness) Data start with the last line.

Throws:

CiException

LoadFromMemoryEx

public void LoadFromMemoryEx(byte[] data)
                      throws CiException

Load image data from byte array (extended)

Parameters:

data - - image data. data.length should be multiples if ICiImage.getHeight() - data start with the first line. Bitonal: each pixel is represented by one bit Bit value for white pixel is 1, for black pixel is 0 Grayscale: each pixel is represented by one byte Byte value from 0x00 (black) to 0xFF (white) Color: each pixel is represented by 3 bytes (RGB) Byte value from 0x00 (lowest brightness) to 0xFF (highest brightness)

Throws:

CiException

getFormat

public EFileFormat getFormat()
                      throws CiException

Image file format.

Throws:

CiException

CreateZoneRect

public ICiImage CreateZoneRect(ICiRect Rect)
                        throws CiException

Create new Zone within image.

Throws:

CiException

CreateZone

public ICiImage CreateZone(int left,
                           int top,
                           int right,
                           int bottom)
                    throws CiException

Create new Zone within image.

Throws:

CiException

getIsZone

public EBoolean getIsZone()
                   throws CiException

Object represents a zone on another image.

Throws:

CiException

getParent

public ICiImage getParent()
                   throws CiException

Object containing image memory of this object.

Throws:

CiException

Duplicate

public ICiImage Duplicate()
                   throws CiException

Create a duplicate of this CiImage object.

Throws:

CiException

Crop

public void Crop(int left,
                 int top,
                 int right,
                 int bottom)
          throws CiException

Crop rectangle.

Throws:

CiException

getLineBytes

public int getLineBytes()
                 throws CiException

Image memory line width in bytes.

Throws:

CiException

getBitsPerPixel

public int getBitsPerPixel()
                    throws CiException

Number of bits to store each pixel.

Throws:

CiException

CreateBpp

public void CreateBpp(int Width,
                      int Height,
                      int BitsPerPixel)
               throws CiException

Create an image (bpp = 1, 8, 24).

Throws:

CiException

getJpegQuality

public int getJpegQuality()
                   throws CiException

Quality of Jpeg Compression 0-100.

Throws:

CiException

setJpegQuality

public void setJpegQuality(int arg)
                    throws CiException

Quality of Jpeg Compression 0-100.

Throws:

CiException

getIsValid

public EBoolean getIsValid()
                    throws CiException

Image is opened.

Throws:

CiException

getCx2l

public int getCx2l(int i)
            throws CiException

property cx2l.

Throws:

CiException

setCx2l

public void setCx2l(int i,
                    int arg)
             throws CiException

property cx2l.

Throws:

CiException

getPdf

public ICiPdf getPdf()
              throws CiException

property Pdf.

Throws:

CiException

ToBitonal

public void ToBitonal()
               throws CiException

method ToBitonal.

Throws:

CiException

ToGrayscale

public void ToGrayscale()
                 throws CiException

method ToGrayscale.

Throws:

CiException

getPComprColor

public EComprColor getPComprColor()
                           throws CiException

TIFF/PDF Compression to save Color/GS image.

Throws:

CiException

setPComprColor

public void setPComprColor(EComprColor arg)
                    throws CiException

TIFF/PDF Compression to save Color/GS image.

Throws:

CiException

getPComprBitonal

public EComprBitonal getPComprBitonal()
                               throws CiException

TIFF/PDF Compression to save Bitonal image.

Throws:

CiException

setPComprBitonal

public void setPComprBitonal(EComprBitonal arg)
                      throws CiException

TIFF/PDF Compression to save Bitonal image.

Throws:

CiException

getInfo

public java.lang.String getInfo(java.lang.String Type)
                         throws CiException

Throws:

CiException

setInfo

public void setInfo(java.lang.String Type,
                    java.lang.String arg)
             throws CiException

Throws:

CiException

Dispose

public void Dispose()
             throws CiException

Dispose object

Throws:

CiException