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

public final Class PDPattern

extends PDSpecialColorSpace
Class Inheritance
Imports
java.awt.image.BufferedImage, .WritableRaster, java.io.IOException, org.apache.pdfbox.cos.COSArray, .COSName, org.apache.pdfbox.pdmodel.PDResources, org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern
A Pattern color space is either a Tiling pattern or a Shading pattern.
Authors
John Hewson, Ben Litchfield

Field Summary

Modifier and TypeField and Description
private static final PDColor
EMPTY_PATTERN

A pattern which leaves no marks on the page.

private final PDResources
resources

private PDColorSpace
underlyingColorSpace

Constructor Summary

AccessConstructor and Description
public
PDPattern(PDResources
The current resources.
resources)

Creates a new pattern color space.

public
PDPattern(PDResources
The current resources.
resources, PDColorSpace
The underlying color space.
colorSpace)

Creates a new uncolored tiling pattern color space.

Method Summary

Modifier and TypeMethod and Description
public float[]
getDefaultDecode(int
the number of bits per component.
bitsPerComponent)

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getDefaultDecode.

Returns the default decode array for this color space.

public PDColor
getInitialColor()

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getInitialColor.

Returns the initial color value for this color space.

public String
getName()

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getName.

Returns the name of the color space.

public int
getNumberOfComponents()

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getNumberOfComponents.

Returns the number of components in this color space

public PDAbstractPattern

Returns:

pattern for the given color
getPattern(PDColor
color containing a pattern name
color)

Returns the pattern for the given color.

public PDColorSpace

Returns:

the underlying color space or null
getUnderlyingColorSpace()

Returns the underlying color space, if this is an uncolored tiling pattern, otherwise null.

public BufferedImage
toRawImage(WritableRaster
the source raster
raster)

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.toRawImage.

Returns the image in this colorspace or null.

public float[]
toRGB(float[]
a color value with component values between 0 and 1
value)

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.toRGB.

Returns the RGB equivalent of the given color value.

public BufferedImage
toRGBImage(WritableRaster
the source raster
raster)

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.toRGBImage.

Returns the (A)RGB equivalent of the given raster.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Field Detail

EMPTY_PATTERNback to summary
private static final PDColor EMPTY_PATTERN

A pattern which leaves no marks on the page.

resourcesback to summary
private final PDResources resources
underlyingColorSpaceback to summary
private PDColorSpace underlyingColorSpace

Constructor Detail

PDPatternback to summary
public PDPattern(PDResources resources)

Creates a new pattern color space.

Parameters
resources:PDResources

The current resources.

PDPatternback to summary
public PDPattern(PDResources resources, PDColorSpace colorSpace)

Creates a new uncolored tiling pattern color space.

Parameters
resources:PDResources

The current resources.

colorSpace:PDColorSpace

The underlying color space.

Method Detail

getDefaultDecodeback to summary
public float[] getDefaultDecode(int bitsPerComponent)

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getDefaultDecode.

Doc from org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getDefaultDecode.

Returns the default decode array for this color space.

Parameters
bitsPerComponent:int

the number of bits per component.

Returns:float[]

the default decode array

Annotations
@Override
getInitialColorback to summary
public PDColor getInitialColor()

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getInitialColor.

Doc from org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getInitialColor.

Returns the initial color value for this color space.

Returns:PDColor

the initial color value for this color space

Annotations
@Override
getNameback to summary
public String getName()

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getName.

Doc from org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getName.

Returns the name of the color space.

Returns:String

the name of the color space

Annotations
@Override
getNumberOfComponentsback to summary
public int getNumberOfComponents()

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getNumberOfComponents.

Doc from org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.getNumberOfComponents.

Returns the number of components in this color space

Returns:int

the number of components in this color space

Annotations
@Override
getPatternback to summary
public PDAbstractPattern getPattern(PDColor color) throws IOException

Returns the pattern for the given color.

Parameters
color:PDColor

color containing a pattern name

Returns:PDAbstractPattern

pattern for the given color

Exceptions
IOException:
if the pattern name was not found.
getUnderlyingColorSpaceback to summary
public PDColorSpace getUnderlyingColorSpace()

Returns the underlying color space, if this is an uncolored tiling pattern, otherwise null.

Returns:PDColorSpace

the underlying color space or null

toRawImageback to summary
public BufferedImage toRawImage(WritableRaster raster) throws IOException

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.toRawImage.

Doc from org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.toRawImage.

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 to toRGBImage(WritableRaster) if this returns null.

Parameters
raster:WritableRaster

the source raster

Returns:BufferedImage

an buffered image in this colorspace. Or null if it is not possible to extract that image with the original colorspace without conversion.

Annotations
@Override
Exceptions
IOException:
if the image conversion fails
toRGBback to summary
public float[] toRGB(float[] value)

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.toRGB.

Doc from org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.toRGB.

Returns the RGB equivalent of the given color value.

Parameters
value:float[]

a color value with component values between 0 and 1

Returns:float[]

an array of R,G,B value between 0 and 255

Annotations
@Override
toRGBImageback to summary
public BufferedImage toRGBImage(WritableRaster raster) throws IOException

Implements abstract org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.toRGBImage.

Doc from org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace.toRGBImage.

Returns the (A)RGB equivalent of the given raster.

Parameters
raster:WritableRaster

the source raster

Returns:BufferedImage

an (A)RGB buffered image

Annotations
@Override
Exceptions
IOException:
if the color conversion fails
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