Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.graphics.color

public final Class PDDeviceNAttributes

extends Object
Class Inheritance
Imports
org.apache.pdfbox.cos.COSBase, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.COSDictionaryMap, java.io.IOException, java.util.HashMap, .Map, org.apache.commons.logging.Log, .LogFactory
Contains additional information about the components of colour space. Instead of using the alternate color space and tint transform, conforming readers may use custom blending algorithms, along with other information provided in the attributes dictionary.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private final COSDictionary
dictionary

private static final Log
LOG

Log instance.

Constructor Summary

AccessConstructor and Description
public
PDDeviceNAttributes()

Creates a new DeviceN colour space attributes dictionary.

public
PDDeviceNAttributes(COSDictionary
a dictionary that has all of the attributes
attributes)

Creates a new DeviceN colour space attributes dictionary from the given dictionary.

Method Summary

Modifier and TypeMethod and Description
public Map<String, PDSeparation>

Returns:

map of colorants to color spaces, never null.
getColorants()

Returns a map of colorants and their associated Separation color space.

public COSDictionary

Returns:

the dictionary that this object wraps
getCOSDictionary()

Returns the underlying COS dictionary.

public PDDeviceNProcess

Returns:

the DeviceN Process Dictionary, or null if it is missing.
getProcess()

Returns the DeviceN Process Dictionary, or null if it is missing.

public boolean

Returns:

true if this is an NChannel color space.
isNChannel()

Returns true if this is an NChannel (PDF 1.6) color space.

public void
setColorants(Map<String, PDColorSpace>
the map of colorants
colorants)

Sets the colorant map.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

dictionaryback to summary
private final COSDictionary dictionary
LOGback to summary
private static final Log LOG

Log instance.

Constructor Detail

PDDeviceNAttributesback to summary
public PDDeviceNAttributes()

Creates a new DeviceN colour space attributes dictionary.

PDDeviceNAttributesback to summary
public PDDeviceNAttributes(COSDictionary attributes)

Creates a new DeviceN colour space attributes dictionary from the given dictionary.

Parameters
attributes:COSDictionary

a dictionary that has all of the attributes

Method Detail

getColorantsback to summary
public Map<String, PDSeparation> getColorants() throws IOException

Returns a map of colorants and their associated Separation color space.

Returns:Map<String, PDSeparation>

map of colorants to color spaces, never null.

Exceptions
IOException:
If there is an error reading a color space
getCOSDictionaryback to summary
public COSDictionary getCOSDictionary()

Returns the underlying COS dictionary.

Returns:COSDictionary

the dictionary that this object wraps

getProcessback to summary
public PDDeviceNProcess getProcess()

Returns the DeviceN Process Dictionary, or null if it is missing.

Returns:PDDeviceNProcess

the DeviceN Process Dictionary, or null if it is missing.

isNChannelback to summary
public boolean isNChannel()

Returns true if this is an NChannel (PDF 1.6) color space.

Returns:boolean

true if this is an NChannel color space.

setColorantsback to summary
public void setColorants(Map<String, PDColorSpace> colorants)

Sets the colorant map.

Parameters
colorants:Map<String, PDColorSpace>

the map of colorants

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override