xmlgraphics-commons 1.3

org.apache.xmlgraphics.ps
Class ImageEncodingHelper

java.lang.Object
  extended by org.apache.xmlgraphics.ps.ImageEncodingHelper

public class ImageEncodingHelper
extends java.lang.Object

Helper class for encoding bitmap images.


Constructor Summary
ImageEncodingHelper(java.awt.image.RenderedImage image)
          Main constructor
 
Method Summary
static ImageEncoder createRenderedImageEncoder(java.awt.image.RenderedImage img)
          Create an ImageEncoder for the given RenderImage instance.
protected  void determineEncodedColorModel()
          Determines the color model used for encoding the image.
 void encode(java.io.OutputStream out)
          Encodes the image and writes everything to the given OutputStream.
 void encodeAlpha(java.io.OutputStream out)
          Encodes the image's alpha channel.
static void encodePackedColorComponents(java.awt.image.RenderedImage image, java.io.OutputStream out)
          Writes all pixels (color components only) of a RenderedImage to an OutputStream.
static void encodeRenderedImageAsRGB(java.awt.image.RenderedImage image, java.io.OutputStream out)
          Writes a RenderedImage to an OutputStream by converting it to RGB.
 java.awt.image.ColorModel getEncodedColorModel()
          Returns the effective ColorModel used to encode the image.
 java.awt.image.RenderedImage getImage()
          Returns the associated image.
 java.awt.image.ColorModel getNativeColorModel()
          Returns the native ColorModel used by the image.
 boolean hasAlpha()
          Indicates whether the image has an alpha channel.
 boolean isConverted()
          Indicates whether the image is converted during encodation.
protected  boolean isMultiTile()
          Indicates whether the image consists of multiple tiles.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImageEncodingHelper

public ImageEncodingHelper(java.awt.image.RenderedImage image)
Main constructor

Parameters:
image - the image
Method Detail

getImage

public java.awt.image.RenderedImage getImage()
Returns the associated image.

Returns:
the image

getNativeColorModel

public java.awt.image.ColorModel getNativeColorModel()
Returns the native ColorModel used by the image.

Returns:
the native color model

getEncodedColorModel

public java.awt.image.ColorModel getEncodedColorModel()
Returns the effective ColorModel used to encode the image. If this is different from the value returned by getNativeColorModel() this means that the image is converted in order to encode it because no native encoding is currently possible.

Returns:
the effective color model

hasAlpha

public boolean hasAlpha()
Indicates whether the image has an alpha channel.

Returns:
true if the image has an alpha channel

isConverted

public boolean isConverted()
Indicates whether the image is converted during encodation.

Returns:
true if the image cannot be encoded in its native format

encodeRenderedImageAsRGB

public static void encodeRenderedImageAsRGB(java.awt.image.RenderedImage image,
                                            java.io.OutputStream out)
                                     throws java.io.IOException
Writes a RenderedImage to an OutputStream by converting it to RGB.

Parameters:
image - the image
out - the OutputStream to write the pixels to
Throws:
java.io.IOException - if an I/O error occurs

isMultiTile

protected boolean isMultiTile()
Indicates whether the image consists of multiple tiles.

Returns:
true if there are multiple tiles

determineEncodedColorModel

protected void determineEncodedColorModel()
Determines the color model used for encoding the image.


encode

public void encode(java.io.OutputStream out)
            throws java.io.IOException
Encodes the image and writes everything to the given OutputStream.

Parameters:
out - the OutputStream
Throws:
java.io.IOException - if an I/O error occurs

encodeAlpha

public void encodeAlpha(java.io.OutputStream out)
                 throws java.io.IOException
Encodes the image's alpha channel. If it doesn't have an alpha channel, an IllegalStateException is thrown.

Parameters:
out - the OutputStream
Throws:
java.io.IOException - if an I/O error occurs

encodePackedColorComponents

public static void encodePackedColorComponents(java.awt.image.RenderedImage image,
                                               java.io.OutputStream out)
                                        throws java.io.IOException
Writes all pixels (color components only) of a RenderedImage to an OutputStream.

Parameters:
image - the image to be encoded
out - the OutputStream to write to
Throws:
java.io.IOException - if an I/O error occurs

createRenderedImageEncoder

public static ImageEncoder createRenderedImageEncoder(java.awt.image.RenderedImage img)
Create an ImageEncoder for the given RenderImage instance.

Parameters:
img - the image
Returns:
the requested ImageEncoder

xmlgraphics-commons 1.3

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.