|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pdfbox.pdmodel.edit.PDPageContentStream
public class PDPageContentStream
This class will is a convenience for creating page content streams. You MUST call close() when you are finished with this object.
Constructor Summary | |
---|---|
PDPageContentStream(PDDocument document,
PDPage sourcePage)
Create a new PDPage content stream. |
|
PDPageContentStream(PDDocument document,
PDPage sourcePage,
boolean appendContent,
boolean compress)
Create a new PDPage content stream. |
|
PDPageContentStream(PDDocument document,
PDPage sourcePage,
boolean appendContent,
boolean compress,
boolean resetContext)
Create a new PDPage content stream. |
Method Summary | |
---|---|
void |
addBezier31(float x1,
float y1,
float x3,
float y3)
Append a cubic Bézier curve to the current path. |
void |
addBezier312(float x1,
float y1,
float x2,
float y2,
float x3,
float y3)
Append a cubic Bézier curve to the current path. |
void |
addBezier32(float x2,
float y2,
float x3,
float y3)
Append a cubic Bézier curve to the current path. |
void |
addLine(float xStart,
float yStart,
float xEnd,
float yEnd)
add a line to the current path. |
void |
addPolygon(float[] x,
float[] y)
Add a polygon to the current path. |
void |
addRect(float x,
float y,
float width,
float height)
Add a rectangle to the current path. |
void |
appendCOSName(COSName name)
This will append a COSName to the content stream. |
void |
appendRawCommands(byte[] commands)
This will append raw commands to the content stream. |
void |
appendRawCommands(int data)
This will append raw commands to the content stream. |
void |
appendRawCommands(String commands)
This will append raw commands to the content stream. |
void |
beginMarkedContentSequence(COSName tag)
Begin a marked content sequence. |
void |
beginMarkedContentSequence(COSName tag,
COSName propsName)
Begin a marked content sequence with a reference to an entry in the page resources' Properties dictionary. |
void |
beginText()
Begin some text operations. |
void |
clipPath(int windingRule)
Clip path. |
void |
close()
Close the content stream. |
void |
closeAndStroke()
Close and stroke the path. |
void |
closeSubPath()
Close subpath. |
void |
concatenate2CTM(AffineTransform at)
The Cm operator. |
void |
concatenate2CTM(double a,
double b,
double c,
double d,
double e,
double f)
The Cm operator. |
void |
drawImage(PDXObjectImage image,
float x,
float y)
Draw an image at the x,y coordinates, with the default size of the image. |
void |
drawLine(float xStart,
float yStart,
float xEnd,
float yEnd)
Draw a line on the page using the current non stroking color and the current line width. |
void |
drawPolygon(float[] x,
float[] y)
Draw a polygon on the page using the current non stroking color. |
void |
drawString(String text)
This will draw a string at the current location on the screen. |
void |
drawXObject(PDXObject xobject,
AffineTransform transform)
Draw an xobject(form or image) using the given AffineTransform to position
the xobject. |
void |
drawXObject(PDXObject xobject,
float x,
float y,
float width,
float height)
Draw an xobject(form or image) at the x,y coordinates and a certain width and height. |
void |
endMarkedContentSequence()
End a marked content sequence. |
void |
endText()
End some text operations. |
void |
fill(int windingRule)
Fill the path. |
void |
fillPolygon(float[] x,
float[] y)
Draw and fill a polygon on the page using the current non stroking color. |
void |
fillRect(float x,
float y,
float width,
float height)
Draw a rectangle on the page using the current non stroking color. |
void |
lineTo(float x,
float y)
Add a move to the given coordinate. |
void |
moveTextPositionByAmount(float x,
float y)
The Td operator. |
void |
moveTo(float x,
float y)
Add a line to the given coordinate. |
void |
restoreGraphicsState()
Q operator. |
void |
saveGraphicsState()
q operator. |
void |
setFont(PDFont font,
float fontSize)
Set the font to draw text with. |
void |
setLineWidth(float lineWidth)
Set linewidth to the given value. |
void |
setNonStrokingColor(Color color)
Set the non stroking color, specified as RGB. |
void |
setNonStrokingColor(double g)
Set the non stroking color, specified as Grayscale 0.0-1.0. |
void |
setNonStrokingColor(double c,
double m,
double y,
double k)
Set the non stroking color, specified as CMYK, 0.0-1.0. |
void |
setNonStrokingColor(float[] components)
Set the color components of current non stroking colorspace. |
void |
setNonStrokingColor(int g)
Set the non stroking color, specified as grayscale, 0-255. |
void |
setNonStrokingColor(int r,
int g,
int b)
Set the non stroking color, specified as RGB, 0-255. |
void |
setNonStrokingColor(int c,
int m,
int y,
int k)
Set the non stroking color, specified as CMYK, 0-255. |
void |
setNonStrokingColorSpace(PDColorSpace colorSpace)
Set the stroking color space. |
void |
setStrokingColor(Color color)
Set the stroking color, specified as RGB. |
void |
setStrokingColor(double g)
Set the stroking color, specified as Grayscale 0.0-1.0. |
void |
setStrokingColor(double c,
double m,
double y,
double k)
Set the stroking color, specified as CMYK, 0.0-1.0. |
void |
setStrokingColor(float[] components)
Set the color components of current stroking colorspace. |
void |
setStrokingColor(int g)
Set the stroking color, specified as grayscale, 0-255. |
void |
setStrokingColor(int r,
int g,
int b)
Set the stroking color, specified as RGB, 0-255. |
void |
setStrokingColor(int c,
int m,
int y,
int k)
Set the stroking color, specified as CMYK, 0-255. |
void |
setStrokingColorSpace(PDColorSpace colorSpace)
Set the stroking color space. |
void |
setTextMatrix(AffineTransform matrix)
The Tm operator. |
void |
setTextMatrix(double a,
double b,
double c,
double d,
double e,
double f)
The Tm operator. |
void |
setTextRotation(double angle,
double tx,
double ty)
The Tm operator. |
void |
setTextScaling(double sx,
double sy,
double tx,
double ty)
The Tm operator. |
void |
setTextTranslation(double tx,
double ty)
The Tm operator. |
void |
stroke()
Stroke the path. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PDPageContentStream(PDDocument document, PDPage sourcePage) throws IOException
document
- The document the page is part of.sourcePage
- The page to write the contents to.
IOException
- If there is an error writing to the page contents.public PDPageContentStream(PDDocument document, PDPage sourcePage, boolean appendContent, boolean compress) throws IOException
document
- The document the page is part of.sourcePage
- The page to write the contents to.appendContent
- Indicates whether content will be overwritten. If false all previous content is deleted.compress
- Tell if the content stream should compress the page contents.
IOException
- If there is an error writing to the page contents.public PDPageContentStream(PDDocument document, PDPage sourcePage, boolean appendContent, boolean compress, boolean resetContext) throws IOException
document
- The document the page is part of.sourcePage
- The page to write the contents to.appendContent
- Indicates whether content will be overwritten. If false all previous content is deleted.compress
- Tell if the content stream should compress the page contents.resetContext
- Tell if the graphic context should be reseted.
IOException
- If there is an error writing to the page contents.Method Detail |
---|
public void beginText() throws IOException
IOException
- If there is an error writing to the stream or if you attempt to
nest beginText calls.public void endText() throws IOException
IOException
- If there is an error writing to the stream or if you attempt to
nest endText calls.public void setFont(PDFont font, float fontSize) throws IOException
font
- The font to use.fontSize
- The font size to draw the text.
IOException
- If there is an error writing the font information.public void drawImage(PDXObjectImage image, float x, float y) throws IOException
image
- The image to draw.x
- The x-coordinate to draw the image.y
- The y-coordinate to draw the image.
IOException
- If there is an error writing to the stream.public void drawXObject(PDXObject xobject, float x, float y, float width, float height) throws IOException
xobject
- The xobject to draw.x
- The x-coordinate to draw the image.y
- The y-coordinate to draw the image.width
- The width of the image to draw.height
- The height of the image to draw.
IOException
- If there is an error writing to the stream.public void drawXObject(PDXObject xobject, AffineTransform transform) throws IOException
AffineTransform
to position
the xobject.
xobject
- The xobject to draw.transform
- the transformation matrix
IOException
- If there is an error writing to the stream.public void moveTextPositionByAmount(float x, float y) throws IOException
x
- The x coordinate.y
- The y coordinate.
IOException
- If there is an error writing to the stream.public void setTextMatrix(double a, double b, double c, double d, double e, double f) throws IOException
a
- The a value of the matrix.b
- The b value of the matrix.c
- The c value of the matrix.d
- The d value of the matrix.e
- The e value of the matrix.f
- The f value of the matrix.
IOException
- If there is an error writing to the stream.public void setTextMatrix(AffineTransform matrix) throws IOException
matrix
- the transformation matrix
IOException
- If there is an error writing to the stream.public void setTextScaling(double sx, double sy, double tx, double ty) throws IOException
sx
- The scaling factor in x-direction.sy
- The scaling factor in y-direction.tx
- The translation value in x-direction.ty
- The translation value in y-direction.
IOException
- If there is an error writing to the stream.public void setTextTranslation(double tx, double ty) throws IOException
tx
- The translation value in x-direction.ty
- The translation value in y-direction.
IOException
- If there is an error writing to the stream.public void setTextRotation(double angle, double tx, double ty) throws IOException
angle
- The angle used for the counterclockwise rotation in radians.tx
- The translation value in x-direction.ty
- The translation value in y-direction.
IOException
- If there is an error writing to the stream.public void concatenate2CTM(double a, double b, double c, double d, double e, double f) throws IOException
a
- The a value of the matrix.b
- The b value of the matrix.c
- The c value of the matrix.d
- The d value of the matrix.e
- The e value of the matrix.f
- The f value of the matrix.
IOException
- If there is an error writing to the stream.public void concatenate2CTM(AffineTransform at) throws IOException
AffineTransform
.
at
- the transformation matrix
IOException
- If there is an error writing to the stream.public void drawString(String text) throws IOException
text
- The text to draw.
IOException
- If an io exception occurs.public void setStrokingColorSpace(PDColorSpace colorSpace) throws IOException
colorSpace
- The colorspace to write.
IOException
- If there is an error writing the colorspace.public void setNonStrokingColorSpace(PDColorSpace colorSpace) throws IOException
colorSpace
- The colorspace to write.
IOException
- If there is an error writing the colorspace.public void setStrokingColor(float[] components) throws IOException
components
- The components to set for the current color.
IOException
- If there is an error while writing to the stream.public void setStrokingColor(Color color) throws IOException
color
- The color to set.
IOException
- If an IO error occurs while writing to the stream.public void setNonStrokingColor(Color color) throws IOException
color
- The color to set.
IOException
- If an IO error occurs while writing to the stream.public void setStrokingColor(int r, int g, int b) throws IOException
r
- The red value.g
- The green value.b
- The blue value.
IOException
- If an IO error occurs while writing to the stream.public void setStrokingColor(int c, int m, int y, int k) throws IOException
c
- The cyan value.m
- The magenta value.y
- The yellow value.k
- The black value.
IOException
- If an IO error occurs while writing to the stream.public void setStrokingColor(double c, double m, double y, double k) throws IOException
c
- The cyan value.m
- The magenta value.y
- The yellow value.k
- The black value.
IOException
- If an IO error occurs while writing to the stream.public void setStrokingColor(int g) throws IOException
g
- The gray value.
IOException
- If an IO error occurs while writing to the stream.public void setStrokingColor(double g) throws IOException
g
- The gray value.
IOException
- If an IO error occurs while writing to the stream.public void setNonStrokingColor(float[] components) throws IOException
components
- The components to set for the current color.
IOException
- If there is an error while writing to the stream.public void setNonStrokingColor(int r, int g, int b) throws IOException
r
- The red value.g
- The green value.b
- The blue value.
IOException
- If an IO error occurs while writing to the stream.public void setNonStrokingColor(int c, int m, int y, int k) throws IOException
c
- The cyan value.m
- The magenta value.y
- The yellow value.k
- The black value.
IOException
- If an IO error occurs while writing to the stream.public void setNonStrokingColor(double c, double m, double y, double k) throws IOException
c
- The cyan value.m
- The magenta value.y
- The yellow value.k
- The black value.
IOException
- If an IO error occurs while writing to the stream.public void setNonStrokingColor(int g) throws IOException
g
- The gray value.
IOException
- If an IO error occurs while writing to the stream.public void setNonStrokingColor(double g) throws IOException
g
- The gray value.
IOException
- If an IO error occurs while writing to the stream.public void addRect(float x, float y, float width, float height) throws IOException
x
- The lower left x coordinate.y
- The lower left y coordinate.width
- The width of the rectangle.height
- The height of the rectangle.
IOException
- If there is an error while drawing on the screen.public void fillRect(float x, float y, float width, float height) throws IOException
x
- The lower left x coordinate.y
- The lower left y coordinate.width
- The width of the rectangle.height
- The height of the rectangle.
IOException
- If there is an error while drawing on the screen.public void addBezier312(float x1, float y1, float x2, float y2, float x3, float y3) throws IOException
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
IOException
- If there is an error while adding the .public void addBezier32(float x2, float y2, float x3, float y3) throws IOException
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
IOException
- If there is an error while adding the .public void addBezier31(float x1, float y1, float x3, float y3) throws IOException
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
IOException
- If there is an error while adding the .public void moveTo(float x, float y) throws IOException
x
- The x coordinate.y
- The y coordinate.
IOException
- If there is an error while adding the line.public void lineTo(float x, float y) throws IOException
x
- The x coordinate.y
- The y coordinate.
IOException
- If there is an error while adding the line.public void addLine(float xStart, float yStart, float xEnd, float yEnd) throws IOException
xStart
- The start x coordinate.yStart
- The start y coordinate.xEnd
- The end x coordinate.yEnd
- The end y coordinate.
IOException
- If there is an error while adding the line.public void drawLine(float xStart, float yStart, float xEnd, float yEnd) throws IOException
xStart
- The start x coordinate.yStart
- The start y coordinate.xEnd
- The end x coordinate.yEnd
- The end y coordinate.
IOException
- If there is an error while drawing on the screen.public void addPolygon(float[] x, float[] y) throws IOException
x
- x coordinate of each pointsy
- y coordinate of each points
IOException
- If there is an error while drawing on the screen.public void drawPolygon(float[] x, float[] y) throws IOException
x
- x coordinate of each pointsy
- y coordinate of each points
IOException
- If there is an error while drawing on the screen.public void fillPolygon(float[] x, float[] y) throws IOException
x
- x coordinate of each pointsy
- y coordinate of each points
IOException
- If there is an error while drawing on the screen.public void stroke() throws IOException
IOException
public void closeAndStroke() throws IOException
IOException
public void fill(int windingRule) throws IOException
IOException
public void closeSubPath() throws IOException
IOException
public void clipPath(int windingRule) throws IOException
IOException
public void setLineWidth(float lineWidth) throws IOException
lineWidth
- The width which is used for drwaing.
IOException
- If there is an error while drawing on the screen.public void beginMarkedContentSequence(COSName tag) throws IOException
tag
- the tag
IOException
- if an I/O error occurspublic void beginMarkedContentSequence(COSName tag, COSName propsName) throws IOException
tag
- the tagpropsName
- the properties reference
IOException
- if an I/O error occurspublic void endMarkedContentSequence() throws IOException
IOException
- if an I/O error occurspublic void saveGraphicsState() throws IOException
IOException
- If an error occurs while writing to the stream.public void restoreGraphicsState() throws IOException
IOException
- If an error occurs while writing to the stream.public void appendRawCommands(String commands) throws IOException
commands
- The commands to append to the stream.
IOException
- If an error occurs while writing to the stream.public void appendRawCommands(byte[] commands) throws IOException
commands
- The commands to append to the stream.
IOException
- If an error occurs while writing to the stream.public void appendRawCommands(int data) throws IOException
data
- Append a raw byte to the stream.
IOException
- If an error occurs while writing to the stream.public void appendCOSName(COSName name) throws IOException
COSName
to the content stream.
name
- the name
IOException
- If an error occurs while writing to the stream.public void close() throws IOException
IOException
- If the underlying stream has a problem being written to.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |