Class PDColorState
java.lang.Object
org.apache.pdfbox.pdmodel.graphics.color.PDColorState
- All Implemented Interfaces:
Cloneable
This class represents a color space and the color value for that colorspace.
- Author:
- Ben Litchfield
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.PDColorState
(COSArray csValues) Constructor with an existing color set. -
Method Summary
Modifier and TypeMethodDescriptionclone()
This will get the current colorspace.float[]
This will get the color space values.This will get the color space values.Returns the Java AWT color based on the current color space and value.getPaint
(int pageHeight) Returns the Java AWT paint based on the current pattern.This will get the current pattern.void
setColorSpace
(PDColorSpace value) This will set the current colorspace.void
setColorSpaceValue
(float[] value) This will update the colorspace values.static void
setIccOverrideColor
(Color color) Sets the default color to replace all colors inICC color spaces
.void
setPattern
(PDPatternResources patternValue) This will update the current pattern.
-
Constructor Details
-
PDColorState
public PDColorState()Default constructor. -
PDColorState
Constructor with an existing color set. Default colorspace is PDDeviceGray.- Parameters:
csValues
- The color space values.
-
-
Method Details
-
setIccOverrideColor
Sets the default color to replace all colors inICC color spaces
. This will work around a potential JVM crash caused by broken native ICC color manipulation code in the Sun class libraries.The default override can be specified by setting the color code in
org.apache.pdfbox.ICC_override_color
system property (seeColor.getColor(String)
. If this system property is not specified, then the override is not enabled unless this method is explicitly called.- Parameters:
color
- ICC override color, ornull
to disable the override- Since:
- Apache PDFBox 0.8.1
- See Also:
-
clone
-
getJavaColor
Returns the Java AWT color based on the current color space and value.- Returns:
- current Java AWT color
- Throws:
IOException
- if the current color can not be created
-
getPaint
Returns the Java AWT paint based on the current pattern.- Parameters:
pageHeight
- the height of the current page- Returns:
- current Java AWT paint
- Throws:
IOException
- if the current color can not be created
-
getColorSpace
This will get the current colorspace.- Returns:
- The current colorspace.
-
setColorSpace
This will set the current colorspace.- Parameters:
value
- The new colorspace.
-
getColorSpaceValue
public float[] getColorSpaceValue()This will get the color space values. Either 1 for gray or 3 for RGB.- Returns:
- The colorspace values.
-
getCOSColorSpaceValue
This will get the color space values. Either 1 for gray or 3 for RGB.- Returns:
- The colorspace values.
-
setColorSpaceValue
public void setColorSpaceValue(float[] value) This will update the colorspace values.- Parameters:
value
- The new colorspace values.
-
getPattern
This will get the current pattern.- Returns:
- The current pattern.
-
setPattern
This will update the current pattern.- Parameters:
patternValue
- The new pattern.
-