Package com.sun.pdfview
Class PDFPage
java.lang.Object
com.sun.pdfview.PDFPage
A PDFPage encapsulates the parsed commands required to render a
single page from a PDFFile. The PDFPage is not itself drawable;
instead, create a PDFImage to display something on the screen.
This file also contains all of the PDFCmd commands that might be a part of the command stream in a PDFPage. They probably should be inner classes of PDFPage instead of separate non-public classes.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Rectangle2D
the bounding box of the page, in page coordinatesprivate Cache
a map from image info (width, height, clip) to a soft reference to the rendered imagethe array of commands.private boolean
whether this page has been finished.private int
the page number used to find this pageprivate Map
<ImageInfo, WeakReference> a map from image info to weak references to parsers that are activeprivate int
the rotation of this page, in degrees -
Constructor Summary
ConstructorsConstructorDescriptionPDFPage
(int pageNumber, Rectangle2D bbox, int rotation, Cache cache) create a PDFPage with dimensions in bbox and rotation.PDFPage
(Rectangle2D bbox, int rotation) create a PDFPage with dimensions in bbox and rotation. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCommand
(PDFCmd cmd) Add a single command to the page list.void
addCommands
(PDFPage page) add a collection of commands to the page list.void
addCommands
(PDFPage page, AffineTransform extra) add a collection of commands to the page list.void
addDash
(float[] dashary, float phase) set the dash stylevoid
addEndCap
(int capstyle) set the end cap stylevoid
addFillAlpha
(float a) set the fill alphavoid
set the fill paintvoid
draw an imagevoid
addLineJoin
(int joinstyle) set the line join stylevoid
addMiterLimit
(float limit) set the miter limitvoid
addPath
(GeneralPath path, int style) set the current pathvoid
addPop()
pop the graphics statevoid
addPush()
push the graphics statevoid
addStrokeAlpha
(float a) set the stroke alphavoid
set the stroke paintvoid
addStrokeWidth
(float w) set the stroke widthvoid
concatenate a transform to the graphics statevoid
Clear all commands off the current pagevoid
finish()
The entire page is done.float
get the aspect ratio of the correctly oriented page.getBBox()
get the bounding box of the page, before any rotation.getCommand
(int index) get the command at a given indexint
get the current number of commands for this pageget all the commands in the current pagegetCommands
(int startIndex) get all the commands in the current page starting at the given indexgetCommands
(int startIndex, int endIndex) float
get the height of this page, after rotationgetImage
(int width, int height, Rectangle2D clip, ImageObserver observer) Get an image producer which can be used to draw the image represented by this PDFPage.getImage
(int width, int height, Rectangle2D clip, ImageObserver observer, boolean drawbg, boolean wait) Get an image producer which can be used to draw the image represented by this PDFPage.getInitialTransform
(int width, int height, Rectangle2D clip) Get the initial transform to map from a specified clip rectangle in pdf coordinates to an image of the specfied width and height in device coordinatesint
get the page number used to lookup this pageint
get the rotation of this imagegetUnstretchedSize
(int width, int height, Rectangle2D clip) Get the width and height of this image in the correct aspect ratio.float
getWidth()
get the width of this page, after rotationboolean
get whether parsing for this PDFPage has been completed and all commands are in place.void
stop
(int width, int height, Rectangle2D clip) Stop the rendering of a particular image on this pagevoid
Notify all images we know about that a command has been addedvoid
wait for finish
-
Field Details
-
commands
the array of commands. The length of this array will always be greater than or equal to the actual number of commands. -
finished
private boolean finishedwhether this page has been finished. If true, there will be no more commands added to the cmds list. -
pageNumber
private int pageNumberthe page number used to find this page -
bbox
the bounding box of the page, in page coordinates -
rotation
private int rotationthe rotation of this page, in degrees -
cache
a map from image info (width, height, clip) to a soft reference to the rendered image -
renderers
a map from image info to weak references to parsers that are active
-
-
Constructor Details
-
PDFPage
create a PDFPage with dimensions in bbox and rotation. -
PDFPage
create a PDFPage with dimensions in bbox and rotation.
-
-
Method Details
-
getUnstretchedSize
Get the width and height of this image in the correct aspect ratio. The image returned will have at least one of the width and height values identical to those requested. The other dimension may be smaller, so as to keep the aspect ratio the same as in the original page.- Parameters:
width
- the maximum width of the imageheight
- the maximum height of the imageclip
- the region in page space of the page to display. It may be null, in which the page's defined crop box will be used.
-
getImage
Get an image producer which can be used to draw the image represented by this PDFPage. The ImageProducer is guaranteed to stay in sync with the PDFPage as commands are added to it. The image will contain the section of the page specified by the clip, scaled to fit in the area given by width and height.- Parameters:
width
- the width of the image to be producedheight
- the height of the image to be producedclip
- the region in page space of the entire page to displayobserver
- an image observer who will be notified when the image changes, or null- Returns:
- an Image that contains the PDF data
-
getImage
public Image getImage(int width, int height, Rectangle2D clip, ImageObserver observer, boolean drawbg, boolean wait) Get an image producer which can be used to draw the image represented by this PDFPage. The ImageProducer is guaranteed to stay in sync with the PDFPage as commands are added to it. The image will contain the section of the page specified by the clip, scaled to fit in the area given by width and height.- Parameters:
width
- the width of the image to be producedheight
- the height of the image to be producedclip
- the region in page space of the entire page to displayobserver
- an image observer who will be notified when the image changes, or nulldrawbg
- if true, put a white background on the image. If not, draw no color (alpha 0) for the background.wait
- if true, do not return until this image is fully rendered.- Returns:
- an Image that contains the PDF data
-
getPageNumber
public int getPageNumber()get the page number used to lookup this page- Returns:
- the page number
-
getAspectRatio
public float getAspectRatio()get the aspect ratio of the correctly oriented page.- Returns:
- the width/height aspect ratio of the page
-
getBBox
get the bounding box of the page, before any rotation. -
getWidth
public float getWidth()get the width of this page, after rotation -
getHeight
public float getHeight()get the height of this page, after rotation -
getRotation
public int getRotation()get the rotation of this image -
getInitialTransform
Get the initial transform to map from a specified clip rectangle in pdf coordinates to an image of the specfied width and height in device coordinates- Parameters:
width
- the width of the imageheight
- the height of the imageclip
- the desired clip rectangle (in PDF space) or null to use the page's bounding box
-
getCommandCount
public int getCommandCount()get the current number of commands for this page -
getCommand
get the command at a given index -
getCommands
get all the commands in the current page -
getCommands
get all the commands in the current page starting at the given index -
getCommands
-
addCommand
Add a single command to the page list. -
addCommands
add a collection of commands to the page list. This is probably invoked as the result of an XObject 'do' command, or through a type 3 font. -
addCommands
add a collection of commands to the page list. This is probably invoked as the result of an XObject 'do' command, or through a type 3 font.- Parameters:
page
- the source of other commands. It MUST be finished.extra
- a transform to perform before adding the commands. If null, no extra transform will be added.
-
clearCommands
public void clearCommands()Clear all commands off the current page -
isFinished
public boolean isFinished()get whether parsing for this PDFPage has been completed and all commands are in place. -
waitForFinish
wait for finish- Throws:
InterruptedException
-
stop
Stop the rendering of a particular image on this page -
finish
public void finish()The entire page is done. This must only be invoked once. All observers will be notified. -
addPush
public void addPush()push the graphics state -
addPop
public void addPop()pop the graphics state -
addXform
concatenate a transform to the graphics state -
addStrokeWidth
public void addStrokeWidth(float w) set the stroke width- Parameters:
w
- the width of the stroke
-
addEndCap
public void addEndCap(int capstyle) set the end cap style- Parameters:
capstyle
- the cap style: 0 = BUTT, 1 = ROUND, 2 = SQUARE
-
addLineJoin
public void addLineJoin(int joinstyle) set the line join style- Parameters:
joinstyle
- the join style: 0 = MITER, 1 = ROUND, 2 = BEVEL
-
addMiterLimit
public void addMiterLimit(float limit) set the miter limit -
addDash
public void addDash(float[] dashary, float phase) set the dash style- Parameters:
dashary
- the array of on-off lengthsphase
- offset of the array at the start of the line drawing
-
addPath
set the current path- Parameters:
path
- the pathstyle
- the style: PDFShapeCmd.STROKE, PDFShapeCmd.FILL, PDFShapeCmd.BOTH, PDFShapeCmd.CLIP, or some combination.
-
addFillPaint
set the fill paint -
addStrokePaint
set the stroke paint -
addFillAlpha
public void addFillAlpha(float a) set the fill alpha -
addStrokeAlpha
public void addStrokeAlpha(float a) set the stroke alpha -
addImage
draw an image- Parameters:
image
- the image to draw
-
updateImages
public void updateImages()Notify all images we know about that a command has been added
-