| java.lang.Object
 com.sun.pdfview.PDFPage
| PDFPage | | public class PDFPage (Code) | | 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.
author:
Mike Wessler |
| Constructor Summary | |
| public | PDFPage(Rectangle2D bbox, int rotation)
create a PDFPage with dimensions in bbox and rotation. | | public | PDFPage(int pageNumber, Rectangle2D bbox, int rotation, Cache cache)
create a PDFPage with dimensions in bbox and rotation. |
| Method Summary | |
| public void | addCommand(PDFCmd cmd)
Add a single command to the page list. | | public void | addCommands(PDFPage page)
add a collection of commands to the page list. | | public void | addCommands(PDFPage page, AffineTransform extra)
add a collection of commands to the page list. | | public void | addDash(float[] dashary, float phase)
| | public void | addEndCap(int capstyle)
| | public void | addFillAlpha(float a)
| | public void | addFillPaint(PDFPaint p)
| | public void | addImage(PDFImage image)
| | public void | addLineJoin(int joinstyle)
| | public void | addMiterLimit(float limit)
| | public void | addPath(GeneralPath path, int style)
| | public void | addPop()
| | public void | addPush()
| | public void | addStrokeAlpha(float a)
| | public void | addStrokePaint(PDFPaint p)
| | public void | addStrokeWidth(float w)
| | public void | addXform(AffineTransform at)
| | public void | clearCommands()
| | public synchronized void | finish()
The entire page is done. | | public float | getAspectRatio()
get the aspect ratio of the correctly oriented page. | | public Rectangle2D | getBBox()
get the bounding box of the page, before any rotation. | | public PDFCmd | getCommand(int index)
| | public int | getCommandCount()
| | public List | getCommands()
| | public List | getCommands(int startIndex)
| | public List | getCommands(int startIndex, int endIndex)
| | public float | getHeight()
| | public Image | getImage(int width, int height, Rectangle2D clip, ImageObserver observer)
Get an image producer which can be used to draw the image
represented by this PDFPage. | | 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. | | public AffineTransform | getInitialTransform(int width, int height, Rectangle2D clip)
| | public int | getPageNumber()
| | public int | getRotation()
| | public Dimension | getUnstretchedSize(int width, int height, Rectangle2D clip)
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. | | public float | getWidth()
| | public boolean | isFinished()
get whether parsing for this PDFPage has been completed and all
commands are in place. | | public void | stop(int width, int height, Rectangle2D clip)
| | public void | updateImages()
| | public synchronized void | waitForFinish()
|
| PDFPage | | public PDFPage(Rectangle2D bbox, int rotation)(Code) | | create a PDFPage with dimensions in bbox and rotation.
|
| PDFPage | | public PDFPage(int pageNumber, Rectangle2D bbox, int rotation, Cache cache)(Code) | | create a PDFPage with dimensions in bbox and rotation.
|
| addCommand | | public void addCommand(PDFCmd cmd)(Code) | | Add a single command to the page list.
|
| addCommands | | public void addCommands(PDFPage page)(Code) | | 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 | | public void addCommands(PDFPage page, AffineTransform extra)(Code) | | 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.
Parameters:
extra - a transform to perform before adding the commands.If null, no extra transform will be added. |
| addDash | | public void addDash(float[] dashary, float phase)(Code) | | set the dash style
Parameters:
dashary - the array of on-off lengths
Parameters:
phase - offset of the array at the start of the line drawing |
| addEndCap | | public void addEndCap(int capstyle)(Code) | | set the end cap style
Parameters:
capstyle - the cap style: 0 = BUTT, 1 = ROUND, 2 = SQUARE |
| addFillAlpha | | public void addFillAlpha(float a)(Code) | | set the fill alpha
|
| addFillPaint | | public void addFillPaint(PDFPaint p)(Code) | | set the fill paint
|
| addImage | | public void addImage(PDFImage image)(Code) | | draw an image
Parameters:
image - the image to draw |
| addLineJoin | | public void addLineJoin(int joinstyle)(Code) | | set the line join style
Parameters:
joinstyle - the join style: 0 = MITER, 1 = ROUND, 2 = BEVEL |
| addMiterLimit | | public void addMiterLimit(float limit)(Code) | | set the miter limit
|
| addPath | | public void addPath(GeneralPath path, int style)(Code) | | set the current path
Parameters:
path - the path
Parameters:
style - the style: PDFShapeCmd.STROKE, PDFShapeCmd.FILL,PDFShapeCmd.BOTH, PDFShapeCmd.CLIP, or some combination. |
| addPop | | public void addPop()(Code) | | pop the graphics state
|
| addPush | | public void addPush()(Code) | | push the graphics state
|
| addStrokeAlpha | | public void addStrokeAlpha(float a)(Code) | | set the stroke alpha
|
| addStrokePaint | | public void addStrokePaint(PDFPaint p)(Code) | | set the stroke paint
|
| addStrokeWidth | | public void addStrokeWidth(float w)(Code) | | set the stroke width
Parameters:
w - the width of the stroke |
| clearCommands | | public void clearCommands()(Code) | | Clear all commands off the current page
|
| finish | | public synchronized void finish()(Code) | | The entire page is done. This must only be invoked once. All
observers will be notified.
|
| getAspectRatio | | public float getAspectRatio()(Code) | | get the aspect ratio of the correctly oriented page.
the width/height aspect ratio of the page |
| getBBox | | public Rectangle2D getBBox()(Code) | | get the bounding box of the page, before any rotation.
|
| getCommand | | public PDFCmd getCommand(int index)(Code) | | get the command at a given index
|
| getCommandCount | | public int getCommandCount()(Code) | | get the current number of commands for this page
|
| getCommands | | public List getCommands()(Code) | | get all the commands in the current page
|
| getCommands | | public List getCommands(int startIndex)(Code) | | get all the commands in the current page starting at the given index
|
| getCommands | | public List getCommands(int startIndex, int endIndex)(Code) | | |
| getHeight | | public float getHeight()(Code) | | get the height of this page, after rotation
|
| getImage | | public Image getImage(int width, int height, Rectangle2D clip, ImageObserver observer)(Code) | | 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 produced
Parameters:
height - the height of the image to be produced
Parameters:
clip - the region in page space of the entire page todisplay
Parameters:
observer - an image observer who will be notified when theimage changes, or null an Image that contains the PDF data |
| getImage | | public Image getImage(int width, int height, Rectangle2D clip, ImageObserver observer, boolean drawbg, boolean wait)(Code) | | 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 produced
Parameters:
height - the height of the image to be produced
Parameters:
clip - the region in page space of the entire page todisplay
Parameters:
observer - an image observer who will be notified when theimage changes, or null
Parameters:
drawbg - if true, put a white background on the image. If not,draw no color (alpha 0) for the background.
Parameters:
wait - if true, do not return until this image is fully rendered. an Image that contains the PDF data |
| getInitialTransform | | public AffineTransform getInitialTransform(int width, int height, Rectangle2D clip)(Code) | | 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 image
Parameters:
height - the height of the image
Parameters:
clip - the desired clip rectangle (in PDF space) or null to usethe page's bounding box |
| getPageNumber | | public int getPageNumber()(Code) | | get the page number used to lookup this page
the page number |
| getRotation | | public int getRotation()(Code) | | get the rotation of this image
|
| getUnstretchedSize | | public Dimension getUnstretchedSize(int width, int height, Rectangle2D clip)(Code) | | 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 image
Parameters:
height - the maximum height of the image
Parameters:
clip - the region in page space of the page todisplay. It may be null, in which the page's defined crop boxwill be used. |
| getWidth | | public float getWidth()(Code) | | get the width of this page, after rotation
|
| isFinished | | public boolean isFinished()(Code) | | get whether parsing for this PDFPage has been completed and all
commands are in place.
|
| stop | | public void stop(int width, int height, Rectangle2D clip)(Code) | | Stop the rendering of a particular image on this page
|
| updateImages | | public void updateImages()(Code) | | Notify all images we know about that a command has been added
|
|
|