Class PDICCBased
java.lang.Object
org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
- All Implemented Interfaces:
COSObjectable
This class represents a ICC profile color space.
- Version:
- $Revision: 1.6 $
- Author:
- Ben Litchfield
-
Field Summary
FieldsFields inherited from class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
array
-
Constructor Summary
ConstructorsConstructorDescriptionPDICCBased
(COSArray iccArray) Constructor.PDICCBased
(PDDocument doc) Default constructor, creates empty stream. -
Method Summary
Modifier and TypeMethodDescriptioncreateColorModel
(int bpc) Create a Java color model for this colorspace.protected ColorSpace
Create a Java colorspace for this colorspace.This will return a list of alternate color spaces(PDColorSpace) if the display application does not support this icc stream.Convert this standard java object to a COS object.This will get the metadata stream for this object.getName()
This will return the name of the color space.int
This will return the number of color components.Get the pd stream for this icc color space.getRangeForComponent
(int n) Returns the range for a certain component number.void
setAlternateColorSpaces
(List list) This will set the list of alternate color spaces.void
setMetadata
(COSStream metadata) This will set the metadata stream that is associated with this color space.void
setNumberOfComponents
(int n) This will set the number of color components.void
setRangeForComponent
(PDRange range, int n) This will set the a range for this color space.toString()
Methods inherited from class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
getJavaColorSpace
-
Field Details
-
NAME
The name of this color space.- See Also:
-
-
Constructor Details
-
PDICCBased
Default constructor, creates empty stream.- Parameters:
doc
- The document to store the icc data.
-
PDICCBased
Constructor.- Parameters:
iccArray
- The ICC stream object.
-
-
Method Details
-
getName
This will return the name of the color space.- Specified by:
getName
in classPDColorSpace
- Returns:
- The name of the color space.
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Overrides:
getCOSObject
in classPDColorSpace
- Returns:
- The cos object that matches this Java object.
-
getPDStream
Get the pd stream for this icc color space.- Returns:
- Get the stream for this icc based color space.
-
createColorSpace
Create a Java colorspace for this colorspace.- Specified by:
createColorSpace
in classPDColorSpace
- Returns:
- A color space that can be used for Java AWT operations.
- Throws:
IOException
- If there is an error creating the color space.
-
createColorModel
Create a Java color model for this colorspace.- Specified by:
createColorModel
in classPDColorSpace
- Parameters:
bpc
- The number of bits per component.- Returns:
- A color model that can be used for Java AWT operations.
- Throws:
IOException
- If there is an error creating the color model.
-
getNumberOfComponents
public int getNumberOfComponents()This will return the number of color components. As of PDF 1.4 this will be 1,3,4.- Specified by:
getNumberOfComponents
in classPDColorSpace
- Returns:
- The number of components in this color space.
-
setNumberOfComponents
public void setNumberOfComponents(int n) This will set the number of color components.- Parameters:
n
- The number of color components.
-
getAlternateColorSpaces
This will return a list of alternate color spaces(PDColorSpace) if the display application does not support this icc stream.- Returns:
- A list of alternate color spaces.
- Throws:
IOException
- If there is an error getting the alternate color spaces.
-
setAlternateColorSpaces
This will set the list of alternate color spaces. This should be a list of PDColorSpace objects.- Parameters:
list
- The list of colorspace objects.
-
getRangeForComponent
Returns the range for a certain component number. This will never return null. If it is not present then the range 0..1 will be returned.- Parameters:
n
- the component number to get the range for- Returns:
- the range for this component
-
setRangeForComponent
This will set the a range for this color space.- Parameters:
range
- The new range for the a component.n
- The component to set the range for.
-
getMetadata
This will get the metadata stream for this object. Null if there is no metadata stream.- Returns:
- The metadata stream, if it exists.
-
setMetadata
This will set the metadata stream that is associated with this color space.- Parameters:
metadata
- The new metadata stream.
-
toString
- Overrides:
toString
in classPDColorSpace
-