RMImageData (ReportMill 13 API)

java.lang.Object
- com.reportmill.graphics.RMImageData

All Implemented Interfaces:

java.lang.Cloneable
```
public class RMImageData
extends java.lang.Object
implements java.lang.Cloneable
```
This class manages image data. Each instance holds the raw image data and provides methods to return attributes of the decoded image.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RMImageData.ImageReader
An interface for classes that can handle image reading for RMImageData.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RMImageData.ImageReader` An interface for classes that can handle image reading for RMImageData.

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`canRead(java.lang.String anExt)` Returns whether given extension is supported.
`RMImageData`	`clone()` Standard clone implementation.
`boolean`	`equals(java.lang.Object anObj)` Standard equals implementation.
`int`	`getAlphaColorIndex()` Color map support: returns the index of the transparent color in a color map image.
`int`	`getBitsPerPixel()` Returns the number of bits per pixel (derived from bits per sample and samples per pixel).
`int`	`getBitsPerSample()` Returns the number of bits per sample (eg, 24 bit RGB image is 8 bits per sample).
`byte[]`	`getBytes()` Returns the original bytes for the image (loaded from the source).
`byte[]`	`getBytesDecoded()` Returns the decoded image bytes for the image.
`int`	`getBytesPerRow()` Returns the number of bytes per row (derived from width and bits per pixel).
`byte[]`	`getColorMap()` Color map support: returns the bytes of color map from a color map image.
`int`	`getHeight()` Returns the number of pixels vertically.
`float`	`getHeight2D()` Returns the actual display height of the image in printer's points using the image DPI if available.
`java.awt.image.BufferedImage`	`getImage()` Returns the buffered image for image data.
`static RMImageData`	`getImageData(java.lang.Object aSource)` Returns an image data loaded from aSource.
`static RMImageData`	`getImageData(java.lang.Object aSource, int aPageIndex)` Returns an image data loaded from aSource.
`long`	`getModifiedTime()` Returns the modified time of source.
`java.lang.String`	`getName()` Returns the name for the image (assigned from our hashCode).
`RMImageData`	`getPage(int aPage)` Returns the image data for a successive page.
`int`	`getPageCount()` Returns the total number of pages for the image.
`int`	`getPageNumber()` Returns the page index for the image.
`RMImageData.ImageReader`	`getReader()` Returns the reader used to load the image.
`int`	`getSamplesPerPixel()` Returns the number of samples per pixel (RGB=3, RGBA=4, GrayScale=1, etc.).
`java.lang.Object`	`getSource()` Returns the original source for the image (byte[], File, InputStream or whatever).
`java.lang.String`	`getType()` Returns the type for the image (one of gif, jpg, png, pdf, etc.).
`int`	`getWidth()` Returns the number of pixels horizontally.
`float`	`getWidth2D()` Returns the actual display width of the image in printer's points using the image DPI if available.
`boolean`	`hasAlpha()` Color map support: returns whether color map image has a transparent color.
`boolean`	`hasColorMap()` Returns whether image uses a color map.
`boolean`	`isColor()` Returns whether the image is non-grayscale.
`boolean`	`isValid()` Returns whether the image was loaded successfully.
`void`	`paint(java.awt.Graphics2D g, double x, double y, double w, double h)` Draws image data in given rect.
`void`	`setSource(java.lang.Object aSource, int aPageIndex)` Sets the source.

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getImageData
```
public static RMImageData getImageData(java.lang.Object aSource)
```
    Returns an image data loaded from aSource.
  - getImageData
```
public static RMImageData getImageData(java.lang.Object aSource,
                       int aPageIndex)
```
    Returns an image data loaded from aSource. If image type supports multiple pages, page index can be specified.
  - getSource
```
public java.lang.Object getSource()
```
    Returns the original source for the image (byte[], File, InputStream or whatever).
  - setSource
```
public void setSource(java.lang.Object aSource,
             int aPageIndex)
```
    Sets the source.
  - getModifiedTime
```
public long getModifiedTime()
```
    Returns the modified time of source.
  - getImage
```
public java.awt.image.BufferedImage getImage()
```
    Returns the buffered image for image data.
  - getBytes
```
public byte[] getBytes()
```
    Returns the original bytes for the image (loaded from the source).
  - getBytesDecoded
```
public byte[] getBytesDecoded()
```
    Returns the decoded image bytes for the image.
  - getName
```
public java.lang.String getName()
```
    Returns the name for the image (assigned from our hashCode).
  - getType
```
public java.lang.String getType()
```
    Returns the type for the image (one of gif, jpg, png, pdf, etc.).
  - getPageNumber
```
public int getPageNumber()
```
    Returns the page index for the image.
  - getPageCount
```
public int getPageCount()
```
    Returns the total number of pages for the image.
  - getWidth
```
public int getWidth()
```
    Returns the number of pixels horizontally.
  - getHeight
```
public int getHeight()
```
    Returns the number of pixels vertically.
  - getWidth2D
```
public float getWidth2D()
```
    Returns the actual display width of the image in printer's points using the image DPI if available.
  - getHeight2D
```
public float getHeight2D()
```
    Returns the actual display height of the image in printer's points using the image DPI if available.
  - isColor
```
public boolean isColor()
```
    Returns whether the image is non-grayscale.
  - getSamplesPerPixel
```
public int getSamplesPerPixel()
```
    Returns the number of samples per pixel (RGB=3, RGBA=4, GrayScale=1, etc.).
  - getBitsPerSample
```
public int getBitsPerSample()
```
    Returns the number of bits per sample (eg, 24 bit RGB image is 8 bits per sample).
  - getBitsPerPixel
```
public int getBitsPerPixel()
```
    Returns the number of bits per pixel (derived from bits per sample and samples per pixel).
  - getBytesPerRow
```
public int getBytesPerRow()
```
    Returns the number of bytes per row (derived from width and bits per pixel).
  - hasAlpha
```
public boolean hasAlpha()
```
    Color map support: returns whether color map image has a transparent color.
  - getAlphaColorIndex
```
public int getAlphaColorIndex()
```
    Color map support: returns the index of the transparent color in a color map image.
  - hasColorMap
```
public boolean hasColorMap()
```
    Returns whether image uses a color map.
  - getColorMap
```
public byte[] getColorMap()
```
    Color map support: returns the bytes of color map from a color map image.
  - getPage
```
public RMImageData getPage(int aPage)
```
    Returns the image data for a successive page.
  - getReader
```
public RMImageData.ImageReader getReader()
```
    Returns the reader used to load the image.
  - isValid
```
public boolean isValid()
```
    Returns whether the image was loaded successfully.
  - equals
```
public boolean equals(java.lang.Object anObj)
```
    Standard equals implementation.
    
    Overrides:
    
    equals in class java.lang.Object
  - clone
```
public RMImageData clone()
```
    Standard clone implementation.
    
    Overrides:
    
    clone in class java.lang.Object
  - canRead
```
public static boolean canRead(java.lang.String anExt)
```
    Returns whether given extension is supported.
  - paint
```
public void paint(java.awt.Graphics2D g,
         double x,
         double y,
         double w,
         double h)
```
    Draws image data in given rect.

Class RMImageData

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getImageData

getImageData

getSource

setSource

getModifiedTime

getImage

getBytes

getBytesDecoded

getName

getType

getPageNumber

getPageCount

getWidth

getHeight

getWidth2D

getHeight2D

isColor

getSamplesPerPixel

getBitsPerSample

getBitsPerPixel

getBytesPerRow

hasAlpha

getAlphaColorIndex

hasColorMap

getColorMap

getPage

getReader

isValid

equals

clone

canRead

paint