org.apache.fop.pdf
Class PDFPattern
- PDFWritable
class representing a PDF Function.
PDF Functions represent parameterized mathematical formulas and sampled representations with
arbitrary resolution. Functions are used in two areas: device-dependent
rasterization information for halftoning and transfer
functions, and color specification for smooth shading (a PDF 1.3 feature).
All PDF Functions have a FunctionType (0,2,3, or 4), a Domain, and a Range.
protected List | bBox - List of Doubles representing the Bounding box rectangle
|
protected StringBuffer | extGState - TODO use PDFGState
String representing the extended Graphics state.
|
protected List | matrix - List of Doubles representing the Transformation matrix.
|
protected int | paintType - 1 for colored pattern, 2 for uncolored
|
protected StringBuffer | patternDataStream - The stream of a pattern
|
protected String | patternName - The name of the pattern such as "Pa1" or "Pattern1"
|
protected int | patternType - Either one (1) for tiling, or two (2) for shading.
|
protected PDFResources | resources - The resources associated with this pattern
|
protected PDFShading | shading - The Shading object comprising the Type 2 pattern
|
protected int | tilingType - 1 for constant spacing, 2 for no distortion, and 3 for fast rendering
|
protected double | xStep - Horizontal spacing
|
protected List | xUID - List of Integers represetning the Extended unique Identifier
|
protected double | yStep - Vertical spacing
|
PDFPattern(int thePatternType, PDFShading theShading, List theXUID, StringBuffer theExtGState, List theMatrix) - Create a type 2 pattern (smooth shading)
|
PDFPattern(PDFResources theResources, int thePatternType, int thePaintType, int theTilingType, List theBBox, double theXStep, double theYStep, List theMatrix, List theXUID, StringBuffer thePatternDataStream) - Create a tiling pattern (type 1).
|
boolean | equals(Object obj) - Check if this pattern is equal to another.
|
String | getColorSpaceOut(boolean fillNotStroke) - Get the PDF command for setting to this pattern.
|
String | getName() - Get the name of the pattern
|
protected int | output(OutputStream stream) - represent as PDF.
|
void | setName(String name) - Sets the name of the pattern.
|
byte[] | toPDF() - Output PDF bytes, not used.
|
encode , encodeBinaryToHexString , encodeString , encodeText , formatDateTime , formatDateTime , formatObject , getDocument , getDocumentSafely , getGeneration , getObjectID , getObjectNumber , getParent , hasObjectNumber , makeReference , output , outputInline , referencePDF , setDocument , setObjectNumber , setParent , toPDF , toPDFString |
bBox
protected List bBox
List of Doubles representing the Bounding box rectangle
extGState
protected StringBuffer extGState
TODO use PDFGState
String representing the extended Graphics state.
Probably will never be used like this.
matrix
protected List matrix
List of Doubles representing the Transformation matrix.
paintType
protected int paintType
1 for colored pattern, 2 for uncolored
patternDataStream
protected StringBuffer patternDataStream
The stream of a pattern
patternName
protected String patternName
The name of the pattern such as "Pa1" or "Pattern1"
patternType
protected int patternType
Either one (1) for tiling, or two (2) for shading.
resources
protected PDFResources resources
The resources associated with this pattern
shading
protected PDFShading shading
The Shading object comprising the Type 2 pattern
tilingType
protected int tilingType
1 for constant spacing, 2 for no distortion, and 3 for fast rendering
xStep
protected double xStep
Horizontal spacing
xUID
protected List xUID
List of Integers represetning the Extended unique Identifier
yStep
protected double yStep
Vertical spacing
PDFPattern
public PDFPattern(int thePatternType,
PDFShading theShading,
List theXUID,
StringBuffer theExtGState,
List theMatrix)
Create a type 2 pattern (smooth shading)
thePatternType
- the type of the pattern, which is 2, smooth shadingtheShading
- the PDF Shading object that comprises this patterntheXUID
- optional:the extended unique Identifier if used.theExtGState
- optional: the extended graphics state, if used.theMatrix
- Optional:List of Doubles that specify the matrix.
PDFPattern
public PDFPattern(PDFResources theResources,
int thePatternType,
int thePaintType,
int theTilingType,
List theBBox,
double theXStep,
double theYStep,
List theMatrix,
List theXUID,
StringBuffer thePatternDataStream)
Create a tiling pattern (type 1).
theResources
- the resources associated with this patternthePatternType
- the type of pattern, which is 1 for tiling.thePaintType
- 1 or 2, colored or uncolored.theTilingType
- 1, 2, or 3, constant spacing, no distortion, or faster tilingtheBBox
- List of Doubles: The pattern cell bounding boxtheXStep
- horizontal spacingtheYStep
- vertical spacingtheMatrix
- Optional List of Doubles transformation matrixtheXUID
- Optional vector of Integers that uniquely identify the patternthePatternDataStream
- The stream of pattern data to be tiled.
equals
public boolean equals(Object obj)
Check if this pattern is equal to another.
obj
- the object to compare against
- true if the patterns are equal
getColorSpaceOut
public String getColorSpaceOut(boolean fillNotStroke)
Get the PDF command for setting to this pattern.
- getColorSpaceOut in interface PDFPathPaint
fillNotStroke
- if true fill otherwise stroke
- the PDF string for setting the pattern
getName
public String getName()
Get the name of the pattern
- String representing the name of the pattern.
output
protected int output(OutputStream stream)
throws IOException
represent as PDF. Whatever the FunctionType is, the correct
representation spits out. The sets of required and optional
attributes are different for each type, but if a required
attribute's object was constructed as null, then no error
is raised. Instead, the malformed PDF that was requested
by the construction is dutifully output.
This policy should be reviewed.
- output in interface PDFObject
stream
- the stream to write to
setName
public void setName(String name)
Sets the name of the pattern.
name
- the name of the pattern. Can be anything
without spaces. "Pattern1" or "Pa1" are good examples.
toPDF
public byte[] toPDF()
Output PDF bytes, not used.
- toPDF in interface PDFObject
Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.