fop 1.0

org.apache.fop.render.pdf
Class ImageRenderedAdapter

java.lang.Object
  extended byorg.apache.fop.render.pdf.AbstractImageAdapter
      extended byorg.apache.fop.render.pdf.ImageRenderedAdapter
All Implemented Interfaces:
PDFImage

public class ImageRenderedAdapter
extends AbstractImageAdapter

PDFImage implementation for the PDF renderer which handles RenderedImages.


Field Summary
 
Fields inherited from class org.apache.fop.render.pdf.AbstractImageAdapter
image
 
Constructor Summary
ImageRenderedAdapter(org.apache.xmlgraphics.image.loader.impl.ImageRendered image, java.lang.String key)
          Creates a new PDFImage from an Image instance.
 
Method Summary
 int getBitsPerComponent()
          Get the bits per color component for this image.
 PDFDeviceColorSpace getColorSpace()
          Get the color space for this image. Possible results are: DeviceGray, DeviceRGB, or DeviceCMYK
protected  java.awt.color.ICC_Profile getEffectiveICCProfile()
          Returns the effective ICC profile for the image.
 java.lang.String getFilterHint()
          Returns a hint in form of a String (Possible values from PDFFilterList) indicating which filter setup should be used to encode the object.
 int getHeight()
          Get the image height in pixels.
 org.apache.xmlgraphics.image.loader.impl.ImageRendered getImage()
          Returns the ImageRendered instance for this adapter.
protected  java.awt.color.ColorSpace getImageColorSpace()
          Returns the image's color space.
 java.lang.String getMask()
          Get the PDF reference for a bitmap mask.
 PDFFilter getPDFFilter()
          Get the PDF Filter to be applied to the image.
 PDFReference getSoftMaskReference()
          Get the PDF reference for a soft mask.
 PDFColor getTransparentColor()
          Get the transparent color.
 int getWidth()
          Get the image width in pixels.
 boolean isTransparent()
          Check if this image has a transparent color transparency.
 void outputContents(java.io.OutputStream out)
          Writes the raw, unencoded contents of the image to a given output stream.
 void populateXObjectDictionary(PDFDictionary dict)
          Populates the XObject's dictionary with additional values. The values are added to the dictionary after all the values obtained from other methods from this interface have been put into the dictionary. That allows to override certain values.
 void setup(PDFDocument doc)
          Setup the PDF image for the current document. Some image formats may need to access the document (for example to add an ICC profile to the document).
 
Methods inherited from class org.apache.fop.render.pdf.AbstractImageAdapter
getICCStream, getKey, getSoftMask, isInverted, isPS, toPDFColorSpace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImageRenderedAdapter

public ImageRenderedAdapter(org.apache.xmlgraphics.image.loader.impl.ImageRendered image,
                            java.lang.String key)
Creates a new PDFImage from an Image instance.

Parameters:
image - the image
key - XObject key
Method Detail

getImage

public org.apache.xmlgraphics.image.loader.impl.ImageRendered getImage()
Returns the ImageRendered instance for this adapter.

Returns:
the ImageRendered instance

getWidth

public int getWidth()
Get the image width in pixels.

Specified by:
getWidth in interface PDFImage
Overrides:
getWidth in class AbstractImageAdapter

getHeight

public int getHeight()
Get the image height in pixels.

Specified by:
getHeight in interface PDFImage
Overrides:
getHeight in class AbstractImageAdapter

getImageColorSpace

protected java.awt.color.ColorSpace getImageColorSpace()
Returns the image's color space.

Overrides:
getImageColorSpace in class AbstractImageAdapter
Returns:
the color space

getEffectiveICCProfile

protected java.awt.color.ICC_Profile getEffectiveICCProfile()
Returns the effective ICC profile for the image.

Overrides:
getEffectiveICCProfile in class AbstractImageAdapter
Returns:
an ICC profile or null

setup

public void setup(PDFDocument doc)
Setup the PDF image for the current document. Some image formats may need to access the document (for example to add an ICC profile to the document).

Specified by:
setup in interface PDFImage
Overrides:
setup in class AbstractImageAdapter

getColorSpace

public PDFDeviceColorSpace getColorSpace()
Get the color space for this image. Possible results are: DeviceGray, DeviceRGB, or DeviceCMYK

Returns:
the color space

getBitsPerComponent

public int getBitsPerComponent()
Get the bits per color component for this image.

Returns:
the bits per component

isTransparent

public boolean isTransparent()
Check if this image has a transparent color transparency.

Specified by:
isTransparent in interface PDFImage
Overrides:
isTransparent in class AbstractImageAdapter

getTransparentColor

public PDFColor getTransparentColor()
Get the transparent color.

Specified by:
getTransparentColor in interface PDFImage
Overrides:
getTransparentColor in class AbstractImageAdapter

getMask

public java.lang.String getMask()
Get the PDF reference for a bitmap mask.

Specified by:
getMask in interface PDFImage
Overrides:
getMask in class AbstractImageAdapter

getSoftMaskReference

public PDFReference getSoftMaskReference()
Get the PDF reference for a soft mask.

Specified by:
getSoftMaskReference in interface PDFImage
Overrides:
getSoftMaskReference in class AbstractImageAdapter

getPDFFilter

public PDFFilter getPDFFilter()
Get the PDF Filter to be applied to the image.

Returns:
the PDF Filter or null

outputContents

public void outputContents(java.io.OutputStream out)
                    throws java.io.IOException
Writes the raw, unencoded contents of the image to a given output stream.

Parameters:
out - OutputStream to write to
Throws:
java.io.IOException - if there creating stream

populateXObjectDictionary

public void populateXObjectDictionary(PDFDictionary dict)
Populates the XObject's dictionary with additional values. The values are added to the dictionary after all the values obtained from other methods from this interface have been put into the dictionary. That allows to override certain values.

Specified by:
populateXObjectDictionary in interface PDFImage
Overrides:
populateXObjectDictionary in class AbstractImageAdapter

getFilterHint

public java.lang.String getFilterHint()
Returns a hint in form of a String (Possible values from PDFFilterList) indicating which filter setup should be used to encode the object.

Returns:
the filter setup hint

fop 1.0

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