Class PDFFile

java.lang.Object
com.sun.pdfview.PDFFile
public class PDFFile extends Object
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

  • Field Details

  • Constructor Details

    • PDFFile

      public PDFFile(ByteBuffer buf) throws IOException
      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.
      Throws:
      IOException - if there's a problem reading from the buffer
      PDFParseException - if the document appears to be malformed, or its features are unsupported. If the file is encrypted in a manner that the product or platform does not support then the exception's cause will be an instance of UnsupportedEncryptionException.
      PDFAuthenticationFailureException - if the file is password protected and requires a password

    • PDFFile

      public PDFFile(ByteBuffer buf, PDFPassword password) throws IOException
      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.
      password - the user or owner password
      Throws:
      IOException - if there's a problem reading from the buffer
      PDFParseException - if the document appears to be malformed, or its features are unsupported. If the file is encrypted in a manner that the product or platform does not support then the exception's cause will be an instance of UnsupportedEncryptionException.
      PDFAuthenticationFailureException - if the file is password protected and the supplied password does not decrypt the document

  • Method Details

    • isPrintable

      public boolean isPrintable()
      Gets whether the owner of the file has given permission to print the file.
      Returns:
      true if it is okay to print the file

    • isSaveable

      public boolean isSaveable()
      Gets whether the owner of the file has given permission to save a copy of the file.
      Returns:
      true if it is okay to save the file

    • getRoot

      public PDFObject getRoot()
      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.

    • getNumPages

      public int getNumPages()
      return the number of pages in this PDFFile. The pages will be numbered from 1 to getNumPages(), inclusive.

    • getStringMetadata

      public String getStringMetadata(String name) throws IOException
      Get metadata (e.g., Author, Title, Creator) from the Info dictionary as a string.
      Parameters:
      name - the name of the metadata key (e.g., Author)
      Returns:
      the info
      Throws:
      IOException - if the metadata cannot be read

    • getMetadataKeys

      public Iterator<String> getMetadataKeys() throws IOException
      Get the keys into the Info metadata, for use with getStringMetadata(String)
      Returns:
      the keys present into the Info dictionary
      Throws:
      IOException - if the keys cannot be read

    • dereference

      public PDFObject dereference(PDFXref ref, PDFDecrypter decrypter) throws IOException
      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.

      Throws:
      IOException

    • isWhiteSpace

      public static boolean isWhiteSpace(int c)
      Is the argument a white space character according to the PDF spec?. ISO Spec 32000-1:2008 - Table 1

    • isDelimiter

      public static boolean isDelimiter(int c)
      Is the argument a delimiter according to the PDF spec?

      ISO 32000-1:2008 - Table 2

      Parameters:
      c - the character to test

    • isRegularCharacter

      public static boolean isRegularCharacter(int c)
      return true if the character is neither a whitespace or a delimiter.
      Parameters:
      c - the character to test
      Returns:
      boolean

    • getMajorVersion

      public int getMajorVersion()
      return the major version of the PDF header.
      Returns:
      int

    • getMinorVersion

      public int getMinorVersion()
      return the minor version of the PDF header.
      Returns:
      int

    • getVersionString

      public String getVersionString()
      return the version string from the PDF header.
      Returns:
      String

    • getOutline

      public OutlineNode getOutline() throws IOException
      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.
      Throws:
      IOException

    • getPageNumber

      public int getPageNumber(PDFObject page) throws IOException
      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).
      Returns:
      a number between 1 and the number of pages indicating the page number, or 0 if the PDFObject is not in the page tree.
      Throws:
      IOException

    • getPage

      public PDFPage getPage(int pagenum)
      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)
      Get the page commands for a given page.
      Parameters:
      pagenum - the number of the page to get commands for
      wait - if true, do not exit until the page is complete.

    • stop

      public void stop(int pageNum)
      Stop the rendering of a particular image on this page

    • parseRect

      public Rectangle2D.Float parseRect(PDFObject obj) throws IOException
      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 four Numbers.
      Throws:
      IOException

    • getDefaultDecrypter

      public PDFDecrypter getDefaultDecrypter()
      Get the default decrypter for the document
      Returns:
      the default decrypter; never null, even for documents that aren't encrypted