Package org.apache.xmlgraphics.java2d.ps
Class PSTilingPattern
java.lang.Object
org.apache.xmlgraphics.java2d.ps.PSTilingPattern
This class is implementation of PostScript tiling pattern. It allows to make a pattern
with defined PaintProc or texture.
Originally authored by Jiri Kunhart.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Rectangle2D
An array of four numbers in the pattern coordinate system, giving the coordinates of the left, bottom, right, and top edges, respectively, of the pattern cell's bounding boxprotected StringBuffer
A PostScript procedure for painting the pattern cellprotected int
A code that determines how the color of the pattern cell is to be specified: 1 for colored pattern, 2 for uncolored patternstatic final int
PostScript constant for a shading pattern (unsupported)static final int
A code identifying the pattern type that this dictionary describes; must be 1 for a tiling patternprotected String
The name of the pattern (for example: "Pattern1" )protected int
the pattern type of this patternprotected TexturePaint
A texture is used for filling shapesprotected int
A code that controls adjustments to the spacing of tiles relative to the device pixel grid: 1 for constant spacing, 2 for no distortion 3 for constant spacing and faster tiling.protected double
The desired horizontal spacing between pattern cells, measured in the pattern coordinate systemprotected List
The XUID is an extended unique ID -- an array of integers that provides for distributed, hierarchical management of the space of unique ID numbers (optional)protected double
The desired vertical spacing between pattern cells, measured in the pattern coordinate system -
Constructor Summary
ConstructorsConstructorDescriptionPSTilingPattern
(String patternName, TexturePaint texture, double xStep, double yStep, int tilingType, List xUID) Constructor for the creation of pattern with defined texturePSTilingPattern
(String patternName, StringBuffer paintProc, Rectangle bBox, double xStep, double yStep, int paintType, int tilingType, List xUID) Constructor for the creation of pattern with defined PaintProc -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares two patterns data (except their names).Returns the bounding box.getName()
Gets the name of the patternGets the postscript procedure PaintProcint
Gets the code that determines how the color of the pattern cell is to be specified: 1 for colored pattern, 2 for uncolored patternGets a texture which is used for filling shapesint
Gets a code that controls adjustments to the spacing of tiles relative to the device pixel grid: 1 for constant spacing, 2 for no distortion 3 for constant spacing and faster tilingdouble
getXStep()
Gets the horizontal spacing between pattern cellsgetXUID()
Gets an extended unique ID that uniquely identifies the patterndouble
getYStep()
Gets the vertical spacing between pattern cellsint
hashCode()
void
setBoundingBox
(Rectangle2D bBox) Sets the bounding box.void
Sets the name of the pattern.void
setPaintProc
(StringBuffer paintProc) Sets the postscript procedure PaintProcvoid
setPaintType
(int paintType) Sets the code that determines how the color of the pattern cell is to be specified: 1 for colored pattern, 2 for uncolored patternvoid
setTexturePaint
(TexturePaint texturePaint) Sets a texture which is used for filling shapesvoid
setTilingType
(int tilingType) Sets a code that controls adjustments to the spacing of tiles relative to the device pixel grid: 1 for constant spacing, 2 for no distortion 3 for constant spacing and faster tilingvoid
setXStep
(double xStep) Sets the horizontal spacing between pattern cellsvoid
Sets an extended unique ID that uniquely identifies the patternvoid
setYStep
(double yStep) Sets the vertical spacing between pattern cellstoString
(boolean acrobatDownsample) Generates postscript code for a pattern
-
Field Details
-
PATTERN_TYPE_TILING
public static final int PATTERN_TYPE_TILINGA code identifying the pattern type that this dictionary describes; must be 1 for a tiling pattern- See Also:
-
PATTERN_TYPE_SHADING
public static final int PATTERN_TYPE_SHADINGPostScript constant for a shading pattern (unsupported)- See Also:
-
patternType
protected int patternTypethe pattern type of this pattern -
patternName
The name of the pattern (for example: "Pattern1" ) -
xUID
The XUID is an extended unique ID -- an array of integers that provides for distributed, hierarchical management of the space of unique ID numbers (optional) -
paintProc
A PostScript procedure for painting the pattern cell -
bBox
An array of four numbers in the pattern coordinate system, giving the coordinates of the left, bottom, right, and top edges, respectively, of the pattern cell's bounding box -
xStep
protected double xStepThe desired horizontal spacing between pattern cells, measured in the pattern coordinate system -
yStep
protected double yStepThe desired vertical spacing between pattern cells, measured in the pattern coordinate system -
paintType
protected int paintTypeA code that determines how the color of the pattern cell is to be specified: 1 for colored pattern, 2 for uncolored pattern -
tilingType
protected int tilingTypeA code that controls adjustments to the spacing of tiles relative to the device pixel grid: 1 for constant spacing, 2 for no distortion 3 for constant spacing and faster tiling. -
texture
A texture is used for filling shapes
-
-
Constructor Details
-
PSTilingPattern
public PSTilingPattern(String patternName, StringBuffer paintProc, Rectangle bBox, double xStep, double yStep, int paintType, int tilingType, List xUID) Constructor for the creation of pattern with defined PaintProc- Parameters:
patternName
- the name of the pattern (for example: "Pattern1" ), if the name is null, the pattern should be stored in PSPatternStorage, where the pattern gets a name (the pattern without name cannot be use in PS file)paintProc
- a postscript procedure for painting the pattern cellbBox
- a pattern cell's bounding boxxStep
- the desired horizontal spacing between pattern cellsyStep
- the desired vertical spacing between pattern cellspaintType
- 1 for colored pattern, 2 for uncolored patterntilingType
- adjustments to the spacing of tiles relative to the device pixel grid (1,2 or 3)xUID
- an extended unique ID (optional)
-
PSTilingPattern
public PSTilingPattern(String patternName, TexturePaint texture, double xStep, double yStep, int tilingType, List xUID) Constructor for the creation of pattern with defined texture- Parameters:
patternName
- the name of the pattern (for example: "Pattern1" ), if the name is null, the pattern should be stored in PSPatternStorage, where the pattern gets a name (a pattern without name cannot be use in PS file)texture
- a texture is used for filling a shapexStep
- the desired horizontal spacing between pattern cellsyStep
- yStep the desired vertical spacing between pattern cellstilingType
- adjustments to the spacing of tiles relative to the device pixel grid (1,2 or 3)xUID
- xUID an extended unique ID (optional)
-
-
Method Details
-
getName
Gets the name of the pattern- Returns:
- String representing the name of the pattern.
-
setName
Sets the name of the pattern.- Parameters:
name
- the name of the pattern. Can be anything without spaces (for example "Pattern1").
-
getBoundingBox
Returns the bounding box.- Returns:
- a pattern cell's bounding box
-
setBoundingBox
Sets the bounding box.- Parameters:
bBox
- a pattern cell's bounding box
-
getPaintProc
Gets the postscript procedure PaintProc- Returns:
- the postscript procedure PaintProc
-
setPaintProc
Sets the postscript procedure PaintProc- Parameters:
paintProc
- the postscript procedure PaintProc
-
getXStep
public double getXStep()Gets the horizontal spacing between pattern cells- Returns:
- the horizontal spacing between pattern cells
-
setXStep
public void setXStep(double xStep) Sets the horizontal spacing between pattern cells- Parameters:
xStep
- the horizontal spacing between pattern cells
-
getYStep
public double getYStep()Gets the vertical spacing between pattern cells- Returns:
- the vertical spacing between pattern cells
-
setYStep
public void setYStep(double yStep) Sets the vertical spacing between pattern cells- Parameters:
yStep
- the vertical spacing between pattern cells
-
getPaintType
public int getPaintType()Gets the code that determines how the color of the pattern cell is to be specified: 1 for colored pattern, 2 for uncolored pattern- Returns:
- the paint type
-
setPaintType
public void setPaintType(int paintType) Sets the code that determines how the color of the pattern cell is to be specified: 1 for colored pattern, 2 for uncolored pattern- Parameters:
paintType
- the paint type
-
getTilingType
public int getTilingType()Gets a code that controls adjustments to the spacing of tiles relative to the device pixel grid: 1 for constant spacing, 2 for no distortion 3 for constant spacing and faster tiling- Returns:
- the tiling type
-
setTilingType
public void setTilingType(int tilingType) Sets a code that controls adjustments to the spacing of tiles relative to the device pixel grid: 1 for constant spacing, 2 for no distortion 3 for constant spacing and faster tiling- Parameters:
tilingType
- the tiling type
-
getTexturePaint
Gets a texture which is used for filling shapes- Returns:
- the texture
-
setTexturePaint
Sets a texture which is used for filling shapes- Parameters:
texturePaint
- the texture
-
getXUID
Gets an extended unique ID that uniquely identifies the pattern- Returns:
- xUID the unique ID
-
setXUID
Sets an extended unique ID that uniquely identifies the pattern- Parameters:
xUID
- the unique ID
-
toString
Generates postscript code for a pattern- Returns:
- The string which contains postscript code of pattern definition
-
hashCode
public int hashCode() -
equals
Compares two patterns data (except their names).
-