org.apache.pdfbox.pdmodel.graphics.pattern

Class PDAbstractPattern

java.lang.Object

org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern

All Implemented Interfaces:

COSObjectable, PDInheritableResource

Direct Known Subclasses:

PDShadingPattern, PDTilingPattern

public abstract class PDAbstractPattern
extends Object
implements COSObjectable, PDInheritableResource

A Pattern dictionary from a page's resources.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_SHADING_PATTERN Shading pattern type.
static int	TYPE_TILING_PATTERN Tiling pattern type.

Constructor Summary

Constructors

Constructor and Description
PDAbstractPattern() Creates a new Pattern dictionary.
PDAbstractPattern(COSDictionary resourceDictionary) Creates a new Pattern dictionary from the given COS dictionary.

Method Summary

Modifier and Type	Method and Description
static PDAbstractPattern	create(COSDictionary resourceDictionary) Create the correct PD Model pattern based on the COS base pattern.
COSDictionary	getCOSObject() This will get the underlying dictionary.
String	getFilter() Get the name of the filter.
int	getLength() This will return the length of the content stream.
Matrix	getMatrix() Returns the pattern matrix, or the identity matrix is none is available.
abstract int	getPatternType() This will return the pattern type.
String	getType() This will return the paint type.
boolean	isInherited()
void	setFilter(String filter) Sets the filter entry of the encryption dictionary.
void	setInherited(boolean inherited)
void	setLength(int length) This will set the length of the content stream.
void	setMatrix(AffineTransform transform) Sets the optional Matrix entry for the Pattern.
void	setPaintType(int paintType) This will set the paint type.
void	setPatternType(int patternType) This will set the pattern type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_TILING_PATTERN

public static final int TYPE_TILING_PATTERN

Tiling pattern type.

See Also:

Constant Field Values

TYPE_SHADING_PATTERN

public static final int TYPE_SHADING_PATTERN

Shading pattern type.

See Also:

Constant Field Values

Constructor Detail

PDAbstractPattern

public PDAbstractPattern()

Creates a new Pattern dictionary.

PDAbstractPattern

public PDAbstractPattern(COSDictionary resourceDictionary)

Creates a new Pattern dictionary from the given COS dictionary.

Parameters:

resourceDictionary - The COSDictionary for this pattern resource.

Method Detail

create

public static PDAbstractPattern create(COSDictionary resourceDictionary)
                                throws IOException

Create the correct PD Model pattern based on the COS base pattern.

Parameters:

resourceDictionary - the COS pattern dictionary

Returns:

the newly created pattern resources object

Throws:

IOException - If we are unable to create the PDPattern object.

getCOSObject

public COSDictionary getCOSObject()

This will get the underlying dictionary.

Specified by:

getCOSObject in interface COSObjectable

Returns:

The dictionary for these pattern resources.

isInherited

public boolean isInherited()

Specified by:

isInherited in interface PDInheritableResource

setFilter

public void setFilter(String filter)

Sets the filter entry of the encryption dictionary.

Parameters:

filter - The filter name.

getFilter

public String getFilter()

Get the name of the filter.

Returns:

The filter name contained in this encryption dictionary.

setLength

public void setLength(int length)

This will set the length of the content stream.

Parameters:

length - The new stream length.

getLength

public int getLength()

This will return the length of the content stream.

Returns:

The length of the content stream

setPaintType

public void setPaintType(int paintType)

This will set the paint type.

Parameters:

paintType - The new paint type.

getType

public String getType()

This will return the paint type.

Returns:

The type of object that this is.

setPatternType

public void setPatternType(int patternType)

This will set the pattern type.

Parameters:

patternType - The new pattern type.

getPatternType

public abstract int getPatternType()

This will return the pattern type.

Returns:

The pattern type

getMatrix

public Matrix getMatrix()

Returns the pattern matrix, or the identity matrix is none is available.

setMatrix

public void setMatrix(AffineTransform transform)

Sets the optional Matrix entry for the Pattern.

Parameters:

transform - the transformation matrix

setInherited

public void setInherited(boolean inherited)