PDFImages (Qoppa jPDFProcess API)

java.lang.Object
- com.qoppa.pdfImages.PDFImages

```
public class PDFImages
extends Object
```
The PDFImages class provides methods to load PDF documents and export or import images from and to the document. The object can export pages or sections of pages as images and can also create new pages from images. Documents can be loaded from the file system, from a URL or from a Java InputStream, or can be created from scratch.

The class can import and export the images using the file system or an output stream in JPEG, TIFF and PNG formats and can also return a BufferedImage object to the calling application.

Author:

Qoppa Software

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PDFImages.KeyInfoImages` This is the Main-Class for the jPDFImages.jar that can generate server key requests, validate a key, and display server information.

Constructor Summary

Constructors
Constructor and Description
`PDFImages()` Creates a blank PDFImages object.
`PDFImages(InputStream inStream, IPassword password)` Loads a PDF document from an InputStream.
`PDFImages(PDFSource source, IPassword password)` Loads a PDF document from a PDFSource object.
`PDFImages(String fileName, IPassword password)` Loads a PDF document from a file.
`PDFImages(URL url, IPassword password)` Loads a PDF document from a URL.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendGIFAsPage(InputStream inStream, int dpi)` Creates a new page in the PDF document and adds the GIF image to it.
`void`	`appendGIFAsPage(String gifFileName, int dpi)` Creates a new page in the PDF document and adds the GIF image to it.
`void`	`appendJPEGAsPage(InputStream inStream)` Creates a new page in the PDF document and adds the JPEG image to it.
`void`	`appendJPEGAsPage(String jpegFileName)` Creates a new page in the PDF document and adds the JPEG file to it.
`void`	`appendJPEGAsPage(String jpegFileName, int dpi)` Creates a new page in the PDF document and adds the JPEG file to it.
`void`	`appendPNGAsPage(InputStream inStream)` Creates a new page in the PDF document adds the PNG content to it.
`void`	`appendPNGAsPage(String pngFileName)` Creates a new page in the PDF document and adds the PNG file to it.
`void`	`appendTIFFAsPages(InputStream inStream)` Appends the pages in a TIFF image from an input stream to the end of this document.
`void`	`appendTIFFAsPages(String tiffFileName)` Appends the pages in a TIFF file to the end of this document.
`void`	`close()` Close / release all resources held by this document.
`Rectangle2D`	`getCropBox(int pageIndex)` Returns the PDF page's 'CropBox'.
`double`	`getDisplayHeight(int pageIndex)` Returns the display height of this page in 72 DPI.
`double`	`getDisplayWidth(int pageIndex)` Returns the display width of this page in 72 DPI.
`DocumentInfo`	`getDocumentInfo()` Returns a DocumentInfo object containing the information section of a PDF document (author, title, etc.)
`Rectangle2D`	`getMediaBox(int pageIndex)` Returns the PDF page's 'MediaBox'.
`int`	`getPageCount()` Returns the number of pages in this document.
`BufferedImage`	`getPageImage(int pageIndex, int resDPI)` Returns an RGB BufferedImage containing a rendering of the page at the given resolution in DPI.
`BufferedImage`	`getPageImage(int pageIndex, int width, int height)` Returns an RGB BufferedImage containing a rendering of the page at the given page size.
`BufferedImage`	`getPageImageCS(int pageIndex, int dpi, ColorSpace imageCS)` Returns a BufferedImage, created in the given color space, containing a rendering of the page at the given resolution in DPI.
`BufferedImage`	`getPageImageCS(int pageIndex, int dpi, ColorSpace imageCS, boolean simOverprint)` Returns a BufferedImage, created in the given color space, containing a rendering of the page at the given resolution in DPI.
`int`	`getPageRotation(int pageIndex)` Returns a page's rotation value, in degrees.
`BufferedImage`	`getPageSubImage(int pageIndex, Rectangle2D pageArea, int dpi)` Returns a BufferedImage containing a rendering of part of the page at a given scale.
`double`	`getPaperHeight(int pageIndex)` Returns the paper's height of this page in 72 DPI.
`double`	`getPaperWidth(int pageIndex)` Returns the paper's width of this page in 72 DPI.
`static String`	`getVersion()` Returns version string for jPDFImages.
`IWatermark`	`getWatermark()` Returns the watermark for the PDFImages document.
`static void`	`loadLicense(InputStream licenseStream)` Method to load a license file from an inputstream.
`static void`	`loadLicense(String licenseFile)` Method to load a license file.
`void`	`saveDocument(OutputStream outStream)` Saves this document to an output stream.
`void`	`saveDocument(String fileName)` Saves this document to a file.
`void`	`saveDocumentAsTIFF(OutputStream outStream, TIFFOptions options)` Save the entire document as a multi-page TIFF image to an OutputStream.
`void`	`saveDocumentAsTIFF(String fileName, double resDPI, String tiffCompression)` Save the entire document as a multi-page TIFF image to the given file.
`void`	`saveDocumentAsTIFF(String fileName, TIFFOptions options)` Save the entire document as a multi-page TIFF image to the given file.
`void`	`savePageAsGIF(int pageIndex, String fileName, int dpi)` Save the rendered image of the page to the given OutputStream in GIF format.
`void`	`savePageAsJPEG(int pageIndex, OutputStream outStream, int resDPI, float quality)` Save the rendered image of the page to the given OutputStream in JPEG format.
`void`	`savePageAsJPEG(int pageIndex, String fileName, int resDPI, float quality)` Save the rendered image of the page to the given file in JPEG format.
`void`	`savePageAsJPEG2000(int pageIndex, String fileName, JPEG2000Options options)` Render a page to an image and save it in JPEG 2000 format.
`void`	`savePageAsPNG(int pageIndex, OutputStream outStream, int dpi)` Save the rendered image of the page to the given OutputStream in PNG format.
`void`	`savePageAsPNG(int pageIndex, String fileName, int dpi)` Save the rendered image of the page to the given OutputStream in PNG format.
`void`	`savePageAsTIFF(int pageIndex, OutputStream outStream, TIFFOptions options)` Render a page to an image and save it in TIFF format.
`void`	`savePageAsTIFF(int pageIndex, String fileName, TIFFOptions options)` Render a page to an image and save it in TIFF format.
`static boolean`	`setAppletKey(String key, Applet applet)` Method to unlock the production version of the library.
`static boolean`	`setKey(String key)` Method to unlock the production version of the library.
`void`	`setWatermark(IWatermark watermark)` Sets the watermark on the PDFImages document.
`boolean`	`usePermissionsPassword(String ownerPassword)` Tells the PDFImages object that the permissions password is known, so all permissions are granted.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PDFImages
```
public PDFImages()
          throws PDFException
```
    Creates a blank PDFImages object. This constructor can be used to create a new document entirely from images.
    
    Throws:
    
    PDFException
  - PDFImages
```
public PDFImages(String fileName,
                 IPassword password)
          throws PDFException
```
    Loads a PDF document from a file.
    
    Parameters:
    
    fileName - Name of the PDF file.
    
    password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.
    
    Throws:
    
    PDFException
  - PDFImages
```
public PDFImages(InputStream inStream,
                 IPassword password)
          throws PDFException
```
    Loads a PDF document from an InputStream.
    
    Parameters:
    
    inStream - InputStream to read the PDF document.
    
    password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.
    
    Throws:
    
    PDFException
  - PDFImages
```
public PDFImages(URL url,
                 IPassword password)
          throws PDFException
```
    Loads a PDF document from a URL.
    
    Parameters:
    
    url - Location of the PDF document.
    
    password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.
    
    Throws:
    
    PDFException
  - PDFImages
```
public PDFImages(PDFSource source,
                 IPassword password)
          throws PDFException
```
    Loads a PDF document from a PDFSource object. Implementations of PDFSource can be found in the com.qoppa.pdf.source package or can be implemented by the host application for custom PDF sources.
    
    Parameters:
    
    source - Source of the PDF document.
    
    password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.
    
    Throws:
    
    PDFException
- Method Detail
  - close
```
public void close()
```
    Close / release all resources held by this document. After this method is called, this object becomes invalid and should not be used anymore.
  - getDocumentInfo
```
public DocumentInfo getDocumentInfo()
```
    Returns a DocumentInfo object containing the information section of a PDF document (author, title, etc.)
    
    Returns:
    
    DocumentInfo Object containing header information for the document.
  - setKey
```
public static boolean setKey(String key)
```
    Method to unlock the production version of the library.
    
    Parameters:
    
    key - Production key.
  - loadLicense
```
public static void loadLicense(InputStream licenseStream)
                        throws LicenseException
```
    Method to load a license file from an inputstream. This is useful when the license file is placed in the classpath of the host application and an input stream can be opened to it as a resource.
    
    Parameters:
    
    licenseStream - The input stream for the license file contents.
    
    Throws:
    
    LicenseException - If there are any problems with the license file
  - loadLicense
```
public static void loadLicense(String licenseFile)
                        throws LicenseException,
                               IOException
```
    Method to load a license file.
    
    Parameters:
    
    licenseFile - The full path to the license file.
    
    Throws:
    
    LicenseException - If there are any problems with the license file
    
    IOException
  - setAppletKey
```
public static boolean setAppletKey(String key,
                                   Applet applet)
```
    Method to unlock the production version of the library.
    
    Parameters:
    
    key - Production key.
  - getVersion
```
public static String getVersion()
```
    Returns version string for jPDFImages. If this is the demo version, the return string will contain 'Demo Version' at the end.
  - getPageImage
```
public BufferedImage getPageImage(int pageIndex,
                                  int resDPI)
                           throws PDFException
```
    Returns an RGB BufferedImage containing a rendering of the page at the given resolution in DPI.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    resDPI - Dots per inch at which to render the image. 72 is the PDF native DPI and 100% scale
    
    Returns:
    
    A BufferedImage object of the page at the requested DPI..
    
    Throws:
    
    PDFException
  - getPageImageCS
```
public BufferedImage getPageImageCS(int pageIndex,
                                    int dpi,
                                    ColorSpace imageCS)
                             throws PDFException
```
    Returns a BufferedImage, created in the given color space, containing a rendering of the page at the given resolution in DPI. Note that this method will render content directly onto the image in the image's color space, not render in RGB and then convert. This method can be used to preview output to devices that have a specific color spaces, such as printers.
    
    Parameters:
    
    dpi - Dots per inch at which to render the image.
    
    imageCS - The color space to use when creating the image.
    
    Returns:
    
    A BufferedImage object of the page at the requested DPI.
    
    Throws:
    
    PDFException
  - getPageImageCS
```
public BufferedImage getPageImageCS(int pageIndex,
                                    int dpi,
                                    ColorSpace imageCS,
                                    boolean simOverprint)
                             throws PDFException
```
    Returns a BufferedImage, created in the given color space, containing a rendering of the page at the given resolution in DPI. Note that this method will render content directly onto the image in the image's color space, not render in RGB and then convert. This method can be used to preview output to devices that have a specific color spaces, such as printers.
    
    Parameters:
    
    dpi - Dots per inch at which to render the image.
    
    imageCS - The color space to use when creating the image.
    
    simOverprint - Boolean flag indicating whether the rendering should simulate overprint
    
    Returns:
    
    A BufferedImage object of the page at the requested DPI.
    
    Throws:
    
    PDFException
  - getPageImage
```
public BufferedImage getPageImage(int pageIndex,
                                  int width,
                                  int height)
                           throws PDFException
```
    Returns an RGB BufferedImage containing a rendering of the page at the given page size. Use this method when the size of the output image is fixed.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    width - The width of the desired image, in pixels
    
    height - The height of the desired image, in pixels
    
    Throws:
    
    PDFException
  - getPageSubImage
```
public BufferedImage getPageSubImage(int pageIndex,
                                     Rectangle2D pageArea,
                                     int dpi)
                              throws PDFException
```
    Returns a BufferedImage containing a rendering of part of the page at a given scale.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    pageArea - Rectangle of the area from which the image should be created. This rectangle should be in the page coordinate system, which is at 72 DPI.
    
    dpi - Dots per inch at which to render the image. 72 is the PDF native DPI and 100% scale.
    
    Returns:
    
    A BufferedImage object of a section of the page.
    
    Throws:
    
    PDFException
  - getPaperHeight
```
public double getPaperHeight(int pageIndex)
```
    Returns the paper's height of this page in 72 DPI. This values comes from the page's MediaBox.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    Returns:
    
    double Height of this page
  - getPaperWidth
```
public double getPaperWidth(int pageIndex)
```
    Returns the paper's width of this page in 72 DPI. This values comes from the page's MediaBox.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    Returns:
    
    double Width of this page
  - getMediaBox
```
public Rectangle2D getMediaBox(int pageIndex)
```
    Returns the PDF page's 'MediaBox'. The MediaBox is a rectangle that defines the size of the Media that this page was designed for, this roughly corresponds to the paper size when printing.
    
    Returns:
    
    Rectangle2D This page's MediaBox
  - getCropBox
```
public Rectangle2D getCropBox(int pageIndex)
```
    Returns the PDF page's 'CropBox'. The CropBox is a rectangle that is used to crop content before displaying or printing the page. This rectangle is in PDF native coordinates starting at the bottom left and increasing up to the right.
    
    Returns:
    
    Rectangle2D This page's CropBox
  - getDisplayHeight
```
public double getDisplayHeight(int pageIndex)
```
    Returns the display height of this page in 72 DPI. This value comes from the page's CropBox
    
    Returns:
    
    double Width of this page
  - getDisplayWidth
```
public double getDisplayWidth(int pageIndex)
```
    Returns the display width of this page in 72 DPI. This value comes from the pages CropBox
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    Returns:
    
    double Width of this page
  - getPageCount
```
public int getPageCount()
```
    Returns the number of pages in this document.
  - getPageRotation
```
public int getPageRotation(int pageIndex)
```
    Returns a page's rotation value, in degrees.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    Returns:
    
    the rotation of a page in degrees.
  - savePageAsPNG
```
public void savePageAsPNG(int pageIndex,
                          OutputStream outStream,
                          int dpi)
                   throws IOException,
                          PDFException
```
    Save the rendered image of the page to the given OutputStream in PNG format.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    outStream - The stream to save the image to.
    
    dpi - Dots per inch at which to render the image. 72 is the native PDF resolution and is equivalent to 100% scale.
    
    Throws:
    
    IOException
    
    PDFException
  - savePageAsPNG
```
public void savePageAsPNG(int pageIndex,
                          String fileName,
                          int dpi)
                   throws IOException,
                          PDFException
```
    Save the rendered image of the page to the given OutputStream in PNG format.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    fileName - The name of the PNG file.
    
    dpi - Dots per inch at which to render the image. 72 is the native PDF resolution and is equivalent to 100% scale.
    
    Throws:
    
    IOException
    
    PDFException
  - savePageAsGIF
```
public void savePageAsGIF(int pageIndex,
                          String fileName,
                          int dpi)
                   throws IOException,
                          PDFException
```
    Save the rendered image of the page to the given OutputStream in GIF format.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    fileName - The name of the PNG file.
    
    dpi - Dots per inch at which to render the image. 72 is the native PDF resolution and is equivalent to 100% scale.
    
    Throws:
    
    IOException
    
    PDFException
  - savePageAsJPEG
```
public void savePageAsJPEG(int pageIndex,
                           OutputStream outStream,
                           int resDPI,
                           float quality)
                    throws IOException,
                           PDFException
```
    Save the rendered image of the page to the given OutputStream in JPEG format.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    outStream - The stream to save the image to.
    
    resDPI - Dots per inch at which to render the image. 72 is the native PDF resolution and is equivalent to 100% scale.
    
    quality - The quality setting to use for JPEG compression. The range for this value is 0.0 to 1.0. Lower values mean higher compression and lower quality. As a guideline, 0.25 is low quality, 0.5 is medium quality and 0.75 is high quality.
    
    Throws:
    
    IOException
    
    PDFException
  - savePageAsJPEG
```
public void savePageAsJPEG(int pageIndex,
                           String fileName,
                           int resDPI,
                           float quality)
                    throws IOException,
                           PDFException
```
    Save the rendered image of the page to the given file in JPEG format.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    fileName - The name of the file to save to.
    
    resDPI - Dots per inch at which to render the image. 72 is the native PDF resolution and is equivalent to 100% scale.
    
    quality - The quality setting to use for JPEG compression. The range for this value is 0.0 to 1.0. Lower values mean higher compression and lower quality. As a guideline, 0.25 is low quality, 0.5 is medium quality and 0.75 is high quality.
    
    Throws:
    
    IOException
    
    PDFException
  - savePageAsTIFF
```
public void savePageAsTIFF(int pageIndex,
                           String fileName,
                           TIFFOptions options)
                    throws IOException,
                           PDFException
```
    Render a page to an image and save it in TIFF format. If the TIFF compression is one of the fax compressions, the image will be converted to black and white automatically.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    fileName - The name of the file to save the image to.
    
    options - Options to use when saving the image, such as the TIFF compression type.
    
    Throws:
    
    IOException
    
    PDFException
  - savePageAsJPEG2000
```
public void savePageAsJPEG2000(int pageIndex,
                               String fileName,
                               JPEG2000Options options)
                        throws IOException,
                               PDFException
```
    Render a page to an image and save it in JPEG 2000 format. Options are available to save the image in J2K or JP2 format, RGB or grayscale and to set the compression quality.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    fileName - The name of the file to save the image to.
    
    options - Options to use when saving the image.
    
    Throws:
    
    IOException
    
    PDFException
  - savePageAsTIFF
```
public void savePageAsTIFF(int pageIndex,
                           OutputStream outStream,
                           TIFFOptions options)
                    throws IOException,
                           PDFException
```
    Render a page to an image and save it in TIFF format. If the TIFF compression is one of the fax compressions, the image will be converted to black and white automatically.
    
    Parameters:
    
    pageIndex - The 0 based page index.
    
    outStream - The output stream to write the image to.
    
    options - Options to use when saving the image, such as the TIFF compression type.
    
    Throws:
    
    IOException
    
    PDFException
  - saveDocumentAsTIFF
```
public void saveDocumentAsTIFF(String fileName,
                               double resDPI,
                               String tiffCompression)
                        throws PDFException,
                               IOException
```
    Save the entire document as a multi-page TIFF image to the given file. resDPI is the resolution in DPI used to render the page, 72 is the native PDF resolution and is equivalent to 100% scale.
    
    Parameters:
    
    fileName - The name of the file to write the TIFF image to.
    
    resDPI - Dots per inch at which to render the image, 72 is the native PDF resolution and is equivalent to 100% scale..
    
    tiffCompression - The type of TIFF compression to use. This value needs to be one of these predefined values:
    
    TIFFOptions.TIFF_DEFLATE - Deflate lossless compression (Zip-in-TIFF)
    TIFFOptions.TIFF_CCITT_RLE - CCITT Modified Huffman RLE
    TIFFOptions.TIFF_FAX_GROUP3 - CCITT Group 3 fax encoding
    TIFFOptions.TIFF_FAX_GROUP4 - CCITT Group 4 fax encoding
    TIFFOptions.TIFF_JPEG - JPEG-in-TIFF compression.
    TIFFOptions.TIFF_LZW - LZW Compression
    TIFFOptions.TIFF_PACKBITS - Byte-oriented run-length encoding "PackBits" compression.
    TIFFOptions.TIFF_ZLIB - ZLib Compression.
    TIFFOptions.TIFF_NO_COMPRESSION - No compression.
    
    Throws:
    
    PDFException
    
    IOException
  - saveDocumentAsTIFF
```
public void saveDocumentAsTIFF(String fileName,
                               TIFFOptions options)
                        throws PDFException,
                               IOException
```
    Save the entire document as a multi-page TIFF image to the given file. This method takes a TIFFOptions object as an argument to describe various TIFF options when saving the file.
    
    Parameters:
    
    fileName - The name of the file to write the TIFF image to.
    
    options - Options to use when saving the TIFF file.
    
    Throws:
    
    PDFException
    
    IOException
  - saveDocumentAsTIFF
```
public void saveDocumentAsTIFF(OutputStream outStream,
                               TIFFOptions options)
                        throws PDFException,
                               IOException
```
    Save the entire document as a multi-page TIFF image to an OutputStream. This method takes a TIFFOptions object as an argument to describe various TIFF options when saving the file.
    
    Parameters:
    
    outStream - The stream to save the image to.
    
    options - Options to use when saving the TIFF file.
    
    Throws:
    
    PDFException
    
    IOException
  - appendTIFFAsPages
```
public void appendTIFFAsPages(String tiffFileName)
                       throws PDFException,
                              IOException
```
    Appends the pages in a TIFF file to the end of this document. The method will create a new page for each image in a TIFF file and then draw the image onto the page. The page dimensions will be the same as for the TIFF image, calculated using the TIFF dpi value.
    
    Parameters:
    
    tiffFileName - The name of the TIFF file to add to this document.
    
    Throws:
    
    PDFException
    
    IOException
  - appendTIFFAsPages
```
public void appendTIFFAsPages(InputStream inStream)
                       throws PDFException,
                              IOException
```
    Appends the pages in a TIFF image from an input stream to the end of this document. The method will create a new page for each image in a TIFF image and then draw the image onto the page. The page dimensions will be the same as for the TIFF image, calculated using the TIFF dpi value.
    
    Parameters:
    
    inStream - The input stream to read the TIFF image from
    
    Throws:
    
    PDFException
    
    IOException
  - appendJPEGAsPage
```
public void appendJPEGAsPage(String jpegFileName)
                      throws PDFException,
                             IOException
```
    Creates a new page in the PDF document and adds the JPEG file to it. The method looks at the DPI value in the JPEG image to determine the size of the new page. If not present, the method defaults to 72 DPI.
    
    Parameters:
    
    jpegFileName - The name of the JPEG file to add to this document.
    
    Throws:
    
    PDFException
    
    IOException
  - appendJPEGAsPage
```
public void appendJPEGAsPage(InputStream inStream)
                      throws PDFException,
                             IOException
```
    Creates a new page in the PDF document and adds the JPEG image to it. The method looks at the DPI value in the JPEG image to determine the size of the new page. If not present, the method defaults to 72 DPI.
    
    Parameters:
    
    inStream - The input stream from which to read the JPEG image.
    
    Throws:
    
    PDFException
    
    IOException
  - appendGIFAsPage
```
public void appendGIFAsPage(String gifFileName,
                            int dpi)
                     throws PDFException,
                            IOException
```
    Creates a new page in the PDF document and adds the GIF image to it. The DPI must be provided because GIF files do not have DPI information embedded in them. PDF standard resolution is 72 DPI.
    
    Parameters:
    
    gifFileName - The name of gif file
    
    dpi - The DPI value to use when importing the image.
    
    Throws:
    
    PDFException
    
    IOException
  - appendGIFAsPage
```
public void appendGIFAsPage(InputStream inStream,
                            int dpi)
                     throws PDFException,
                            IOException
```
    Creates a new page in the PDF document and adds the GIF image to it. The image is read from an input stream. The DPI must be provided because GIF files do not have DPI information embedded in them. PDF standard resolution is 72 DPI.
    
    Parameters:
    
    inStream - An input stream containing the GIF file content
    
    dpi - The DPI value to use when importing the image.
    
    Throws:
    
    PDFException
    
    IOException
  - appendJPEGAsPage
```
public void appendJPEGAsPage(String jpegFileName,
                             int dpi)
                      throws PDFException,
                             IOException
```
    Creates a new page in the PDF document and adds the JPEG file to it. The method ignores the DPI value in the file and uses the dpi passed into the method to determine the page size.
    
    Parameters:
    
    jpegFileName - The name of the JPEG file to add to this document.
    
    dpi - The DPI value to use when importing the image.
    
    Throws:
    
    PDFException
    
    IOException
  - appendPNGAsPage
```
public void appendPNGAsPage(String pngFileName)
                     throws PDFException,
                            IOException
```
    Creates a new page in the PDF document and adds the PNG file to it. The method looks at the DPI value in the PNG image to determine the size of the new page. If not present, the method defaults to 72 DPI.
    
    Parameters:
    
    pngFileName - The name of the PNG file to add to this document.
    
    Throws:
    
    PDFException
    
    IOException
  - appendPNGAsPage
```
public void appendPNGAsPage(InputStream inStream)
                     throws IOException,
                            PDFException
```
    Creates a new page in the PDF document adds the PNG content to it. The method reads the input stream expecting PNG content and looks at the DPI setting in the image to determine the size of the new page. If the DPI information is not present, the method defaults to 72 DPI.
    
    Parameters:
    
    inStream - The input stream to read the PNG content from.
    
    Throws:
    
    IOException
    
    PDFException
  - saveDocument
```
public void saveDocument(OutputStream outStream)
                  throws IOException,
                         PDFException
```
    Saves this document to an output stream.
    
    Parameters:
    
    outStream - OutputStream where the document will be written to.
    
    Throws:
    
    IOException
    
    PDFException
  - saveDocument
```
public void saveDocument(String fileName)
                  throws IOException,
                         PDFException
```
    Saves this document to a file.
    
    Parameters:
    
    fileName - Name of the file to save the document.
    
    Throws:
    
    IOException
    
    PDFException
  - setWatermark
```
public void setWatermark(IWatermark watermark)
```
    Sets the watermark on the PDFImages document. The PDFImages document will make callbacks to this watermark with type IWatermark.TYPE_IMAGES when creating images from the document.
    
    Parameters:
    
    watermark - the IWatermark object to use when creating images from the PDFImages document
  - usePermissionsPassword
```
public boolean usePermissionsPassword(String ownerPassword)
                               throws PDFException
```
    Tells the PDFImages object that the permissions password is known, so all permissions are granted.
    
    Parameters:
    
    ownerPassword - The permissions password
    
    Returns:
    
    true if the password was validated
    
    Throws:
    
    PDFException
  - getWatermark
```
public IWatermark getWatermark()
```
    Returns the watermark for the PDFImages document.
    
    Returns:
    
    the IWatermark object
    
    See Also:
    
    setWatermark(com.qoppa.pdf.IWatermark)

Class PDFImages

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PDFImages

PDFImages

PDFImages

PDFImages

PDFImages

Method Detail

close

getDocumentInfo

setKey

loadLicense

loadLicense

setAppletKey

getVersion

getPageImage

getPageImageCS

getPageImageCS

getPageImage

getPageSubImage

getPaperHeight

getPaperWidth

getMediaBox

getCropBox

getDisplayHeight

getDisplayWidth

getPageCount

getPageRotation

savePageAsPNG

savePageAsPNG

savePageAsGIF

savePageAsJPEG

savePageAsJPEG

savePageAsTIFF

savePageAsJPEG2000

savePageAsTIFF

saveDocumentAsTIFF

saveDocumentAsTIFF

saveDocumentAsTIFF

appendTIFFAsPages

appendTIFFAsPages

appendJPEGAsPage

appendJPEGAsPage

appendGIFAsPage

appendGIFAsPage

appendJPEGAsPage

appendPNGAsPage

appendPNGAsPage

saveDocument

saveDocument

setWatermark

usePermissionsPassword

getWatermark