Class PDFRenderer
java.lang.Object
com.sun.pdfview.BaseWatchable
com.sun.pdfview.PDFRenderer
This class turns a set of PDF Commands from a PDF page into an image. It
encapsulates the state of drawing in terms of stroke, fill, transform,
etc., as well as pushing and popping these states.
When the run method is called, this class goes through all remaining commands
in the PDF Page and draws them to its buffered image. It then updates any
ImageConsumers with the drawn data.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final float[]static final intstatic final floatstatic final floatstatic final floatstatic final longhow long (in milliseconds) to wait between image updatesFields inherited from interface Watchable
COMPLETED, ERROR, NEEDS_DATA, NOT_STARTED, PAUSED, RUNNING, STOPPED, UNKNOWN -
Constructor Summary
ConstructorsConstructorDescriptionPDFRenderer(PDFPage page, ImageInfo imageinfo, BufferedImage bi) create a new PDFGraphics statePDFRenderer(PDFPage page, Graphics2D g, Rectangle imgbounds, Rectangle2D clip, Color bgColor) create a new PDFGraphics state, given a Graphics2D. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddObserver(ImageObserver observer) Add an image observervoidcleanup()Called when iteration has stoppedvoidclip(GeneralPath s) add the path to the current clip.voiddraw(GeneralPath p, BasicStroke bs) draw an outline.draw an image.fill(GeneralPath s) fill an outline using the current fill paintget the initial transform from page space to Java spaceGet the last shape drawnget the current stroke as a BasicStrokeget the current affinetransformintiterate()Draws the next command in the PDFPage to the buffered image.voidpop()restore the state of this object to what it was when the previous push() was called.voidpush()push the current graphics state onto the stack.voidremoveObserver(ImageObserver observer) Remove an image observervoidsetFillAlpha(float alpha) set the stroke alphavoidsetFillPaint(PDFPaint paint) set the fill colorvoidsetLastShape(GeneralPath shape) Set the last shape drawnvoidsetStroke(BasicStroke bs) set the current stroke as a BasicStrokevoidsetStrokeAlpha(float alpha) set the stroke alphavoidsetStrokePaint(PDFPaint paint) set the stroke colorvoidsetStrokeParts(float w, int cap, int join, float limit, float[] ary, float phase) Set some or all aspects of the current stroke.voidreplace the current transform with the given one.voidsetup()Setup rendering.draw an outline using the current stroke and draw paintvoidconcatenate the given transform with the current transformMethods inherited from class BaseWatchable
execute, getStatus, go, go, go, go, isExecutable, isFinished, isSuppressSetErrorStackTrace, run, setError, setStatus, setSuppressSetErrorStackTrace, stop, waitForFinish
-
Field Details
-
UPDATE_DURATION
public static final long UPDATE_DURATIONhow long (in milliseconds) to wait between image updates- See Also:
-
NOPHASE
public static final float NOPHASE- See Also:
-
NOWIDTH
public static final float NOWIDTH- See Also:
-
NOLIMIT
public static final float NOLIMIT- See Also:
-
NOCAP
public static final int NOCAP- See Also:
-
NODASH
public static final float[] NODASH -
NOJOIN
public static final int NOJOIN- See Also:
-
-
Constructor Details
-
PDFRenderer
create a new PDFGraphics state- Parameters:
page- the current pageimageinfo- the paramters of the image to render
-
PDFRenderer
public PDFRenderer(PDFPage page, Graphics2D g, Rectangle imgbounds, Rectangle2D clip, Color bgColor) create a new PDFGraphics state, given a Graphics2D. This version will not create an image, and you will get a NullPointerException if you attempt to call getImage().- Parameters:
page- the current pageg- the Graphics2D object to use for drawingimgbounds- the bounds of the image into which to fit the pageclip- the portion of the page to draw, in page space, or null if the whole page should be drawnbgColor- the color to draw the background of the image, or null for no color (0 alpha value)
-
-
Method Details
-
push
public void push()push the current graphics state onto the stack. Continue working with the current object; calling pop() restores the state of this object to its state when push() was called. -
pop
public void pop()restore the state of this object to what it was when the previous push() was called. -
stroke
draw an outline using the current stroke and draw paint- Parameters:
s- the path to stroke- Returns:
- a Rectangle2D to which the current region being drawn will be added. May also be null, in which case no dirty region will be recorded.
-
draw
draw an outline.- Parameters:
p- the path to drawbs- the stroke with which to draw the path
-
fill
fill an outline using the current fill paint- Parameters:
s- the path to fill
-
drawImage
-
clip
add the path to the current clip. The new clip will be the intersection of the old clip and given path. -
getTransform
get the current affinetransform -
transform
concatenate the given transform with the current transform -
setTransform
replace the current transform with the given one. -
getInitialTransform
get the initial transform from page space to Java space -
setStrokeParts
public void setStrokeParts(float w, int cap, int join, float limit, float[] ary, float phase) Set some or all aspects of the current stroke.- Parameters:
w- the width of the stroke, or NOWIDTH to leave it unchangedcap- the end cap style, or NOCAP to leave it unchangedjoin- the join style, or NOJOIN to leave it unchangedlimit- the miter limit, or NOLIMIT to leave it unchangedary- the dash array, or null to leave it unchanged. phase and ary must both be valid, or phase must be NOPHASE while ary is null.phase- the phase of the dash array, or NOPHASE to leave it unchanged
-
getStroke
get the current stroke as a BasicStroke -
setStroke
set the current stroke as a BasicStroke -
setStrokePaint
set the stroke color -
setFillPaint
set the fill color -
setStrokeAlpha
public void setStrokeAlpha(float alpha) set the stroke alpha -
setFillAlpha
public void setFillAlpha(float alpha) set the stroke alpha -
addObserver
Add an image observer -
removeObserver
Remove an image observer -
setLastShape
Set the last shape drawn -
getLastShape
Get the last shape drawn -
setup
public void setup()Setup rendering. Called before iteration begins- Overrides:
setupin classBaseWatchable
-
iterate
Draws the next command in the PDFPage to the buffered image. The image will be notified about changes no less than every UPDATE_DURATION milliseconds.- Specified by:
iteratein classBaseWatchable- Returns:
- Watchable.RUNNING when there are commands to be processed
- Watchable.NEEDS_DATA when there are no commands to be processed, but the page is not yet complete
- Watchable.COMPLETED when the page is done and all the commands have been processed
- Watchable.STOPPED if the image we are rendering into has gone away
- Throws:
Exception
-
cleanup
-