Class PdfPatternPainter
- java.lang.Object
-
- com.itextpdf.text.pdf.PdfContentByte
-
- com.itextpdf.text.pdf.PdfTemplate
-
- com.itextpdf.text.pdf.PdfPatternPainter
-
- All Implemented Interfaces:
IAccessibleElement
public final class PdfPatternPainter extends PdfTemplate
Implements the pattern.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.itextpdf.text.pdf.PdfContentByte
PdfContentByte.GraphicState, PdfContentByte.UncoloredPattern
-
-
Field Summary
Fields Modifier and Type Field Description (package private) BaseColor
defaultColor
(package private) boolean
stencil
(package private) float
xstep
(package private) float
ystep
-
Fields inherited from class com.itextpdf.text.pdf.PdfTemplate
accessibleAttributes, bBox, contentTagged, group, layer, matrix, pageReference, pageResources, role, thisReference, type, TYPE_IMPORTED, TYPE_PATTERN, TYPE_TEMPLATE
-
Fields inherited from class com.itextpdf.text.pdf.PdfContentByte
ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, content, duplicatedFrom, layerDepth, LINE_CAP_BUTT, LINE_CAP_PROJECTING_SQUARE, LINE_CAP_ROUND, LINE_JOIN_BEVEL, LINE_JOIN_MITER, LINE_JOIN_ROUND, markedContentSize, pdf, separator, state, stateList, TEXT_RENDER_MODE_CLIP, TEXT_RENDER_MODE_FILL, TEXT_RENDER_MODE_FILL_CLIP, TEXT_RENDER_MODE_FILL_STROKE, TEXT_RENDER_MODE_FILL_STROKE_CLIP, TEXT_RENDER_MODE_INVISIBLE, TEXT_RENDER_MODE_STROKE, TEXT_RENDER_MODE_STROKE_CLIP, writer
-
-
Constructor Summary
Constructors Modifier Constructor Description private
PdfPatternPainter()
Creates aPdfPattern
.(package private)
PdfPatternPainter(PdfWriter wr)
Creates new PdfPattern(package private)
PdfPatternPainter(PdfWriter wr, BaseColor defaultColor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addImage(Image image, float a, float b, float c, float d, float e, float f)
Adds anImage
to the page.(package private) void
checkNoColor()
BaseColor
getDefaultColor()
Returns the default color of the pattern.PdfContentByte
getDuplicate()
Gets a duplicate of thisPdfPatternPainter
.PdfPattern
getPattern()
Gets the stream representing this patternPdfPattern
getPattern(int compressionLevel)
Gets the stream representing this patternfloat
getXStep()
Returns the horizontal interval when repeating the pattern.float
getYStep()
Returns the vertical interval when repeating the pattern.boolean
isStencil()
Tells you if this pattern is colored/uncolored (stencil = uncolored, you need to set a default color).void
resetCMYKColorFill()
Changes the current color for filling paths to black.void
resetCMYKColorStroke()
Changes the current color for stroking paths to black.void
resetGrayFill()
Changes the current gray tint for filling paths to black.void
resetGrayStroke()
Changes the current gray tint for stroking paths to black.void
resetRGBColorFill()
Changes the current color for filling paths to black.void
resetRGBColorStroke()
Changes the current color for stroking paths to black.void
setCMYKColorFill(int cyan, int magenta, int yellow, int black)
Changes the current color for filling paths (device dependent colors!).void
setCMYKColorFillF(float cyan, float magenta, float yellow, float black)
Changes the current color for filling paths (device dependent colors!).void
setCMYKColorStroke(int cyan, int magenta, int yellow, int black)
Changes the current color for stroking paths (device dependent colors!).void
setCMYKColorStrokeF(float cyan, float magenta, float yellow, float black)
Changes the current color for stroking paths (device dependent colors!).void
setColorFill(BaseColor color)
Sets the fill color.void
setColorFill(PdfSpotColor sp, float tint)
Sets the fill color to a spot color.void
setColorStroke(BaseColor color)
Sets the stroke color.void
setColorStroke(PdfSpotColor sp, float tint)
Sets the stroke color to a spot color.void
setGrayFill(float gray)
Changes the currentgray tint for filling paths (device dependent colors!).void
setGrayStroke(float gray)
Changes the currentgray tint for stroking paths (device dependent colors!).void
setPatternFill(PdfPatternPainter p)
Sets the fill color to a pattern.void
setPatternFill(PdfPatternPainter p, BaseColor color, float tint)
Sets the fill color to an uncolored pattern.void
setPatternMatrix(float a, float b, float c, float d, float e, float f)
Sets the transformation matrix for the pattern.void
setPatternStroke(PdfPatternPainter p)
Sets the stroke color to a pattern.void
setPatternStroke(PdfPatternPainter p, BaseColor color, float tint)
Sets the stroke color to an uncolored pattern.void
setRGBColorFill(int red, int green, int blue)
Changes the current color for filling paths (device dependent colors!).void
setRGBColorFillF(float red, float green, float blue)
Changes the current color for filling paths (device dependent colors!).void
setRGBColorStroke(int red, int green, int blue)
Changes the current color for stroking paths (device dependent colors!).void
setRGBColorStrokeF(float red, float green, float blue)
Changes the current color for stroking paths (device dependent colors!).void
setXStep(float xstep)
Sets the horizontal interval of this pattern.void
setYStep(float ystep)
Sets the vertical interval of this pattern.-
Methods inherited from class com.itextpdf.text.pdf.PdfTemplate
beginVariableText, createTemplate, createTemplate, endVariableText, getAccessibleAttribute, getAccessibleAttributes, getAdditional, getBoundingBox, getCurrentPage, getFormXObject, getGroup, getHeight, getId, getIndirectReference, getLayer, getMatrix, getPageReference, getPageResources, getResources, getRole, getType, getWidth, isContentTagged, isInline, isTagged, setAccessibleAttribute, setAdditional, setBoundingBox, setContentTagged, setGroup, setHeight, setId, setLayer, setMatrix, setPageReference, setRole, setWidth
-
Methods inherited from class com.itextpdf.text.pdf.PdfContentByte
add, addAnnotation, addAnnotation, addFormXObj, addFormXObj, addImage, addImage, addImage, addImage, addImage, addImage, addImage, addImage, addOutline, addPSXObject, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplate, addTemplateReference, addTemplateReference, arc, arc, beginLayer, beginMarkedContentSequence, beginMarkedContentSequence, beginMarkedContentSequence, beginText, beginText, bezierArc, bezierArc, checkNoPattern, checkState, checkWriter, circle, circle, clip, closeMCBlock, closePath, closePathEoFillStroke, closePathFillStroke, closePathStroke, concatCTM, concatCTM, concatCTM, concatCTM, createAppearance, createAppearance, createGraphics, createGraphics, createGraphics, createGraphics, createGraphicsShapes, createGraphicsShapes, createPattern, createPattern, createPattern, createPattern, createPrinterGraphics, createPrinterGraphics, createPrinterGraphics, createPrinterGraphics, createPrinterGraphicsShapes, createPrinterGraphicsShapes, createTemplate, createTemplate, curveFromTo, curveFromTo, curveTo, curveTo, curveTo, curveTo, drawButton, drawButton, drawRadioField, drawRadioField, drawTextField, drawTextField, ellipse, ellipse, endLayer, endMarkedContentSequence, endText, eoClip, eoFill, eoFillStroke, fill, fillStroke, getCharacterSpacing, getDuplicate, getEffectiveStringWidth, getHorizontalScaling, getInternalBuffer, getInText, getKernArray, getLeading, getMcDepth, getMcElements, getPdfDocument, getPdfWriter, getRootOutline, getWordSpacing, getXTLM, getYTLM, inheritGraphicState, isTaggingSuppressed, lineTo, lineTo, localDestination, localGoto, moveText, moveTextWithLeading, moveTo, moveTo, newlineShowText, newlineShowText, newlineText, newPath, openMCBlock, outputColorNumbers, paintShading, paintShading, rectangle, rectangle, rectangle, remoteGoto, remoteGoto, reset, reset, restoreMCBlocks, restoreState, roundRectangle, roundRectangle, sanityCheck, saveMCBlocks, saveState, setAction, setCharacterSpacing, setColorFill, setColorFill, setColorStroke, setColorStroke, setDefaultColorspace, setFlatness, setFlatness, setFontAndSize, setGState, setHorizontalScaling, setLeading, setLineCap, setLineDash, setLineDash, setLineDash, setLineDash, setLineDash, setLineDash, setLineDash, setLineDash, setLineJoin, setLineWidth, setLineWidth, setLiteral, setLiteral, setLiteral, setMcDepth, setMcElements, setMiterLimit, setMiterLimit, setPatternFill, setPatternStroke, setRenderingIntent, setShadingFill, setShadingStroke, setSuppressTagging, setTextMatrix, setTextMatrix, setTextMatrix, setTextMatrix, setTextRenderingMode, setTextRise, setTextRise, setWordSpacing, showText, showText, showTextAligned, showTextAlignedKerned, showTextGid, showTextKerned, size, size, stroke, toPdf, toString, transform, transform, updateTx, variableRectangle
-
-
-
-
Field Detail
-
xstep
float xstep
-
ystep
float ystep
-
stencil
boolean stencil
-
defaultColor
BaseColor defaultColor
-
-
Method Detail
-
setXStep
public void setXStep(float xstep)
Sets the horizontal interval of this pattern.- Parameters:
xstep
- the xstep in horizontal painting
-
setYStep
public void setYStep(float ystep)
Sets the vertical interval of this pattern.- Parameters:
ystep
- in vertical painting
-
getXStep
public float getXStep()
Returns the horizontal interval when repeating the pattern.- Returns:
- a value
-
getYStep
public float getYStep()
Returns the vertical interval when repeating the pattern.- Returns:
- a value
-
isStencil
public boolean isStencil()
Tells you if this pattern is colored/uncolored (stencil = uncolored, you need to set a default color).- Returns:
- true if the pattern is an uncolored tiling pattern (stencil).
-
setPatternMatrix
public void setPatternMatrix(float a, float b, float c, float d, float e, float f)
Sets the transformation matrix for the pattern.- Parameters:
a
-b
-c
-d
-e
-f
-
-
getPattern
public PdfPattern getPattern()
Gets the stream representing this pattern- Returns:
- the stream representing this pattern
-
getPattern
public PdfPattern getPattern(int compressionLevel)
Gets the stream representing this pattern- Parameters:
compressionLevel
- the compression level of the stream- Returns:
- the stream representing this pattern
- Since:
- 2.1.3
-
getDuplicate
public PdfContentByte getDuplicate()
Gets a duplicate of thisPdfPatternPainter
. All the members are copied by reference but the buffer stays different.- Overrides:
getDuplicate
in classPdfTemplate
- Returns:
- a copy of this
PdfPatternPainter
-
getDefaultColor
public BaseColor getDefaultColor()
Returns the default color of the pattern.- Returns:
- a BaseColor
-
setGrayFill
public void setGrayFill(float gray)
Description copied from class:PdfContentByte
Changes the currentgray tint for filling paths (device dependent colors!).Sets the color space to DeviceGray (or the DefaultGray color space), and sets the gray tint to use for filling paths.
- Overrides:
setGrayFill
in classPdfContentByte
- Parameters:
gray
- a value between 0 (black) and 1 (white)- See Also:
PdfContentByte.setGrayFill(float)
-
resetGrayFill
public void resetGrayFill()
Description copied from class:PdfContentByte
Changes the current gray tint for filling paths to black.- Overrides:
resetGrayFill
in classPdfContentByte
- See Also:
PdfContentByte.resetGrayFill()
-
setGrayStroke
public void setGrayStroke(float gray)
Description copied from class:PdfContentByte
Changes the currentgray tint for stroking paths (device dependent colors!).Sets the color space to DeviceGray (or the DefaultGray color space), and sets the gray tint to use for stroking paths.
- Overrides:
setGrayStroke
in classPdfContentByte
- Parameters:
gray
- a value between 0 (black) and 1 (white)- See Also:
PdfContentByte.setGrayStroke(float)
-
resetGrayStroke
public void resetGrayStroke()
Description copied from class:PdfContentByte
Changes the current gray tint for stroking paths to black.- Overrides:
resetGrayStroke
in classPdfContentByte
- See Also:
PdfContentByte.resetGrayStroke()
-
setRGBColorFillF
public void setRGBColorFillF(float red, float green, float blue)
Description copied from class:PdfContentByte
Changes the current color for filling paths (device dependent colors!).Sets the color space to DeviceRGB (or the DefaultRGB color space), and sets the color to use for filling paths.
Following the PDF manual, each operand must be a number between 0 (minimum intensity) and 1 (maximum intensity).
- Overrides:
setRGBColorFillF
in classPdfContentByte
- Parameters:
red
- the intensity of red. A value between 0 and 1green
- the intensity of green. A value between 0 and 1blue
- the intensity of blue. A value between 0 and 1- See Also:
PdfContentByte.setRGBColorFillF(float, float, float)
-
resetRGBColorFill
public void resetRGBColorFill()
Description copied from class:PdfContentByte
Changes the current color for filling paths to black.- Overrides:
resetRGBColorFill
in classPdfContentByte
- See Also:
PdfContentByte.resetRGBColorFill()
-
setRGBColorStrokeF
public void setRGBColorStrokeF(float red, float green, float blue)
Description copied from class:PdfContentByte
Changes the current color for stroking paths (device dependent colors!).Sets the color space to DeviceRGB (or the DefaultRGB color space), and sets the color to use for stroking paths.
Following the PDF manual, each operand must be a number between 0 (miniumum intensity) and 1 (maximum intensity).
- Overrides:
setRGBColorStrokeF
in classPdfContentByte
- Parameters:
red
- the intensity of red. A value between 0 and 1green
- the intensity of green. A value between 0 and 1blue
- the intensity of blue. A value between 0 and 1- See Also:
PdfContentByte.setRGBColorStrokeF(float, float, float)
-
resetRGBColorStroke
public void resetRGBColorStroke()
Description copied from class:PdfContentByte
Changes the current color for stroking paths to black.- Overrides:
resetRGBColorStroke
in classPdfContentByte
- See Also:
PdfContentByte.resetRGBColorStroke()
-
setCMYKColorFillF
public void setCMYKColorFillF(float cyan, float magenta, float yellow, float black)
Description copied from class:PdfContentByte
Changes the current color for filling paths (device dependent colors!).Sets the color space to DeviceCMYK (or the DefaultCMYK color space), and sets the color to use for filling paths.
Following the PDF manual, each operand must be a number between 0 (no ink) and 1 (maximum ink).
- Overrides:
setCMYKColorFillF
in classPdfContentByte
- Parameters:
cyan
- the intensity of cyan. A value between 0 and 1magenta
- the intensity of magenta. A value between 0 and 1yellow
- the intensity of yellow. A value between 0 and 1black
- the intensity of black. A value between 0 and 1- See Also:
PdfContentByte.setCMYKColorFillF(float, float, float, float)
-
resetCMYKColorFill
public void resetCMYKColorFill()
Description copied from class:PdfContentByte
Changes the current color for filling paths to black.- Overrides:
resetCMYKColorFill
in classPdfContentByte
- See Also:
PdfContentByte.resetCMYKColorFill()
-
setCMYKColorStrokeF
public void setCMYKColorStrokeF(float cyan, float magenta, float yellow, float black)
Description copied from class:PdfContentByte
Changes the current color for stroking paths (device dependent colors!).Sets the color space to DeviceCMYK (or the DefaultCMYK color space), and sets the color to use for stroking paths.
Following the PDF manual, each operand must be a number between 0 (miniumum intensity) and 1 (maximum intensity).
- Overrides:
setCMYKColorStrokeF
in classPdfContentByte
- Parameters:
cyan
- the intensity of cyan. A value between 0 and 1magenta
- the intensity of magenta. A value between 0 and 1yellow
- the intensity of yellow. A value between 0 and 1black
- the intensity of black. A value between 0 and 1- See Also:
PdfContentByte.setCMYKColorStrokeF(float, float, float, float)
-
resetCMYKColorStroke
public void resetCMYKColorStroke()
Description copied from class:PdfContentByte
Changes the current color for stroking paths to black.- Overrides:
resetCMYKColorStroke
in classPdfContentByte
- See Also:
PdfContentByte.resetCMYKColorStroke()
-
addImage
public void addImage(Image image, float a, float b, float c, float d, float e, float f) throws DocumentException
Description copied from class:PdfContentByte
Adds anImage
to the page. The positioning of theImage
is done with the transformation matrix. To position animage
at (x,y) use addImage(image, image_width, 0, 0, image_height, x, y).- Overrides:
addImage
in classPdfContentByte
- Parameters:
image
- theImage
objecta
- an element of the transformation matrixb
- an element of the transformation matrixc
- an element of the transformation matrixd
- an element of the transformation matrixe
- an element of the transformation matrixf
- an element of the transformation matrix- Throws:
DocumentException
- on error- See Also:
PdfContentByte.addImage(com.itextpdf.text.Image, float, float, float, float, float, float)
-
setCMYKColorFill
public void setCMYKColorFill(int cyan, int magenta, int yellow, int black)
Description copied from class:PdfContentByte
Changes the current color for filling paths (device dependent colors!).Sets the color space to DeviceCMYK (or the DefaultCMYK color space), and sets the color to use for filling paths.
This method is described in the 'Portable Document Format Reference Manual version 1.3' section 8.5.2.1 (page 331).
Following the PDF manual, each operand must be a number between 0 (no ink) and 1 (maximum ink). This method however accepts only integers between 0x00 and 0xFF.
- Overrides:
setCMYKColorFill
in classPdfContentByte
- Parameters:
cyan
- the intensity of cyanmagenta
- the intensity of magentayellow
- the intensity of yellowblack
- the intensity of black- See Also:
PdfContentByte.setCMYKColorFill(int, int, int, int)
-
setCMYKColorStroke
public void setCMYKColorStroke(int cyan, int magenta, int yellow, int black)
Description copied from class:PdfContentByte
Changes the current color for stroking paths (device dependent colors!).Sets the color space to DeviceCMYK (or the DefaultCMYK color space), and sets the color to use for stroking paths.
This method is described in the 'Portable Document Format Reference Manual version 1.3' section 8.5.2.1 (page 331).
Following the PDF manual, each operand must be a number between 0 (minimum intensity) and 1 (maximum intensity). This method however accepts only integers between 0x00 and 0xFF.- Overrides:
setCMYKColorStroke
in classPdfContentByte
- Parameters:
cyan
- the intensity of redmagenta
- the intensity of greenyellow
- the intensity of blueblack
- the intensity of black- See Also:
PdfContentByte.setCMYKColorStroke(int, int, int, int)
-
setRGBColorFill
public void setRGBColorFill(int red, int green, int blue)
Description copied from class:PdfContentByte
Changes the current color for filling paths (device dependent colors!).Sets the color space to DeviceRGB (or the DefaultRGB color space), and sets the color to use for filling paths.
This method is described in the 'Portable Document Format Reference Manual version 1.3' section 8.5.2.1 (page 331).
Following the PDF manual, each operand must be a number between 0 (minimum intensity) and 1 (maximum intensity). This method however accepts only integers between 0x00 and 0xFF.
- Overrides:
setRGBColorFill
in classPdfContentByte
- Parameters:
red
- the intensity of redgreen
- the intensity of greenblue
- the intensity of blue- See Also:
PdfContentByte.setRGBColorFill(int, int, int)
-
setRGBColorStroke
public void setRGBColorStroke(int red, int green, int blue)
Description copied from class:PdfContentByte
Changes the current color for stroking paths (device dependent colors!).Sets the color space to DeviceRGB (or the DefaultRGB color space), and sets the color to use for stroking paths.
This method is described in the 'Portable Document Format Reference Manual version 1.3' section 8.5.2.1 (page 331).
Following the PDF manual, each operand must be a number between 0 (minimum intensity) and 1 (maximum intensity). This method however accepts only integers between 0x00 and 0xFF.- Overrides:
setRGBColorStroke
in classPdfContentByte
- Parameters:
red
- the intensity of redgreen
- the intensity of greenblue
- the intensity of blue- See Also:
PdfContentByte.setRGBColorStroke(int, int, int)
-
setColorStroke
public void setColorStroke(BaseColor color)
Description copied from class:PdfContentByte
Sets the stroke color.color
can be anExtendedColor
.- Overrides:
setColorStroke
in classPdfContentByte
- Parameters:
color
- the color- See Also:
PdfContentByte.setColorStroke(com.itextpdf.text.BaseColor)
-
setColorFill
public void setColorFill(BaseColor color)
Description copied from class:PdfContentByte
Sets the fill color.color
can be anExtendedColor
.- Overrides:
setColorFill
in classPdfContentByte
- Parameters:
color
- the color- See Also:
PdfContentByte.setColorFill(com.itextpdf.text.BaseColor)
-
setColorFill
public void setColorFill(PdfSpotColor sp, float tint)
Description copied from class:PdfContentByte
Sets the fill color to a spot color.- Overrides:
setColorFill
in classPdfContentByte
- Parameters:
sp
- the spot colortint
- the tint for the spot color. 0 is no color and 1 is 100% color- See Also:
PdfContentByte.setColorFill(com.itextpdf.text.pdf.PdfSpotColor, float)
-
setColorStroke
public void setColorStroke(PdfSpotColor sp, float tint)
Description copied from class:PdfContentByte
Sets the stroke color to a spot color.- Overrides:
setColorStroke
in classPdfContentByte
- Parameters:
sp
- the spot colortint
- the tint for the spot color. 0 is no color and 1 is 100% color- See Also:
PdfContentByte.setColorStroke(com.itextpdf.text.pdf.PdfSpotColor, float)
-
setPatternFill
public void setPatternFill(PdfPatternPainter p)
Description copied from class:PdfContentByte
Sets the fill color to a pattern. The pattern can be colored or uncolored.- Overrides:
setPatternFill
in classPdfContentByte
- Parameters:
p
- the pattern- See Also:
PdfContentByte.setPatternFill(com.itextpdf.text.pdf.PdfPatternPainter)
-
setPatternFill
public void setPatternFill(PdfPatternPainter p, BaseColor color, float tint)
Description copied from class:PdfContentByte
Sets the fill color to an uncolored pattern.- Overrides:
setPatternFill
in classPdfContentByte
- Parameters:
p
- the patterncolor
- the color of the patterntint
- the tint if the color is a spot color, ignored otherwise- See Also:
PdfContentByte.setPatternFill(com.itextpdf.text.pdf.PdfPatternPainter, com.itextpdf.text.BaseColor, float)
-
setPatternStroke
public void setPatternStroke(PdfPatternPainter p, BaseColor color, float tint)
Description copied from class:PdfContentByte
Sets the stroke color to an uncolored pattern.- Overrides:
setPatternStroke
in classPdfContentByte
- Parameters:
p
- the patterncolor
- the color of the patterntint
- the tint if the color is a spot color, ignored otherwise- See Also:
PdfContentByte.setPatternStroke(com.itextpdf.text.pdf.PdfPatternPainter, com.itextpdf.text.BaseColor, float)
-
setPatternStroke
public void setPatternStroke(PdfPatternPainter p)
Description copied from class:PdfContentByte
Sets the stroke color to a pattern. The pattern can be colored or uncolored.- Overrides:
setPatternStroke
in classPdfContentByte
- Parameters:
p
- the pattern- See Also:
PdfContentByte.setPatternStroke(com.itextpdf.text.pdf.PdfPatternPainter)
-
checkNoColor
void checkNoColor()
-
-