Class PDSeparation
java.lang.Object
org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
org.apache.pdfbox.pdmodel.graphics.color.PDSpecialColorSpace
org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
- All Implemented Interfaces:
COSObjectable
A Separation color space used to specify either additional colorants or for isolating the
control of individual colour components of a device colour space for a subtractive device.
When such a space is the current colour space, the current colour shall be a single-component
value, called a tint, that controls the given colorant or colour components only.
- Author:
- Ben Litchfield, John Hewson
-
Field Summary
Fields inherited from class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
array
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new Separation color space.PDSeparation
(COSArray separation) Creates a new Separation color space from a PDF color space array. -
Method Summary
Modifier and TypeMethodDescriptionReturns the colorant name.Returns the colorant name.float[]
getDefaultDecode
(int bitsPerComponent) Returns the default decode array for this color space.Returns the initial color value for this color space.getName()
Returns the name of the color space.int
Returns the number of components in this color spacevoid
setAlternateColorSpace
(PDColorSpace colorSpace) Sets the alternate color space.void
setColorantName
(String name) Sets the colorant name.void
setTintTransform
(PDFunction tint) Sets the tint transform function.protected void
tintTransform
(float[] samples, int[] alt) toRawImage
(WritableRaster raster) Returns the image in this colorspace or null.float[]
toRGB
(float[] value) Returns the RGB equivalent of the given color value.toRGBImage
(WritableRaster raster) Returns the (A)RGB equivalent of the given raster.toString()
Methods inherited from class org.apache.pdfbox.pdmodel.graphics.color.PDSpecialColorSpace
getCOSObject
Methods inherited from class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
create, create, create, toRawImage, toRGBImageAWT
-
Constructor Details
-
PDSeparation
public PDSeparation()Creates a new Separation color space. -
PDSeparation
Creates a new Separation color space from a PDF color space array.- Parameters:
separation
- an array containing all separation information.- Throws:
IOException
- if the color space or the function could not be created.
-
-
Method Details
-
getName
Description copied from class:PDColorSpace
Returns the name of the color space.- Specified by:
getName
in classPDColorSpace
- Returns:
- the name of the color space
-
getNumberOfComponents
public int getNumberOfComponents()Description copied from class:PDColorSpace
Returns the number of components in this color space- Specified by:
getNumberOfComponents
in classPDColorSpace
- Returns:
- the number of components in this color space
-
getDefaultDecode
public float[] getDefaultDecode(int bitsPerComponent) Description copied from class:PDColorSpace
Returns the default decode array for this color space.- Specified by:
getDefaultDecode
in classPDColorSpace
- Parameters:
bitsPerComponent
- the number of bits per component.- Returns:
- the default decode array
-
getInitialColor
Description copied from class:PDColorSpace
Returns the initial color value for this color space.- Specified by:
getInitialColor
in classPDColorSpace
- Returns:
- the initial color value for this color space
-
toRGB
Description copied from class:PDColorSpace
Returns the RGB equivalent of the given color value.- Specified by:
toRGB
in classPDColorSpace
- 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
Description copied from class:PDColorSpace
Returns the (A)RGB equivalent of the given raster.- Specified by:
toRGBImage
in classPDColorSpace
- Parameters:
raster
- the source raster- Returns:
- an (A)RGB buffered image
- Throws:
IOException
- if the color conversion fails
-
tintTransform
- Throws:
IOException
-
toRawImage
Description copied from class:PDColorSpace
Returns the image in this colorspace or null. No conversion is performed. For special colorspaces like PDSeparation the image is returned in the gray colorspace. For undefined colorspaces like DeviceCMYK/DeviceRGB and DeviceGray null is returned. You can always fallback toPDColorSpace.toRGBImage(WritableRaster)
if this returns null.- Specified by:
toRawImage
in classPDColorSpace
- Parameters:
raster
- the source raster- Returns:
- an buffered image in this colorspace. Or null if it is not possible to extract that image with the original colorspace without conversion.
-
getAlternateColorSpace
Returns the colorant name.- Returns:
- the name of the colorant
-
getColorantName
Returns the colorant name.- Returns:
- the name of the colorant
-
setColorantName
Sets the colorant name.- Parameters:
name
- the name of the colorant
-
setAlternateColorSpace
Sets the alternate color space.- Parameters:
colorSpace
- The alternate color space.
-
setTintTransform
Sets the tint transform function.- Parameters:
tint
- the tint transform function
-
toString
-