Package org.apache.pdfbox.pdmodel
Class PDPatternContentStream
java.lang.Object
org.apache.pdfbox.pdmodel.PDPatternContentStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Author:
- Tilman Hausherr
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final PDDocument
protected boolean
protected final Deque
<PDColorSpace> protected final OutputStream
protected final PDResources
protected final Deque
<PDColorSpace> -
Constructor Summary
ConstructorsConstructorDescriptionPDPatternContentStream
(PDTilingPattern pattern) Create a new tiling pattern content stream. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addComment
(String comment) Write a comment line.void
addRect
(float x, float y, float width, float height) Add a rectangle to the current path.void
Begin a marked content sequence.void
beginMarkedContent
(COSName tag, PDPropertyList propertyList) Begin a marked content sequence with a reference to an entry in the page resources' Properties dictionary.void
Begin some text operations.void
clip()
Intersects the current clipping path with the current path, using the nonzero rule.void
Intersects the current clipping path with the current path, using the even-odd rule.void
close()
Close the content stream.void
Close, fill, and then stroke the path, using the nonzero winding number rule to determine the region to fill.void
Close, fill, and then stroke the path, using the even-odd rule to determine the region to fill.void
Close and stroke the path.void
Closes the current subpath.void
curveTo
(float x1, float y1, float x2, float y2, float x3, float y3) Append a cubic Bézier curve to the current path.void
curveTo1
(float x1, float y1, float x3, float y3) Append a cubic Bézier curve to the current path.void
curveTo2
(float x2, float y2, float x3, float y3) Append a cubic Bézier curve to the current path.void
drawForm
(PDFormXObject form) Draws the given Form XObject at the current location.void
drawImage
(PDImageXObject image, float x, float y) Draw an image at the x,y coordinates, with the default size of the image.void
drawImage
(PDImageXObject image, float x, float y, float width, float height) Draw an image at the x,y coordinates, with the given size.void
drawImage
(PDImageXObject image, Matrix matrix) Draw an image at the origin with the given transformation matrix.void
drawImage
(PDInlineImage inlineImage, float x, float y) Draw an inline image at the x,y coordinates, with the default size of the image.void
drawImage
(PDInlineImage inlineImage, float x, float y, float width, float height) Draw an inline image at the x,y coordinates and a certain width and height.void
End a marked content sequence.void
endText()
End some text operations.void
fill()
Fills the path using the nonzero winding number rule.void
Fill and then stroke the path, using the nonzero winding number rule to determine the region to fill.void
Fill and then stroke the path, using the even-odd rule to determine the region to fill.void
Fills the path using the even-odd winding rule.protected COSName
getName
(PDColorSpace colorSpace) protected boolean
isOutside255Interval
(int val) void
lineTo
(float x, float y) Draw a line from the current position to the given coordinates.void
moveTo
(float x, float y) Move the current position to the given coordinates.void
newLine()
Move to the start of the next line of text.void
newLineAtOffset
(float tx, float ty) The Td operator.void
Q operator.void
q operator.void
setCharacterSpacing
(float spacing) Set the character spacing.void
Set the font and font size to draw text with.void
Set an extended graphics state.void
setHorizontalScaling
(float scale) Set the horizontal scaling to scale / 100.void
setLeading
(float leading) Sets the text leading.void
setLineCapStyle
(int lineCapStyle) Set the line cap style.void
setLineDashPattern
(float[] pattern, float phase) Set the line dash pattern.void
setLineJoinStyle
(int lineJoinStyle) Set the line join style.void
setLineWidth
(float lineWidth) Set line width to the given value.protected void
setMaximumFractionDigits
(int fractionDigitsNumber) Sets the maximum number of digits allowed for fractional numbers.void
setMiterLimit
(float miterLimit) Set the miter limit.void
setNonStrokingColor
(float g) Set the non-stroking color in the DeviceGray color space.void
setNonStrokingColor
(float r, float g, float b) Set the non-stroking color in the DeviceRGB color space.void
setNonStrokingColor
(float c, float m, float y, float k) Set the non-stroking color in the DeviceCMYK color space.void
setNonStrokingColor
(int g) Deprecated.void
setNonStrokingColor
(int r, int g, int b) Deprecated.void
setNonStrokingColor
(int c, int m, int y, int k) Deprecated.UsesetStrokingColor(c/255f, m/255f, y/255f, k/255f)
instead.void
setNonStrokingColor
(Color color) Set the non-stroking color using an AWT color.void
setNonStrokingColor
(PDColor color) Sets the non-stroking color and, if necessary, the non-stroking color space.protected void
setNonStrokingColorSpaceStack
(PDColorSpace colorSpace) void
Set the text rendering mode.void
setStrokingColor
(float g) Set the stroking color in the DeviceGray color space.void
setStrokingColor
(float r, float g, float b) Set the stroking color in the DeviceRGB color space.void
setStrokingColor
(float c, float m, float y, float k) Set the stroking color in the DeviceCMYK color space.void
setStrokingColor
(int r, int g, int b) Deprecated.void
setStrokingColor
(Color color) Set the stroking color using an AWT color.void
setStrokingColor
(PDColor color) Sets the stroking color and, if necessary, the stroking color space.protected void
setStrokingColorSpaceStack
(PDColorSpace colorSpace) void
setTextMatrix
(Matrix matrix) The Tm operator.void
setTextRise
(float rise) Set the text rise value, i.e.void
setWordSpacing
(float spacing) Set the word spacing.void
shadingFill
(PDShading shading) Fills the clipping area with the given shading.void
Shows the given text at the location specified by the current text matrix.protected void
showTextInternal
(String text) Outputs a string using the correct encoding and subsetting as required.void
showTextWithPositioning
(Object[] textWithPositioningArray) Shows the given text at the location specified by the current text matrix with the given interspersed positioning.void
stroke()
Stroke the path.void
The cm operator.protected void
write
(byte[] data) Writes a byte[] to the content stream.protected void
Writes a string to the content stream as ASCII.protected void
writeBytes
(byte[] data) Writes binary data to the content stream.protected void
Writes a newline to the content stream as ASCII.protected void
writeOperand
(float real) Writes a real number to the content stream.protected void
writeOperand
(int integer) Writes an integer number to the content stream.protected void
writeOperand
(COSName name) Writes a COSName to the content stream.protected void
writeOperator
(String text) Writes a string to the content stream as ASCII.
-
Field Details
-
document
-
outputStream
-
resources
-
inTextMode
protected boolean inTextMode -
fontStack
-
nonStrokingColorSpaceStack
-
strokingColorSpaceStack
-
-
Constructor Details
-
PDPatternContentStream
Create a new tiling pattern content stream.- Parameters:
pattern
- The tiling pattern stream to write to.- Throws:
IOException
- If there is an error writing to the form contents.
-
-
Method Details
-
setMaximumFractionDigits
protected void setMaximumFractionDigits(int fractionDigitsNumber) Sets the maximum number of digits allowed for fractional numbers.- Parameters:
fractionDigitsNumber
-- See Also:
-
beginText
Begin some text operations.- Throws:
IOException
- If there is an error writing to the stream or if you attempt to nest beginText calls.IllegalStateException
- If the method was not allowed to be called at this time.
-
endText
End some text operations.- Throws:
IOException
- If there is an error writing to the stream or if you attempt to nest endText calls.IllegalStateException
- If the method was not allowed to be called at this time.
-
setFont
Set the font and font size to draw text with.- Parameters:
font
- The font to use.fontSize
- The font size to draw the text.- Throws:
IOException
- If there is an error writing the font information.
-
showTextWithPositioning
Shows the given text at the location specified by the current text matrix with the given interspersed positioning. This allows the user to efficiently position each glyph or sequence of glyphs.- Parameters:
textWithPositioningArray
- An array consisting of String and Float types. Each String is output to the page using the current text matrix. Using the default coordinate system, each interspersed number adjusts the current text matrix by translating to the left or down for horizontal and vertical text respectively. The number is expressed in thousands of a text space unit, and may be negative.- Throws:
IOException
- if an io exception occurs.
-
showText
Shows the given text at the location specified by the current text matrix.- Parameters:
text
- The Unicode text to show.- Throws:
IOException
- If an io exception occurs.IllegalArgumentException
- if a character isn't supported by the current font
-
showTextInternal
Outputs a string using the correct encoding and subsetting as required.- Parameters:
text
- The Unicode text to show.- Throws:
IOException
- If an io exception occurs.
-
setLeading
Sets the text leading.- Parameters:
leading
- The leading in unscaled text units.- Throws:
IOException
- If there is an error writing to the stream.
-
newLine
Move to the start of the next line of text. Requires the leading (seesetLeading(float)
) to have been set.- Throws:
IOException
- If there is an error writing to the stream.
-
newLineAtOffset
The Td operator. Move to the start of the next line, offset from the start of the current line by (tx, ty).- Parameters:
tx
- The x translation.ty
- The y translation.- Throws:
IOException
- If there is an error writing to the stream.IllegalStateException
- If the method was not allowed to be called at this time.
-
setTextMatrix
The Tm operator. Sets the text matrix to the given values. A current text matrix will be replaced with the new one.- Parameters:
matrix
- the transformation matrix- Throws:
IOException
- If there is an error writing to the stream.IllegalStateException
- If the method was not allowed to be called at this time.
-
drawImage
Draw an image at the x,y coordinates, with the default size of the image.- Parameters:
image
- The image to draw.x
- The x-coordinate to draw the image.y
- The y-coordinate to draw the image.- Throws:
IOException
- If there is an error writing to the stream.
-
drawImage
public void drawImage(PDImageXObject image, float x, float y, float width, float height) throws IOException Draw an image at the x,y coordinates, with the given size.- Parameters:
image
- The image to draw.x
- The x-coordinate to draw the image.y
- The y-coordinate to draw the image.width
- The width to draw the image.height
- The height to draw the image.- Throws:
IOException
- If there is an error writing to the stream.IllegalStateException
- If the method was called within a text block.
-
drawImage
Draw an image at the origin with the given transformation matrix.- Parameters:
image
- The image to draw.matrix
- The transformation matrix to apply to the image.- Throws:
IOException
- If there is an error writing to the stream.IllegalStateException
- If the method was called within a text block.
-
drawImage
Draw an inline image at the x,y coordinates, with the default size of the image.- Parameters:
inlineImage
- The inline image to draw.x
- The x-coordinate to draw the inline image.y
- The y-coordinate to draw the inline image.- Throws:
IOException
- If there is an error writing to the stream.
-
drawImage
public void drawImage(PDInlineImage inlineImage, float x, float y, float width, float height) throws IOException Draw an inline image at the x,y coordinates and a certain width and height.- Parameters:
inlineImage
- The inline image to draw.x
- The x-coordinate to draw the inline image.y
- The y-coordinate to draw the inline image.width
- The width of the inline image to draw.height
- The height of the inline image to draw.- Throws:
IOException
- If there is an error writing to the stream.IllegalStateException
- If the method was called within a text block.
-
drawForm
Draws the given Form XObject at the current location.- Parameters:
form
- Form XObject- Throws:
IOException
- if the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
transform
The cm operator. Concatenates the given matrix with the current transformation matrix (CTM), which maps user space coordinates used within a PDF content stream into output device coordinates. More details on coordinates can be found in the PDF 32000 specification, 8.3.2 Coordinate Spaces.- Parameters:
matrix
- the transformation matrix- Throws:
IOException
- If there is an error writing to the stream.
-
saveGraphicsState
q operator. Saves the current graphics state.- Throws:
IOException
- If an error occurs while writing to the stream.
-
restoreGraphicsState
Q operator. Restores the current graphics state.- Throws:
IOException
- If an error occurs while writing to the stream.
-
getName
-
setStrokingColor
Sets the stroking color and, if necessary, the stroking color space.- Parameters:
color
- Color in a specific color space.- Throws:
IOException
- If an IO error occurs while writing to the stream.
-
setStrokingColor
Set the stroking color using an AWT color. Conversion uses the default sRGB color space.- Parameters:
color
- The color to set.- Throws:
IOException
- If an IO error occurs while writing to the stream.
-
setStrokingColor
Set the stroking color in the DeviceRGB color space. Range is 0..1.- Parameters:
r
- The red valueg
- The green value.b
- The blue value.- Throws:
IOException
- If an IO error occurs while writing to the stream.IllegalArgumentException
- If the parameters are invalid.
-
setStrokingColor
Deprecated.Set the stroking color in the DeviceRGB color space. Range is 0..255.- Parameters:
r
- The red valueg
- The green value.b
- The blue value.- Throws:
IOException
- If an IO error occurs while writing to the stream.IllegalArgumentException
- If the parameters are invalid.
-
setStrokingColor
Set the stroking color in the DeviceCMYK color space. Range is 0..1- Parameters:
c
- The cyan value.m
- The magenta value.y
- The yellow value.k
- The black value.- Throws:
IOException
- If an IO error occurs while writing to the stream.IllegalArgumentException
- If the parameters are invalid.
-
setStrokingColor
Set the stroking color in the DeviceGray color space. Range is 0..1.- Parameters:
g
- The gray value.- Throws:
IOException
- If an IO error occurs while writing to the stream.IllegalArgumentException
- If the parameter is invalid.
-
setNonStrokingColor
Sets the non-stroking color and, if necessary, the non-stroking color space.- Parameters:
color
- Color in a specific color space.- Throws:
IOException
- If an IO error occurs while writing to the stream.
-
setNonStrokingColor
Set the non-stroking color using an AWT color. Conversion uses the default sRGB color space.- Parameters:
color
- The color to set.- Throws:
IOException
- If an IO error occurs while writing to the stream.
-
setNonStrokingColor
Set the non-stroking color in the DeviceRGB color space. Range is 0..1.- Parameters:
r
- The red value.g
- The green value.b
- The blue value.- Throws:
IOException
- If an IO error occurs while writing to the stream.IllegalArgumentException
- If the parameters are invalid.
-
setNonStrokingColor
Deprecated.Set the non stroking color in the DeviceRGB color space. Range is 0..255.- Parameters:
r
- The red valueg
- The green value.b
- The blue value.- Throws:
IOException
- If an IO error occurs while writing to the stream.IllegalArgumentException
- If the parameters are invalid.
-
setNonStrokingColor
Deprecated.UsesetStrokingColor(c/255f, m/255f, y/255f, k/255f)
instead.Set the non-stroking color in the DeviceCMYK color space. Range is 0..255.- Parameters:
c
- The cyan value.m
- The magenta value.y
- The yellow value.k
- The black value.- Throws:
IOException
- If an IO error occurs while writing to the stream.IllegalArgumentException
- If the parameters are invalid.
-
setNonStrokingColor
Set the non-stroking color in the DeviceCMYK color space. Range is 0..1.- Parameters:
c
- The cyan value.m
- The magenta value.y
- The yellow value.k
- The black value.- Throws:
IOException
- If an IO error occurs while writing to the stream.
-
setNonStrokingColor
Deprecated.Set the non-stroking color in the DeviceGray color space. Range is 0..255.- Parameters:
g
- The gray value.- Throws:
IOException
- If an IO error occurs while writing to the stream.IllegalArgumentException
- If the parameter is invalid.
-
setNonStrokingColor
Set the non-stroking color in the DeviceGray color space. Range is 0..1.- Parameters:
g
- The gray value.- Throws:
IOException
- If an IO error occurs while writing to the stream.IllegalArgumentException
- If the parameter is invalid.
-
addRect
Add a rectangle to the current path.- Parameters:
x
- The lower left x coordinate.y
- The lower left y coordinate.width
- The width of the rectangle.height
- The height of the rectangle.- Throws:
IOException
- If the content stream could not be written.IllegalStateException
- If the method was called within a text block.
-
curveTo
Append a cubic Bézier curve to the current path. The curve extends from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bézier control points.- Parameters:
x1
- x coordinate of the point 1y1
- y coordinate of the point 1x2
- x coordinate of the point 2y2
- y coordinate of the point 2x3
- x coordinate of the point 3y3
- y coordinate of the point 3- Throws:
IOException
- If the content stream could not be written.IllegalStateException
- If the method was called within a text block.
-
curveTo2
Append a cubic Bézier curve to the current path. The curve extends from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bézier control points.- Parameters:
x2
- x coordinate of the point 2y2
- y coordinate of the point 2x3
- x coordinate of the point 3y3
- y coordinate of the point 3- Throws:
IllegalStateException
- If the method was called within a text block.IOException
- If the content stream could not be written.
-
curveTo1
Append a cubic Bézier curve to the current path. The curve extends from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bézier control points.- Parameters:
x1
- x coordinate of the point 1y1
- y coordinate of the point 1x3
- x coordinate of the point 3y3
- y coordinate of the point 3- Throws:
IOException
- If the content stream could not be written.IllegalStateException
- If the method was called within a text block.
-
moveTo
Move the current position to the given coordinates.- Parameters:
x
- The x coordinate.y
- The y coordinate.- Throws:
IOException
- If the content stream could not be written.IllegalStateException
- If the method was called within a text block.
-
lineTo
Draw a line from the current position to the given coordinates.- Parameters:
x
- The x coordinate.y
- The y coordinate.- Throws:
IOException
- If the content stream could not be written.IllegalStateException
- If the method was called within a text block.
-
stroke
Stroke the path.- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
closeAndStroke
Close and stroke the path.- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
fill
Fills the path using the nonzero winding number rule.- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
fillEvenOdd
Fills the path using the even-odd winding rule.- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
fillAndStroke
Fill and then stroke the path, using the nonzero winding number rule to determine the region to fill. This shall produce the same result as constructing two identical path objects, painting the first withfill()
and the second withstroke()
.- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
fillAndStrokeEvenOdd
Fill and then stroke the path, using the even-odd rule to determine the region to fill. This shall produce the same result as constructing two identical path objects, painting the first withfillEvenOdd()
and the second withstroke()
.- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
closeAndFillAndStroke
Close, fill, and then stroke the path, using the nonzero winding number rule to determine the region to fill. This shall have the same effect as the sequenceclosePath()
and thenfillAndStroke()
.- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
closeAndFillAndStrokeEvenOdd
Close, fill, and then stroke the path, using the even-odd rule to determine the region to fill. This shall have the same effect as the sequenceclosePath()
and thenfillAndStrokeEvenOdd()
.- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
shadingFill
Fills the clipping area with the given shading.- Parameters:
shading
- Shading resource- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
closePath
Closes the current subpath.- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
clip
Intersects the current clipping path with the current path, using the nonzero rule.- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
clipEvenOdd
Intersects the current clipping path with the current path, using the even-odd rule.- Throws:
IOException
- If the content stream could not be writtenIllegalStateException
- If the method was called within a text block.
-
setLineWidth
Set line width to the given value.- Parameters:
lineWidth
- The width which is used for drawing.- Throws:
IOException
- If the content stream could not be written
-
setLineJoinStyle
Set the line join style.- Parameters:
lineJoinStyle
- 0 for miter join, 1 for round join, and 2 for bevel join.- Throws:
IOException
- If the content stream could not be written.IllegalArgumentException
- If the parameter is not a valid line join style.
-
setLineCapStyle
Set the line cap style.- Parameters:
lineCapStyle
- 0 for butt cap, 1 for round cap, and 2 for projecting square cap.- Throws:
IOException
- If the content stream could not be written.IllegalArgumentException
- If the parameter is not a valid line cap style.
-
setLineDashPattern
Set the line dash pattern.- Parameters:
pattern
- The pattern arrayphase
- The phase of the pattern- Throws:
IOException
- If the content stream could not be written.
-
setMiterLimit
Set the miter limit.- Parameters:
miterLimit
- the new miter limit.- Throws:
IOException
- If the content stream could not be written.IllegalArgumentException
- If the parameter is ? 0.
-
beginMarkedContent
Begin a marked content sequence.- Parameters:
tag
- the tag- Throws:
IOException
- If the content stream could not be written
-
beginMarkedContent
Begin a marked content sequence with a reference to an entry in the page resources' Properties dictionary.- Parameters:
tag
- the tagpropertyList
- property list- Throws:
IOException
- If the content stream could not be written
-
endMarkedContent
End a marked content sequence.- Throws:
IOException
- If the content stream could not be written
-
setGraphicsStateParameters
Set an extended graphics state.- Parameters:
state
- The extended graphics state.- Throws:
IOException
- If the content stream could not be written.
-
addComment
Write a comment line.- Parameters:
comment
-- Throws:
IOException
- If the content stream could not be written.IllegalArgumentException
- If the comment contains a newline. This is not allowed, because the next line could be ordinary PDF content.
-
writeOperand
Writes a real number to the content stream.- Parameters:
real
-- Throws:
IOException
IllegalArgumentException
- if the parameter is not a finite number
-
writeOperand
Writes an integer number to the content stream.- Parameters:
integer
-- Throws:
IOException
-
writeOperand
Writes a COSName to the content stream.- Parameters:
name
-- Throws:
IOException
-
writeOperator
Writes a string to the content stream as ASCII.- Parameters:
text
-- Throws:
IOException
-
write
Writes a string to the content stream as ASCII.- Parameters:
text
-- Throws:
IOException
-
write
Writes a byte[] to the content stream.- Parameters:
data
-- Throws:
IOException
-
writeLine
Writes a newline to the content stream as ASCII.- Throws:
IOException
-
writeBytes
Writes binary data to the content stream.- Parameters:
data
-- Throws:
IOException
-
close
Close the content stream. This must be called when you are done with this object.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
- If the underlying stream has a problem being written to.
-
isOutside255Interval
protected boolean isOutside255Interval(int val) -
setStrokingColorSpaceStack
-
setNonStrokingColorSpaceStack
-
setCharacterSpacing
Set the character spacing. The value shall be added to the horizontal or vertical component of the glyph's displacement, depending on the writing mode.- Parameters:
spacing
- character spacing- Throws:
IOException
- If the content stream could not be written.
-
setWordSpacing
Set the word spacing. The value shall be added to the horizontal or vertical component of the ASCII SPACE character, depending on the writing mode.This will have an effect only with Type1 and TrueType fonts, not with Type0 fonts. The PDF specification tells why: "Word spacing shall be applied to every occurrence of the single-byte character code 32 in a string when using a simple font or a composite font that defines code 32 as a single-byte code. It shall not apply to occurrences of the byte value 32 in multiple-byte codes."
- Parameters:
spacing
- word spacing- Throws:
IOException
- If the content stream could not be written.
-
setHorizontalScaling
Set the horizontal scaling to scale / 100.- Parameters:
scale
- number specifying the percentage of the normal width. Default value: 100 (normal width).- Throws:
IOException
- If the content stream could not be written.
-
setRenderingMode
Set the text rendering mode. This determines whether showing text shall cause glyph outlines to be stroked, filled, used as a clipping boundary, or some combination of the three.- Parameters:
rm
- The text rendering mode.- Throws:
IOException
- If the content stream could not be written.
-
setTextRise
Set the text rise value, i.e. move the baseline up or down. This is useful for drawing superscripts or subscripts.- Parameters:
rise
- Specifies the distance, in unscaled text space units, to move the baseline up or down from its default location. 0 restores the default location.- Throws:
IOException
-
setNonStrokingColor(g/255f)