Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.graphics.image.SampledImageReader

Modifier and Type	Field and Description
private static final Log	LOG

Access	Constructor and Description
private	SampledImageReader()

Method Summary

Modifier and Type	Method and Description
private static BufferedImage	applyColorKeyMask(BufferedImage image, BufferedImage mask)
private static Rectangle	clipRegion(PDImage pdImage, Rectangle region)
private static BufferedImage	from1Bit(PDImage pdImage, Rectangle clipped, final int subsampling, final int width, final int height)
private static BufferedImage	from8bit(PDImage pdImage, WritableRaster raster, Rectangle clipped, final int subsampling, final int width, final int height)
private static BufferedImage	fromAny(PDImage pdImage, WritableRaster raster, COSArray colorKey, Rectangle clipped, final int subsampling, final int width, final int height)
private static float[]	getDecodeArray(PDImage pdImage)
public static WritableRaster	Returns: the raw raster of this image getRawRaster(PDImage The image to get the raw raster data from pdImage) Extract the raw unconverted raster of the given image
public static BufferedImage	Returns: content of this image as an RGB buffered image getRGBImage(PDImage the image to read pdImage, COSArray an optional color key mask colorKey) Returns the content of the given image as an AWT buffered image with an RGB color space.
public static BufferedImage	Returns: content of this image as an (A)RGB buffered image getRGBImage(PDImage the image to read pdImage, Rectangle The region of the source image to get, or null if the entire image is needed. The actual region will be clipped to the dimensions of the source image. region, int The amount of rows and columns to advance for every output pixel, a value of 1 meaning every pixel will be read. It must not be larger than the image width or height. subsampling, COSArray an optional color key mask colorKey) Returns the content of the given image as an AWT buffered image with an RGB color space.
public static BufferedImage	Returns: a masked image filled with the given paint getStencilImage(PDImage pdImage, Paint the paint to fill the visible portions of the image with paint) Returns an ARGB image filled with the given paint and using the given image as a mask.
private static void	readRasterFromAny(PDImage pdImage, WritableRaster raster)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

LOG	back to summary
private static final Log LOG

SampledImageReader	back to summary
private SampledImageReader()

Method Detail

applyColorKeyMask	back to summary
private static BufferedImage applyColorKeyMask(BufferedImage image, BufferedImage mask)

clipRegion	back to summary
private static Rectangle clipRegion(PDImage pdImage, Rectangle region)

from1Bit	back to summary
private static BufferedImage from1Bit(PDImage pdImage, Rectangle clipped, final int subsampling, final int width, final int height) throws IOException

from8bit	back to summary
private static BufferedImage from8bit(PDImage pdImage, WritableRaster raster, Rectangle clipped, final int subsampling, final int width, final int height) throws IOException

fromAny	back to summary
private static BufferedImage fromAny(PDImage pdImage, WritableRaster raster, COSArray colorKey, Rectangle clipped, final int subsampling, final int width, final int height) throws IOException

getDecodeArray	back to summary
private static float[] getDecodeArray(PDImage pdImage) throws IOException

getRawRaster	back to summary
public static WritableRaster getRawRaster(PDImage pdImage) throws IOException Extract the raw unconverted raster of the given image Parameters pdImage:PDImage The image to get the raw raster data from Returns:WritableRaster the raw raster of this image

getRawRaster

back to summary

public static WritableRaster getRawRaster(PDImage pdImage) throws IOException

Extract the raw unconverted raster of the given image

Parameters

pdImage:PDImage: The image to get the raw raster data from

Returns:WritableRaster

the raw raster of this image

getRGBImage	back to summary
public static BufferedImage getRGBImage(PDImage pdImage, COSArray colorKey) throws IOException Returns the content of the given image as an AWT buffered image with an RGB color space. If a color key mask is provided then an ARGB image is returned instead. This method never returns null. Parameters pdImage:PDImage the image to read colorKey:COSArray an optional color key mask Returns:BufferedImage content of this image as an RGB buffered image Exceptions IOException: if the image cannot be read

getRGBImage

back to summary

public static BufferedImage getRGBImage(PDImage pdImage, COSArray colorKey) throws IOException

Returns the content of the given image as an AWT buffered image with an RGB color space. If a color key mask is provided then an ARGB image is returned instead. This method never returns null.

Parameters

pdImage:PDImage: the image to read
colorKey:COSArray: an optional color key mask

Returns:BufferedImage

content of this image as an RGB buffered image

Exceptions

IOException:: if the image cannot be read

getRGBImage	back to summary
public static BufferedImage getRGBImage(PDImage pdImage, Rectangle region, int subsampling, COSArray colorKey) throws IOException Returns the content of the given image as an AWT buffered image with an RGB color space. If a color key mask is provided then an ARGB image is returned instead. This method never returns null. Parameters pdImage:PDImage the image to read region:Rectangle The region of the source image to get, or null if the entire image is needed. The actual region will be clipped to the dimensions of the source image. subsampling:int The amount of rows and columns to advance for every output pixel, a value of 1 meaning every pixel will be read. It must not be larger than the image width or height. colorKey:COSArray an optional color key mask Returns:BufferedImage content of this image as an (A)RGB buffered image Exceptions IOException: if the image cannot be read

getRGBImage

back to summary

public static BufferedImage getRGBImage(PDImage pdImage, Rectangle region, int subsampling, COSArray colorKey) throws IOException

Returns the content of the given image as an AWT buffered image with an RGB color space. If a color key mask is provided then an ARGB image is returned instead. This method never returns null.

Parameters

pdImage:PDImage: the image to read
region:Rectangle: The region of the source image to get, or null if the entire image is needed. The actual region will be clipped to the dimensions of the source image.
subsampling:int: The amount of rows and columns to advance for every output pixel, a value of 1 meaning every pixel will be read. It must not be larger than the image width or height.
colorKey:COSArray: an optional color key mask

Returns:BufferedImage

content of this image as an (A)RGB buffered image

Exceptions

IOException:: if the image cannot be read

getStencilImage	back to summary
public static BufferedImage getStencilImage(PDImage pdImage, Paint paint) throws IOException Returns an ARGB image filled with the given paint and using the given image as a mask. Parameters paint:Paint the paint to fill the visible portions of the image with Returns:BufferedImage a masked image filled with the given paint Exceptions IOException: if the image cannot be read IllegalStateException: if the image is not a stencil.

getStencilImage

back to summary

public static BufferedImage getStencilImage(PDImage pdImage, Paint paint) throws IOException

Returns an ARGB image filled with the given paint and using the given image as a mask.

Parameters

paint:Paint: the paint to fill the visible portions of the image with

Returns:BufferedImage

a masked image filled with the given paint

Exceptions

IOException:: if the image cannot be read
IllegalStateException:: if the image is not a stencil.

readRasterFromAny	back to summary
private static void readRasterFromAny(PDImage pdImage, WritableRaster raster) throws IOException

pack-priv final Class SampledImageReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail