Class PDIndexed
java.lang.Object
org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
- All Implemented Interfaces:
COSObjectable
This class represents an Indexed color space.
- Author:
- Ben Litchfield
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The abbreviated name of this color space.static final String
The name of this color space.Fields inherited from class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
array
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfloat[]
calculateColorValues
(int index) Returns the components of the color for the given index.createColorModel
(int bpc) Create a Java color model for this colorspace.createColorModel
(int bpc, int mask) Create a Java color model for this colorspace including the given mask value.protected ColorSpace
Create a Java colorspace for this colorspace.This will get the color space that acts as the index for this color space.Convert this standard java object to a COS object.int
Get the highest value for the lookup.byte[]
Get the lookup data table.getName()
This will return the name of the color space.int
This will return the number of color components.int
lookupColor
(int lookupIndex, int componentNumber) This will perform a lookup into the color lookup table.void
This will set the base color space.void
setHighValue
(int high) This will set the highest value that is allowed.void
setLookupColor
(int lookupIndex, int componentNumber, int color) This will set a color in the color lookup table.Methods inherited from class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
getJavaColorSpace, toString
-
Field Details
-
NAME
The name of this color space.- See Also:
-
ABBREVIATED_NAME
The abbreviated name of this color space.- See Also:
-
-
Constructor Details
-
PDIndexed
public PDIndexed()Constructor, default DeviceRGB, hival 255. -
PDIndexed
Constructor.- Parameters:
indexedArray
- The array containing the indexed parameters
-
-
Method Details
-
getCOSObject
Description copied from class:PDColorSpace
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.
-
getNumberOfComponents
This will return the number of color components. This will return the number of color components in the base color.- Specified by:
getNumberOfComponents
in classPDColorSpace
- Returns:
- The number of components in this color space.
- Throws:
IOException
- If there is an error getting the number of color components.
-
getName
This will return the name of the color space.- Specified by:
getName
in classPDColorSpace
- Returns:
- The name of the 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.
-
createColorModel
Create a Java color model for this colorspace including the given mask value.- Parameters:
bpc
- The number of bits per component of the indexed color model.mask
- the mask value, -1 indicates no mask- Returns:
- A color model that can be used for Java AWT operations.
- Throws:
IOException
- If there is an error creating the color model.
-
getBaseColorSpace
This will get the color space that acts as the index for this color space.- Returns:
- The base color space.
- Throws:
IOException
- If there is error creating the base color space.
-
setBaseColorSpace
This will set the base color space.- Parameters:
base
- The base color space to use as the index.
-
getHighValue
public int getHighValue()Get the highest value for the lookup.- Returns:
- The hival entry.
-
setHighValue
public void setHighValue(int high) This will set the highest value that is allowed. This cannot be higher than 255.- Parameters:
high
- The highest value for the lookup table.
-
lookupColor
This will perform a lookup into the color lookup table.- Parameters:
lookupIndex
- The zero-based index into the table, should not exceed the high value.componentNumber
- The component number, probably 1,2,3,3.- Returns:
- The value that was from the lookup table.
- Throws:
IOException
- If there is an error looking up the color.
-
getLookupData
Get the lookup data table.- Returns:
- a byte array containing the lookup data.
- Throws:
IOException
- if an error occurs.
-
setLookupColor
This will set a color in the color lookup table.- Parameters:
lookupIndex
- The zero-based index into the table, should not exceed the high value.componentNumber
- The component number, probably 1,2,3,3.color
- The color that will go into the table.- Throws:
IOException
- If there is an error looking up the color.
-
calculateColorValues
Returns the components of the color for the given index.- Parameters:
index
- the index of the color value- Returns:
- COSArray with the color components
- Throws:
IOException
- If the tint function is not supported
-