Package com.tom_roush.pdfbox.pdmodel.graphics.color

Class PDColorSpace

java.lang.Object

com.tom_roush.pdfbox.pdmodel.graphics.color.PDColorSpace

All Implemented Interfaces:

COSObjectable

Direct Known Subclasses:

PDDeviceColorSpace, PDJPXColorSpace

public abstract class PDColorSpace
extends Object
implements COSObjectable

A color space specifies how the colours of graphics objects will be painted on the page.

Field Summary

Fields

Modifier and Type	Field	Description
protected COSArray	array

Constructor Summary

Constructors

Constructor	Description
PDColorSpace()

Method Summary

Modifier and Type	Method	Description
static PDColorSpace	create(COSBase colorSpace)	Creates a color space given a name or array.
static PDColorSpace	create(COSBase colorSpace, PDResources resources)	Creates a color space given a name or array.
static PDColorSpace	create(COSBase colorSpace, PDResources resources, boolean wasDefault)	Creates a color space given a name or array.
COSBase	getCOSObject()	Convert this standard java object to a COS object.
abstract float[]	getDefaultDecode(int bitsPerComponent)	Returns the default decode array for this color space.
abstract PDColor	getInitialColor()	Returns the initial color value for this color space.
abstract String	getName()	Returns the name of the color space.
abstract int	getNumberOfComponents()	Returns the number of components in this color space
abstract float[]	toRGB(float[] value)	Returns the RGB equivalent of the given color value.
abstract Bitmap	toRGBImage(Bitmap raster)	Returns the (A)RGB equivalent of the given raster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

array

protected COSArray array

Constructor Detail

PDColorSpace

public PDColorSpace()

Method Detail

create

public static PDColorSpace create(COSBase colorSpace)
                           throws IOException

Creates a color space given a name or array.

Parameters:

colorSpace - the color space COS object

Returns:

a new color space

Throws:

IOException - if the color space is unknown or cannot be created

create

public static PDColorSpace create(COSBase colorSpace,
                                  PDResources resources)
                           throws IOException

Creates a color space given a name or array. Abbreviated device color names are not supported here, please replace them first.

Parameters:

colorSpace - the color space COS object

resources - the current resources.

Returns:

a new color space

Throws:

MissingResourceException - if the color space is missing in the resources dictionary

IOException - if the color space is unknown or cannot be created

create

public static PDColorSpace create(COSBase colorSpace,
                                  PDResources resources,
                                  boolean wasDefault)
                           throws IOException

Creates a color space given a name or array. Abbreviated device color names are not supported here, please replace them first. This method is for PDFBox internal use only, others should use create(COSBase, PDResources).

Parameters:

colorSpace - the color space COS object

resources - the current resources.

wasDefault - if current color space was used by a default color space.

Returns:

a new color space.

Throws:

MissingResourceException - if the color space is missing in the resources dictionary

IOException - if the color space is unknown or cannot be created.

getName

public abstract String getName()

Returns the name of the color space.

Returns:

the name of the color space

getNumberOfComponents

public abstract int getNumberOfComponents()

Returns the number of components in this color space

Returns:

the number of components in this color space

getDefaultDecode

public abstract float[] getDefaultDecode(int bitsPerComponent)

Returns the default decode array for this color space.

Parameters:

bitsPerComponent - the number of bits per component.

Returns:

the default decode array

getInitialColor

public abstract PDColor getInitialColor()

Returns the initial color value for this color space.

Returns:

the initial color value for this color space

toRGB

public abstract float[] toRGB(float[] value)
                       throws IOException

Returns the RGB equivalent of the given color value.

Parameters:

value - a color value with component values between 0 and 1

Returns:

an array of R,G,B value between 0 and 255

Throws:

IOException - if the color conversion fails

toRGBImage

public abstract Bitmap toRGBImage(Bitmap raster)
                           throws IOException

Returns the (A)RGB equivalent of the given raster.

Parameters:

raster - the source raster

Returns:

an (A)RGB buffered image

Throws:

IOException - if the color conversion fails

getCOSObject

public COSBase getCOSObject()

Description copied from interface: COSObjectable

Convert this standard java object to a COS object.

Specified by:

getCOSObject in interface COSObjectable

Returns:

The cos object that matches this Java object.