| java.lang.Object
 com.sun.pdfview.PDFFile
| PDFFile | | public class PDFFile (Code) | | An encapsulation of a .pdf file. The methods of this class
can parse the contents of a PDF file, but those methods are
hidden. Instead, the public methods of this class allow
access to the pages in the PDF file. Typically, you create
a new PDFFile, ask it for the number of pages, and then
request one or more PDFPages.
author:
Mike Wessler |
| Constructor Summary | |
| public | PDFFile(ByteBuffer buf)
get a PDFFile from a .pdf file. |
| Method Summary | |
| public synchronized PDFObject | dereference(PDFXref ref)
Used internally to track down PDFObject references. | | public int | getNumPages()
return the number of pages in this PDFFile. | | public OutlineNode | getOutline()
Gets the outline tree as a tree of OutlineNode, which is a subclass
of DefaultMutableTreeNode. | | public PDFPage | getPage(int pagenum)
Get the page commands for a given page in a separate thread. | | public PDFPage | getPage(int pagenum, boolean wait)
Get the page commands for a given page. | | public int | getPageNumber(PDFObject page)
Gets the page number (starting from 1) of the page represented by
a particular PDFObject. | | public PDFObject | getRoot()
get the root PDFObject of this PDFFile. | | public static boolean | isDelimiter(int c)
| | public boolean | isPrintable()
Gets whether the owner of the file has given permission to print
the file. | | public boolean | isSaveable()
Gets whether the owner of the file has given permission to save
a copy of the file. | | public static boolean | isWhiteSpace(int c)
| | public Rectangle2D.Float | parseRect(PDFObject obj)
get a Rectangle2D.Float representation for a PDFObject that is an
array of four Numbers. | | public void | stop(int pageNum)
|
| buf | | ByteBuffer buf(Code) | | A ByteBuffer containing the file data
|
| cache | | Cache cache(Code) | | a mapping of page numbers to parsed PDF commands
|
| objIdx | | PDFXref[] objIdx(Code) | | the cross reference table mapping object numbers to locations
in the PDF file
|
| PDFFile | | public PDFFile(ByteBuffer buf) throws IOException(Code) | | get a PDFFile from a .pdf file. The file must me a random access file
at the moment. It should really be a file mapping from the nio package.
Use the getPage(...) methods to get a page from the PDF file.
Parameters:
buf - the RandomAccessFile containing the PDF. |
| dereference | | public synchronized PDFObject dereference(PDFXref ref) throws IOException(Code) | | Used internally to track down PDFObject references. You should never
need to call this.
Since this is the only public method for tracking down PDF objects,
it is synchronized. This means that the PDFFile can only hunt down
one object at a time, preventing the file's location from getting
messed around.
This call stores the current buffer position before any changes are made
and restores it afterwards, so callers need not know that the position
has changed.
|
| getNumPages | | public int getNumPages()(Code) | | return the number of pages in this PDFFile. The pages will be
numbered from 1 to getNumPages(), inclusive.
|
| getOutline | | public OutlineNode getOutline() throws IOException(Code) | | Gets the outline tree as a tree of OutlineNode, which is a subclass
of DefaultMutableTreeNode. If there is no outline tree, this method
returns null.
|
| getPage | | public PDFPage getPage(int pagenum)(Code) | | Get the page commands for a given page in a separate thread.
Parameters:
pagenum - the number of the page to get commands for |
| getPage | | public PDFPage getPage(int pagenum, boolean wait)(Code) | | Get the page commands for a given page.
Parameters:
pagenum - the number of the page to get commands for
Parameters:
wait - if true, do not exit until the page is complete. |
| getPageNumber | | public int getPageNumber(PDFObject page) throws IOException(Code) | | Gets the page number (starting from 1) of the page represented by
a particular PDFObject. The PDFObject must be a Page dictionary or
a destination description (or an action).
a number between 1 and the number of pages indicating thepage number, or 0 if the PDFObject is not in the page tree. |
| getRoot | | public PDFObject getRoot()(Code) | | get the root PDFObject of this PDFFile. You generally shouldn't need
this, but we've left it open in case you want to go spelunking.
|
| isDelimiter | | public static boolean isDelimiter(int c)(Code) | | Is the argument a delimiter according to the PDF spec?
|
| isPrintable | | public boolean isPrintable()(Code) | | Gets whether the owner of the file has given permission to print
the file.
true if it is okay to print the file |
| isSaveable | | public boolean isSaveable()(Code) | | Gets whether the owner of the file has given permission to save
a copy of the file.
true if it is okay to save the file |
| isWhiteSpace | | public static boolean isWhiteSpace(int c)(Code) | | Is the argument a white space character according to the PDF spec?
|
| parseRect | | public Rectangle2D.Float parseRect(PDFObject obj) throws IOException(Code) | | get a Rectangle2D.Float representation for a PDFObject that is an
array of four Numbers.
Parameters:
obj - a PDFObject that represents an Array of exactly fourNumbers. |
| stop | | public void stop(int pageNum)(Code) | | Stop the rendering of a particular image on this page
|
|
|