org.pdfbox.pdmodel.graphics.color

Class PDDeviceN

Implemented Interfaces:
COSObjectable

public class PDDeviceN
extends PDColorSpace

This class represents a DeviceN color space.
Version:
$Revision: 1.3 $
Author:
Ben Litchfield

Field Summary

static String
NAME
The name of this color space.

Constructor Summary

PDDeviceN()
Constructor.
PDDeviceN(COSArray separation)
Constructor.

Method Summary

ColorModel
createColorModel(int bpc)
Create a Java color model for this colorspace.
ColorSpace
createColorSpace()
Create a Java colorspace for this colorspace.
PDColorSpace
getAlternateColorSpace()
This will get the alternate color space for this separation.
PDDeviceNAttributes
getAttributes()
This will get the attributes that are associated with the deviceN color space.
List
getColorantNames()
This will get the colorant names.
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.
COSBase
getTintTransform()
This will get the tint transform function.
void
setAlternateColorSpace(PDColorSpace cs)
This will set the alternate color space.
void
setAttributes(PDDeviceNAttributes attributes)
This will set the color space attributes.
void
setColorantNames(List names)
This will set the list of colorants.
void
setTintTransform(COSBase tint)
This will set the tint transform function.

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

PDDeviceN

public PDDeviceN()
Constructor.

PDDeviceN

public PDDeviceN(COSArray separation)
Constructor.
Parameters:
separation - The array containing all separation information.

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.

getAlternateColorSpace

public PDColorSpace getAlternateColorSpace()
            throws IOException
This will get the alternate color space for this separation.
Returns:
The alternate color space.

getAttributes

public PDDeviceNAttributes getAttributes()
This will get the attributes that are associated with the deviceN color space.
Returns:
The DeviceN attributes.

getColorantNames

public List getColorantNames()
This will get the colorant names. A list of string objects.
Returns:
A list of colorants

getName

public String getName()
This will return the name of the color space. For a PDSeparation object this will always return "Separation"
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.

getTintTransform

public COSBase getTintTransform()
This will get the tint transform function. At this time the PDModel does not support functions so we will just return the COSBase object. This method will change in the future to be a PDModel object.
Returns:
The tint transform function.

setAlternateColorSpace

public void setAlternateColorSpace(PDColorSpace cs)
This will set the alternate color space.
Parameters:
cs - The alternate color space.

setAttributes

public void setAttributes(PDDeviceNAttributes attributes)
This will set the color space attributes. If null is passed in then all attribute will be removed.
Parameters:
attributes - The color space attributes.

setColorantNames

public void setColorantNames(List names)
This will set the list of colorants.
Parameters:
names - The list of colorant names.

setTintTransform

public void setTintTransform(COSBase tint)
This will set the tint transform function. At this time the PDModel does not support functions so we will just return the COSBase object. This method will change in the future to be a PDModel object.
Parameters:
tint - The tint transform function.