org.pdfbox.util

Class ImageParameters


public class ImageParameters
extends java.lang.Object

This contains all of the image parameters for in inlined image.
Version:
$Revision: 1.4 $
Author:
Ben Litchfield

Constructor Summary

ImageParameters()
Constructor.
ImageParameters(COSDictionary params)
Constructor.

Method Summary

int
getBitsPerComponent()
The bits per component of this image.
PDColorSpace
getColorSpace()
This will get the color space or null if none exists.
COSDictionary
getDictionary()
This will get the dictionary that stores the image parameters.
List
getFilters()
This will get the list of filters that are associated with this stream.
int
getHeight()
The height of this image.
int
getWidth()
The width of this image.
void
setBitsPerComponent(int bpc)
Set the number of bits per component.
void
setColorSpace(PDColorSpace cs)
This will set the color space for this image.
void
setFilters(List filters)
This will set the filters that are part of this stream.
void
setHeight(int h)
Set the height of the image.
void
setWidth(int w)
Set the width of the image.

Constructor Details

ImageParameters

public ImageParameters()
Constructor.

ImageParameters

public ImageParameters(COSDictionary params)
Constructor.
Parameters:
params - The image parameters.

Method Details

getBitsPerComponent

public int getBitsPerComponent()
The bits per component of this image. This will return -1 if one has not been set.
Returns:
The number of bits per component.

getColorSpace

public PDColorSpace getColorSpace()
            throws IOException
This will get the color space or null if none exists.
Returns:
The color space for this image.

getDictionary

public COSDictionary getDictionary()
This will get the dictionary that stores the image parameters.
Returns:
The COS dictionary that stores the image parameters.

getFilters

public List getFilters()
This will get the list of filters that are associated with this stream. Or null if there are none.
Returns:
A list of all encoding filters to apply to this stream.

getHeight

public int getHeight()
The height of this image. This will return -1 if one has not been set.
Returns:
The height.

getWidth

public int getWidth()
The width of this image. This will return -1 if one has not been set.
Returns:
The width.

setBitsPerComponent

public void setBitsPerComponent(int bpc)
Set the number of bits per component.
Parameters:
bpc - The number of bits per component.

setColorSpace

public void setColorSpace(PDColorSpace cs)
This will set the color space for this image.
Parameters:
cs - The color space for this image.

setFilters

public void setFilters(List filters)
This will set the filters that are part of this stream.
Parameters:
filters - The filters that are part of this stream.

setHeight

public void setHeight(int h)
Set the height of the image.
Parameters:
h - The height of the image.

setWidth

public void setWidth(int w)
Set the width of the image.
Parameters:
w - The width of the image.