org.pdfbox.pdmodel.graphics.color

Class PDCalGray

Implemented Interfaces:
COSObjectable

public class PDCalGray
extends PDColorSpace

This class represents a Cal Gray color space.
Version:
$Revision: 1.5 $
Author:
Ben Litchfield

Field Summary

static String
NAME
The name of this color space.

Constructor Summary

PDCalGray()
Constructor.
PDCalGray(COSArray gray)
Constructor with array.

Method Summary

ColorModel
createColorModel(int bpc)
Create a Java color model for this colorspace.
ColorSpace
createColorSpace()
Create a Java colorspace for this colorspace.
PDTristimulus
getBlackPoint()
This will return the BlackPoint tristimulus.
COSBase
getCOSObject()
Convert this standard java object to a COS object.
float
getGamma()
This will get the gamma value.
String
getName()
This will return the name of the color space.
int
getNumberOfComponents()
This will get the number of components that this color space is made up of.
PDTristimulus
getWhitepoint()
This will return the whitepoint tristimulus.
void
setBlackPoint(PDTristimulus bp)
This will set the BlackPoint tristimulus.
void
setGamma(float value)
Set the gamma value.
void
setWhitepoint(PDTristimulus wp)
This will set the whitepoint tristimulus.

Methods inherited from class org.pdfbox.pdmodel.graphics.color.PDColorSpace

createColorModel, createColorSpace, getCOSObject, getName, getNumberOfComponents

Field Details

NAME

public static final String NAME
The name of this color space.

Constructor Details

PDCalGray

public PDCalGray()
Constructor.

PDCalGray

public PDCalGray(COSArray gray)
Constructor with array.
Parameters:
gray - The underlying color space.

Method Details

createColorModel

public ColorModel createColorModel(int bpc)
            throws IOException
Create a Java color model for this colorspace.
Overrides:
createColorModel in interface PDColorSpace
Parameters:
bpc - The number of bits per component.
Returns:
A color model that can be used for Java AWT operations.

createColorSpace

public ColorSpace createColorSpace()
            throws IOException
Create a Java colorspace for this colorspace.
Overrides:
createColorSpace in interface PDColorSpace
Returns:
A color space that can be used for Java AWT operations.

getBlackPoint

public PDTristimulus getBlackPoint()
This will return the BlackPoint tristimulus. This is an optional field but has defaults so this will never return null. A default of 0,0,0 will be returned if the pdf does not have any values yet.
Returns:
The blackpoint tristimulus.

getCOSObject

public COSBase getCOSObject()
Convert this standard java object to a COS object.
Specified by:
getCOSObject in interface COSObjectable
Overrides:
getCOSObject in interface PDColorSpace
Returns:
The cos object that matches this Java object.

getGamma

public float getGamma()
This will get the gamma value. If none is present then the default of 1 will be returned.
Returns:
The gamma value.

getName

public String getName()
This will return the name of the color space.
Overrides:
getName in interface PDColorSpace
Returns:
The name of the color space.

getNumberOfComponents

public int getNumberOfComponents()
            throws IOException
This will get the number of components that this color space is made up of.
Overrides:
getNumberOfComponents in interface PDColorSpace
Returns:
The number of components in this color space.

getWhitepoint

public PDTristimulus getWhitepoint()
This will return the whitepoint tristimulus. As this is a required field this will never return null. A default of 1,1,1 will be returned if the pdf does not have any values yet.
Returns:
The whitepoint tristimulus.

setBlackPoint

public void setBlackPoint(PDTristimulus bp)
This will set the BlackPoint tristimulus. As this is a required field this null should not be passed into this function.
Parameters:
bp - The BlackPoint tristimulus.

setGamma

public void setGamma(float value)
Set the gamma value.
Parameters:
value - The new gamma value.

setWhitepoint

public void setWhitepoint(PDTristimulus wp)
This will set the whitepoint tristimulus. As this is a required field this null should not be passed into this function.
Parameters:
wp - The whitepoint tristimulus.