org.apache.fop.image
Class XmlGraphicsCommonsImage

java.lang.Object
  org.apache.fop.image.AbstractFopImage
      org.apache.fop.image.XmlGraphicsCommonsImage

All Implemented Interfaces:

FopImage

Direct Known Subclasses:

PNGImage, TIFFImage

public abstract class XmlGraphicsCommonsImage

extends AbstractFopImage

Abstract FopImage implementation which uses the internal codecs from XML Graphics Commons.

See Also:

AbstractFopImage, FopImage

Nested Class Summary

Nested classes inherited from class org.apache.fop.image.FopImage

FopImage.ImageInfo

Field Summary

protected org.apache.xmlgraphics.image.rendered.CachableRed	cr The Batik representation of the image
protected org.apache.xmlgraphics.image.codec.util.SeekableStream	seekableInput The InputStream wrapped into a SeekableStream for decoding.

Fields inherited from class org.apache.fop.image.AbstractFopImage

bitmaps, bitsPerPixel, colorSpace, dpiHorizontal, dpiVertical, height, imageInfo, inputStream, invertImage, isTransparent, loaded, log, raw, transparentColor, width

Fields inherited from interface org.apache.fop.image.FopImage

BITMAP, DIMENSIONS, ORIGINAL_DATA

Constructor Summary

XmlGraphicsCommonsImage(FopImage.ImageInfo imgReader)
Constructs a new BatikImage instance.

Method Summary

protected abstract org.apache.xmlgraphics.image.rendered.CachableRed	decodeImage(org.apache.xmlgraphics.image.codec.util.SeekableStream stream) Decodes the image from the stream.
byte[]	getSoftMask() Get the soft mask.
boolean	hasSoftMask() Check if this image has a soft mask.
protected boolean	loadBitmap() Load a bitmap array of the image.
protected boolean	loadDimensions() Load the dimensions of the image.
protected void	loadImage() Loads the image from the InputStream.

Methods inherited from class org.apache.fop.image.AbstractFopImage

getBitmaps, getBitmapsSize, getBitsPerPixel, getColorSpace, getHeight, getHorizontalResolution, getICCProfile, getIntrinsicHeight, getIntrinsicWidth, getMimeType, getOriginalURI, getRessourceBytes, getRessourceBytesSize, getTransparentColor, getVerticalResolution, getWidth, isInverted, isTransparent, load, loadDefaultOriginalData, loadOriginalData

Methods inherited from class java.lang.Object

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

Field Detail

seekableInput

protected org.apache.xmlgraphics.image.codec.util.SeekableStream seekableInput

The InputStream wrapped into a SeekableStream for decoding.

cr

protected org.apache.xmlgraphics.image.rendered.CachableRed cr

The Batik representation of the image

Constructor Detail

XmlGraphicsCommonsImage

public XmlGraphicsCommonsImage(FopImage.ImageInfo imgReader)

Constructs a new BatikImage instance.

Parameters:

imgReader - basic metadata for the image

Method Detail

loadDimensions

protected boolean loadDimensions()

Description copied from class: AbstractFopImage

Load the dimensions of the image. All implementations should override this to get and return the dimensions.

Overrides:

loadDimensions in class AbstractFopImage

Returns:

true if the loading was successful

See Also:

AbstractFopImage.loadDimensions()

loadBitmap

protected boolean loadBitmap()

Description copied from class: AbstractFopImage

Load a bitmap array of the image. If the renderer requires a bitmap image then the implementations should override this to load the bitmap.

Overrides:

loadBitmap in class AbstractFopImage

Returns:

true if the loading was successful

See Also:

AbstractFopImage.loadBitmap()

hasSoftMask

public boolean hasSoftMask()

Description copied from class: AbstractFopImage

Check if this image has a soft mask.

Specified by:

hasSoftMask in interface FopImage

Overrides:

hasSoftMask in class AbstractFopImage

Returns:

true if the image also has a soft transparency mask

See Also:

FopImage.hasSoftMask()

getSoftMask

public byte[] getSoftMask()

Description copied from class: AbstractFopImage

Get the soft mask. The soft mask should have the same bitdepth as the image data.

Specified by:

getSoftMask in interface FopImage

Overrides:

getSoftMask in class AbstractFopImage

Returns:

the data array of soft mask values

See Also:

FopImage.getSoftMask()

decodeImage

protected abstract org.apache.xmlgraphics.image.rendered.CachableRed decodeImage(org.apache.xmlgraphics.image.codec.util.SeekableStream stream)
                                                                          throws java.io.IOException

Decodes the image from the stream.

Parameters:

stream - the stream to read the image from

Returns:

the decoded image

Throws:

java.io.IOException - in case an I/O problem occurs

loadImage

protected void loadImage()

Loads the image from the InputStream.