org.pdfbox.pdmodel.graphics.xobject

Class PDPixelMap

Implemented Interfaces:
COSObjectable

public class PDPixelMap
extends PDXObjectImage

This class contains a PixelMap Image.
Version:
$Revision: 1.8 $
Authors:
Ben Litchfield
mathiak

Field Summary

Fields inherited from class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage

SUB_TYPE

Constructor Summary

PDPixelMap(PDStream pdStream)
Standard constructor.

Method Summary

COSDictionary
getDecodeParams()
DecodeParms is an optional parameter for filters.
int
getPredictor()
A code that selects the predictor algorithm.
BufferedImage
getRGBImage()
Returns a java.awt.image.BufferedImage of the COSStream set in the constructor or null if the COSStream could not be encoded.
void
write2OutputStream(OutputStream out)
Writes the image as .png.

Methods inherited from class org.pdfbox.pdmodel.graphics.xobject.PDXObjectImage

getBitsPerComponent, getColorSpace, getHeight, getRGBImage, getSuffix, getWidth, setBitsPerComponent, setColorSpace, setHeight, setWidth, write2OutputStream, write2file

Methods inherited from class org.pdfbox.pdmodel.graphics.xobject.PDXObject

createXObject, getCOSObject, getCOSStream, getMetadata, getPDStream, setMetadata

Constructor Details

PDPixelMap

public PDPixelMap(PDStream pdStream)
Standard constructor. Basically does nothing.
Parameters:
pdStream - The stream that holds the pixel map.

Method Details

getDecodeParams

public COSDictionary getDecodeParams()
DecodeParms is an optional parameter for filters. It is provided if any of the filters has nondefault parameters. If there is only one filter it is a dictionary, if there are multiple filters it is an array with an entry for each filter. An array entry can hold a null value if only the default values are used or a dictionary with parameters.
Returns:
The decoding parameters.

getPredictor

public int getPredictor()
A code that selects the predictor algorithm.
  • 1 No prediction (the default value)
  • 2 TIFF Predictor 2
  • 10 PNG prediction (on encoding, PNG None on all rows)
  • 11 PNG prediction (on encoding, PNG Sub on all rows)
  • 12 PNG prediction (on encoding, PNG Up on all rows)
  • 13 PNG prediction (on encoding, PNG Average on all rows)
  • 14 PNG prediction (on encoding, PNG Paeth on all rows)
  • 15 PNG prediction (on encoding, PNG optimum)
Default value: 1.
Returns:
predictor algorithm code

getRGBImage

public BufferedImage getRGBImage()
            throws IOException
Returns a java.awt.image.BufferedImage of the COSStream set in the constructor or null if the COSStream could not be encoded.
Overrides:
getRGBImage in interface PDXObjectImage
Returns:

write2OutputStream

public void write2OutputStream(OutputStream out)
            throws IOException
Writes the image as .png.
Overrides:
write2OutputStream in interface PDXObjectImage