IImageInstance (Qoppa jPDFEditor API)

```
public interface IImageInstance
```
Representation of an instance of an image displayed on a page. The same image can be reused many times across pages and within a page, so this interface represents each instance of each image displayed somewhere in the document.

Author:

Qoppa Software

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getBitsPerComponent()` Returns the number of bits per component.
`String`	`getColorSpace()` Returns the name of the color space used for this image.
`String`	`getCompression()` Return the compression used for this image.
`float`	`getDisplayHeight()` Returns the height of the image when it is displayed, in points (72 points per inch).
`float`	`getDisplayWidth()` Returns the width of the image when it is displayed, in points (72 points per inch).
`float`	`getDisplayX()` Returns the x coordinate of the image when it is displayed, in points (72 points per inch).
`float`	`getDisplayY()` Returns the y coordinate of the image when it is displayed, in points (72 points per inch).
`float`	`getDPI_X()` Returns the horizontal DPI value for this image instance.
`float`	`getDPI_Y()` Returns the vertical DPI value for this image instance.
`int`	`getHeight()` Return the height of the image, in pixels.
`BufferedImage`	`getImage()` This method returns a BufferedImage object for the image embedded in the PDF document.
`int`	`getNumComponents()` Returns the number of color components in the image.
`int`	`getPageIndex()` Returns the page index where this image instance is displayed.
`int`	`getWidth()` Return the width of the image, in pixels.

- Method Detail
  - getImage
```
BufferedImage getImage()
                throws PDFException
```
    This method returns a BufferedImage object for the image embedded in the PDF document.
    
    Returns:
    
    The image in the image resource.
    
    Throws:
    
    PDFException
  - getWidth
```
int getWidth()
      throws PDFException
```
    Return the width of the image, in pixels.
    
    Returns:
    
    The width of the image in pixels.
    
    Throws:
    
    PDFException
  - getPageIndex
```
int getPageIndex()
```
    Returns the page index where this image instance is displayed.
    
    Returns:
    
    The index of the page where the image is displayed.
  - getDisplayX
```
float getDisplayX()
```
    Returns the x coordinate of the image when it is displayed, in points (72 points per inch).
    
    Returns:
    
    The display x coordinate of the image.
  - getDisplayY
```
float getDisplayY()
```
    Returns the y coordinate of the image when it is displayed, in points (72 points per inch).
    
    Returns:
    
    The display y coordinate of the image.
  - getDisplayWidth
```
float getDisplayWidth()
```
    Returns the width of the image when it is displayed, in points (72 points per inch).
    
    Returns:
    
    The display width of the image.
  - getDisplayHeight
```
float getDisplayHeight()
```
    Returns the height of the image when it is displayed, in points (72 points per inch).
    
    Returns:
    
    The display height of the image.
  - getDPI_X
```
float getDPI_X()
        throws PDFException
```
    Returns the horizontal DPI value for this image instance. The DPI is calculated by dividing the full width of the image by the width in inches at which it is displayed.
    
    Returns:
    
    The horizontal DPI value for this instance of the image.
    
    Throws:
    
    PDFException
  - getDPI_Y
```
float getDPI_Y()
        throws PDFException
```
    Returns the vertical DPI value for this image instance. The DPI is calculated by dividing the full height of the image by the height in inches at which it is displayed.
    
    Returns:
    
    The height DPI value for this instance of the image.
    
    Throws:
    
    PDFException
  - getHeight
```
int getHeight()
       throws PDFException
```
    Return the height of the image, in pixels.
    
    Returns:
    
    The height of the image in pixels.
    
    Throws:
    
    PDFException - if there is an error reading the image.
  - getCompression
```
String getCompression()
               throws PDFException
```
    Return the compression used for this image. The string returned by this method is the internal PDF name for the image compression. Some common image compression methods:
    - DCTDecode - JPEG
    - JPXDecode - JPEG 2000
    - CCITTFaxDecode - CCITT Fax Group 3 or Group 4
    - JBIG2Decode - JBIG 2
    Returns:
    
    the name of the image compression
    
    Throws:
    
    PDFException - if there is an error reading the image.
  - getColorSpace
```
String getColorSpace()
              throws PDFException
```
    Returns the name of the color space used for this image.
    
    Returns:
    
    the color space name for the image
    
    Throws:
    
    PDFException - if there is an error reading the image.
  - getNumComponents
```
int getNumComponents()
              throws PDFException
```
    Returns the number of color components in the image.
    
    Returns:
    
    the number of color components
    
    Throws:
    
    PDFException - if there is an error reading the image.
  - getBitsPerComponent
```
int getBitsPerComponent()
                 throws PDFException
```
    Returns the number of bits per component.
    
    Returns:
    
    the number of bits per component.
    
    Throws:
    
    PDFException - if there is an error reading the image.

Interface IImageInstance

Method Summary

Method Detail

getImage

getWidth

getPageIndex

getDisplayX

getDisplayY

getDisplayWidth

getDisplayHeight

getDPI_X

getDPI_Y

getHeight

getCompression

getColorSpace

getNumComponents

getBitsPerComponent