PDFAssemble (Qoppa jPDFProcess API)

java.lang.Object
- com.qoppa.pdfAssemble.PDFAssemble

```
public class PDFAssemble
extends Object
```
The PDFAssemble class provides methods to assemble and disassemble PDF documents. The PDFAssemble class can load existing documents (or start from a blank document) and can add pages from other documents or delete pages in the document.

Author:

Qoppa Software

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MAGNIFICATION_FIT_ACTUAL` Setting for the initial magnification: 100% Scale
`static String`	`MAGNIFICATION_FIT_HEIGHT` Setting for the initial magnification: Fit to height
`static String`	`MAGNIFICATION_FIT_PAGE` Setting for the initial magnification: Fit page (both width and height)
`static String`	`MAGNIFICATION_FIT_WIDTH` Setting for the initial magnification: Fit to width
`static String`	`PAGELAYOUT_ONECOLUMN` Setting for the initial page layout: Single page continuous
`static String`	`PAGELAYOUT_SINGLEPAGE` Setting for the initial page layout: Single page
`static String`	`PAGELAYOUT_TWOCOLUMNLEFT` Setting for the initial page layout: Two pages continuous
`static String`	`PAGELAYOUT_TWOPAGELEFT` Setting for the initial page layout: Two pages
`static String`	`PAGEMODE_FULLSCREEN` Setting for the initial page mode: Full-screen mode, with no menu bar, window controls, or any other window visible
`static String`	`PAGEMODE_USEATTACHMENTS` Setting for the initial page mode: (PDF 1.6) Attachments panel visible
`static String`	`PAGEMODE_USENONE` Setting for the initial page mode: Neither document outline nor thumbnail images visible
`static String`	`PAGEMODE_USEOC` Setting for the initial page mode: (PDF 1.5) Optional content group panel visible
`static String`	`PAGEMODE_USEOUTLINES` Setting for the initial page mode: Document outline visible
`static String`	`PAGEMODE_USETHUMBS` Setting for the initial page mode: Thumbnail images visible

Constructor Summary

Constructors
Constructor and Description
`PDFAssemble()` Creates a blank PDFAssemble object.
`PDFAssemble(InputStream inStream, IPassword password)` Loads a PDF document from an InputStream.
`PDFAssemble(String fileName, IPassword password)` Loads a PDF document from a file.
`PDFAssemble(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`	`addGoToPage(Bookmark bookmark, int pageNum)` Adds a GoToPage action to the Bookmark Parameter.
`void`	`addGoToPage(Bookmark bookmark, int pageNum, int zoomMode)` Adds a GoToPage action to the Bookmark Parameter with a zoom mode.
`void`	`addGoToPage(Bookmark bookmark, int pageNum, int x, int y, double scale)` Adds a GoToPage action to the Bookmark Parameter that uses x and y coordinates and a zoom scale.
`void`	`appendDocument(PDFAssemble appendDoc)` Appends a PDF document to this document.
`void`	`appendPage(PDFAssemble source, int pageIndex)` Appends a page to this document.
`void`	`close()` Close / release all resources held by this document.
`Bookmark`	`createBookmark(Bookmark parent, int pageNum)` Creates a Bookmark with a GoToPage action, and Add it as a child to the parent Bookmark parameter
`Bookmark`	`createBookmark(Bookmark parent, int pageNum, int zoomMode)` Creates a Bookmark with a GoToPage action with a zoom mode, and Add it as a child to the parent Bookmark parameter
`Bookmark`	`createBookmark(Bookmark parent, int pageNum, int x, int y, double scale)` Creates a Bookmark with a GoToPage action that uses x and y coordinates and a zoom scale.
`Bookmark`	`createRootBookmark()` Creates a new root bookmark and saves it in the document catalog.
`void`	`deletePage(int pageIndex)` Deletes a page from this document.
`void`	`deletePages(int startIndex, int endIndex)` Deletes a range of pages in the document.
`PDFAssemble`	`extractPages(int startIndex, int endIndex, OutputStream outStream)` Creates and saves a new PDF document that contains a range of pages from this document.
`PDFAssemble`	`extractPages(int startIndex, int endIndex, String outputFile)` Creates and saves a new PDF document that contains a range of pages from this document.
`DocumentInfo`	`getDocumentInfo()` Returns a DocumentInfo object containing the information section of a PDF document (author, title, etc.)
`int`	`getPageCount()` Returns the number of pages in this document.
`AllPDFPermissions`	`getPDFPermissions()` Returns the AllPDFPermissions object which encompasses this document's PasswordPermissions, DocMDPPermissions, and UsageRightsPermissions.
`Bookmark`	`getRootBookmark()` Returns the 'root' bookmark.
`static String`	`getVersion()` Returns version string for jPDFFields.
`void`	`insertPage(PDFAssemble sourceDoc, int srcPageIndex, int dstPageIndex)` Inserts a page into this document at the given index.
`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.
`static boolean`	`setAppletKey(String key, Applet applet)` Method to unlock the production version of the library.
`void`	`setInitialPage(int pageIndex, String scale)` Sets the initial page and scale to use when this document is opened with a PDF viewer.
`void`	`setInitialPageLayout(String pageLayout)` Changes the value of the page layout key for this document.
`void`	`setInitialPageMode(String pageMode)` Changes the value of the page mode viewer preference in the document.
`static boolean`	`setKey(String key)` Method to unlock the production version of the library.
`boolean`	`usePermissionsPassword(String ownerPassword)` Tells the PDFAssemble 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

- Field Detail
  - MAGNIFICATION_FIT_WIDTH
```
public static final String MAGNIFICATION_FIT_WIDTH
```
    Setting for the initial magnification: Fit to width
    
    See Also:
    
    Constant Field Values
  - MAGNIFICATION_FIT_HEIGHT
```
public static final String MAGNIFICATION_FIT_HEIGHT
```
    Setting for the initial magnification: Fit to height
    
    See Also:
    
    Constant Field Values
  - MAGNIFICATION_FIT_PAGE
```
public static final String MAGNIFICATION_FIT_PAGE
```
    Setting for the initial magnification: Fit page (both width and height)
    
    See Also:
    
    Constant Field Values
  - MAGNIFICATION_FIT_ACTUAL
```
public static final String MAGNIFICATION_FIT_ACTUAL
```
    Setting for the initial magnification: 100% Scale
    
    See Also:
    
    Constant Field Values
  - PAGEMODE_USENONE
```
public static final String PAGEMODE_USENONE
```
    Setting for the initial page mode: Neither document outline nor thumbnail images visible
    
    See Also:
    
    Constant Field Values
  - PAGEMODE_USEOUTLINES
```
public static final String PAGEMODE_USEOUTLINES
```
    Setting for the initial page mode: Document outline visible
    
    See Also:
    
    Constant Field Values
  - PAGEMODE_USETHUMBS
```
public static final String PAGEMODE_USETHUMBS
```
    Setting for the initial page mode: Thumbnail images visible
    
    See Also:
    
    Constant Field Values
  - PAGEMODE_FULLSCREEN
```
public static final String PAGEMODE_FULLSCREEN
```
    Setting for the initial page mode: Full-screen mode, with no menu bar, window controls, or any other window visible
    
    See Also:
    
    Constant Field Values
  - PAGEMODE_USEOC
```
public static final String PAGEMODE_USEOC
```
    Setting for the initial page mode: (PDF 1.5) Optional content group panel visible
    
    See Also:
    
    Constant Field Values
  - PAGEMODE_USEATTACHMENTS
```
public static final String PAGEMODE_USEATTACHMENTS
```
    Setting for the initial page mode: (PDF 1.6) Attachments panel visible
    
    See Also:
    
    Constant Field Values
  - PAGELAYOUT_SINGLEPAGE
```
public static final String PAGELAYOUT_SINGLEPAGE
```
    Setting for the initial page layout: Single page
    
    See Also:
    
    Constant Field Values
  - PAGELAYOUT_ONECOLUMN
```
public static final String PAGELAYOUT_ONECOLUMN
```
    Setting for the initial page layout: Single page continuous
    
    See Also:
    
    Constant Field Values
  - PAGELAYOUT_TWOCOLUMNLEFT
```
public static final String PAGELAYOUT_TWOCOLUMNLEFT
```
    Setting for the initial page layout: Two pages continuous
    
    See Also:
    
    Constant Field Values
  - PAGELAYOUT_TWOPAGELEFT
```
public static final String PAGELAYOUT_TWOPAGELEFT
```
    Setting for the initial page layout: Two pages
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PDFAssemble
```
public PDFAssemble()
            throws PDFException
```
    Creates a blank PDFAssemble object. This constructor can be used to create a new document entirely from other documents.
    
    Throws:
    
    PDFException
  - PDFAssemble
```
public PDFAssemble(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
  - PDFAssemble
```
public PDFAssemble(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
  - PDFAssemble
```
public PDFAssemble(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
- 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.
  - getPageCount
```
public int getPageCount()
```
    Returns the number of pages in this document.
  - 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.
  - getVersion
```
public static String getVersion()
```
    Returns version string for jPDFFields. If this is the demo version, the return string will contain 'Demo Version' at the end.
  - appendDocument
```
public void appendDocument(PDFAssemble appendDoc)
                    throws PDFException
```
    Appends a PDF document to this document. All the pages in appendDoc will be added at the end of this document.
    
    Parameters:
    
    appendDoc - Document to be appended.
    
    Throws:
    
    PDFException
  - appendPage
```
public void appendPage(PDFAssemble source,
                       int pageIndex)
                throws PDFException
```
    Appends a page to this document.
    
    Parameters:
    
    source - The document from which to append the page.
    
    pageIndex - The index of the page to append from the source document.
    
    Throws:
    
    PDFException
  - insertPage
```
public void insertPage(PDFAssemble sourceDoc,
                       int srcPageIndex,
                       int dstPageIndex)
                throws PDFException
```
    Inserts a page into this document at the given index. If the index is less than 0, the page is inserted as the first page. If the index is greater than the number of pages in the document, the page is appended to the document.
    
    Parameters:
    
    sourceDoc - The document from which to append the page.
    
    srcPageIndex - The index of the page to append from the source document.\
    
    dstPageIndex - The index of the page at which to insert the new page.
    
    Throws:
    
    PDFException
  - deletePage
```
public void deletePage(int pageIndex)
                throws PDFException
```
    Deletes a page from this document. If the index is out of bounds, (index < 0 or index >= number of pages) this method has no effect on the document.
    
    Parameters:
    
    pageIndex - Index of the page to remove.
    
    Throws:
    
    PDFException
  - deletePages
```
public void deletePages(int startIndex,
                        int endIndex)
                 throws PDFException
```
    Deletes a range of pages in the document. The start and end index are 0 based and inclusive.
    
    Parameters:
    
    startIndex - The index of the first page to delete.
    
    endIndex - The index of the last page to delete, inclusive.
    
    Throws:
    
    PDFException
  - extractPages
```
public PDFAssemble extractPages(int startIndex,
                                int endIndex,
                                String outputFile)
                         throws IOException,
                                PDFException
```
    Creates and saves a new PDF document that contains a range of pages from this document.
    
    Parameters:
    
    startIndex - The first page to include in the new document.
    
    endIndex - The last page to include in the new document.
    
    outputFile - The path to the file to save the PDF document in.
    
    Throws:
    
    IOException - Any errors writing the file
    
    PDFException - Any errors extracting the pages
  - extractPages
```
public PDFAssemble extractPages(int startIndex,
                                int endIndex,
                                OutputStream outStream)
                         throws IOException,
                                PDFException
```
    Creates and saves a new PDF document that contains a range of pages from this document.
    
    Parameters:
    
    startIndex - The first page to include in the new document.
    
    endIndex - The last page to include in the new document.
    
    outStream - The output stream to write the new document to.
    
    Throws:
    
    IOException - Any errors writing the file
    
    PDFException - Any errors extracting the pages
  - createRootBookmark
```
public Bookmark createRootBookmark()
                            throws PDFException
```
    Creates a new root bookmark and saves it in the document catalog. When this method is called, any existing bookmarks will be discarded and the new root bookmark will be put in place. Initially, the new root bookmark will have no children (no entries will be displayed in the bookmarks pane when viewing the document).
    
    Returns:
    
    Bookmark The new root bookmark.
    
    Throws:
    
    PDFException
  - getRootBookmark
```
public Bookmark getRootBookmark()
```
    Returns the 'root' bookmark. Bookmarks form a tree structure in a document.
    
    Returns:
    
    Bookmark The root bookmark for this document.
  - 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
  - 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
  - setAppletKey
```
public static boolean setAppletKey(String key,
                                   Applet applet)
```
    Method to unlock the production version of the library.
    
    Parameters:
    
    key - Production key.
  - 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
  - usePermissionsPassword
```
public boolean usePermissionsPassword(String ownerPassword)
                               throws PDFException
```
    Tells the PDFAssemble 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
  - getPDFPermissions
```
public final AllPDFPermissions getPDFPermissions()
```
    Returns the AllPDFPermissions object which encompasses this document's PasswordPermissions, DocMDPPermissions, and UsageRightsPermissions.
  - setInitialPageMode
```
public void setInitialPageMode(String pageMode)
                        throws PDFException
```
    Changes the value of the page mode viewer preference in the document. The page mode is used when the document is opened in a PDF Viewer.
    
    Parameters:
    
    pageMode - The new page mode. This value has to be one of:
    PAGEMODE_USENONE: Neither document outline nor thumbnail images are visible.
    PAGEMODE_USEOUTLINES: Document outline visible.
    PAGEMODE_USETHUMBS: Thumbnail images visible.
    PAGEMODE_FULLSCREEN: Full screen mode, with no menu bar, window controls, or any other window visible.
    
    Throws:
    
    PDFException
  - setInitialPageLayout
```
public void setInitialPageLayout(String pageLayout)
                          throws PDFException
```
    Changes the value of the page layout key for this document. This determines the layout of the page when initially opened.
    
    Parameters:
    
    pageLayout - The new page mode. This value has to be one of:
    PAGELAYOUT_SINGLEPAGE: Display one page at a time.
    PAGELAYOUT_ONECOLUMN: Display the page in one column (single page continuous).
    PAGELAYOUT_TWOCOLUMNLEFT: Display the page in two columns (two facing continuous).
    PAGELAYOUT_TWOPAGELEFT: Display two pages at a time (two facing).
    
    Throws:
    
    PDFException
  - setInitialPage
```
public void setInitialPage(int pageIndex,
                           String scale)
                    throws PDFException
```
    Sets the initial page and scale to use when this document is opened with a PDF viewer.
    Parameters:
    
    pageIndex - The index of the page (0 based) to display upon opening the document. If this value is -1, this method will clear the initial page entry.
    scale - The scale to use when displaying the page. This argument can be one of the following
    
    (percent scale, as a number) If this argument is a number, it will be interpreted as a percentage scale, 100 == actual size
    
    "FitH" - Adjust the scale to fit the page to width.
    
    "FitV" - Adjust the scale to fit the page to height.
    
    "Fit" - Adjust the scale to fit the page to width and height
    
    "FitBH" - Adjust the scale to fit the page's bounding box to width.
    "FitActual" - 100% Scale.
    Throws:
    
    PDFException
  - addGoToPage
```
public void addGoToPage(Bookmark bookmark,
                        int pageNum)
                 throws PDFException
```
    Adds a GoToPage action to the Bookmark Parameter.
    
    Parameters:
    
    bookmark - The Bookmark to add the GotoPage Action to
    
    pageNum - The page number to display with this bookmark
    
    Throws:
    
    PDFException
  - addGoToPage
```
public void addGoToPage(Bookmark bookmark,
                        int pageNum,
                        int x,
                        int y,
                        double scale)
                 throws PDFException
```
    Adds a GoToPage action to the Bookmark Parameter that uses x and y coordinates and a zoom scale.
    
    Parameters:
    
    bookmark - The Bookmark to add the GotoPage Action to
    
    pageNum - The page number to display with this bookmark
    
    x - The x coordinate to display of the page
    
    y - The y coordinate to display of the page
    
    scale - The zoom scale as a decimal. 0.5 will be 50% zoom, 5 will be 500%. Set to -1 or 0 to retain the current zoom value
    
    Throws:
    
    PDFException
  - addGoToPage
```
public void addGoToPage(Bookmark bookmark,
                        int pageNum,
                        int zoomMode)
                 throws PDFException
```
    Adds a GoToPage action to the Bookmark Parameter with a zoom mode.
    
    Parameters:
    
    bookmark - The Bookmark to add the GotoPage Action to
    
    pageNum - The page number to display with this bookmark
    
    zoomMode - A type of zoom defined by the following constants:
    GotoPageAction.ZOOM_FIT - Zoom to fit the page horizontally and vertically.
    GotoPageAction.ZOOM_FIT_HORIZONTAL - Zoom to fit the page horizontally.
    GotoPageAction.ZOOM_FIT_VERTICAL - Zoom to fit the page vertically.
    GotoPageAction.ZOOM_EXPLICIT - Set the zoom scale explicitly. When using this mode, the viewer will use the value in TargetZoom for the scale.
    GotoPageAction.ZOOM_RETAIN - Do not adjust the zoom scale, retain the current value.
    
    Throws:
    
    PDFException
  - createBookmark
```
public Bookmark createBookmark(Bookmark parent,
                               int pageNum)
                        throws PDFException
```
    Creates a Bookmark with a GoToPage action, and Add it as a child to the parent Bookmark parameter
    
    Parameters:
    
    parent - The parent Bookmark of the Bookmark to be created
    
    pageNum - The page number to display with this bookmark
    
    Throws:
    
    PDFException
  - createBookmark
```
public Bookmark createBookmark(Bookmark parent,
                               int pageNum,
                               int x,
                               int y,
                               double scale)
                        throws PDFException
```
    Creates a Bookmark with a GoToPage action that uses x and y coordinates and a zoom scale. Adds it as a child to the parent Bookmark parameter
    
    Parameters:
    
    parent - The parent Bookmark of the Bookmark to be created
    
    pageNum - The page number to display with this bookmark
    
    x - The x coordinate to display of the page
    
    y - The y coordinate to display of the page
    
    scale - The zoom scale as a decimal. 0.5 will be 50% zoom, 5 will be 500%. Set to -1 or 0 to retain the current zoom value
    
    Throws:
    
    PDFException
  - createBookmark
```
public Bookmark createBookmark(Bookmark parent,
                               int pageNum,
                               int zoomMode)
                        throws PDFException
```
    Creates a Bookmark with a GoToPage action with a zoom mode, and Add it as a child to the parent Bookmark parameter
    
    Parameters:
    
    parent - The parent Bookmark of the Bookmark to be created
    
    pageNum - The page number to display with this bookmark
    
    zoomMode - A type of zoom defined by the following constants:
    GotoPageAction.ZOOM_FIT - Zoom to fit the page horizontally and vertically.
    GotoPageAction.ZOOM_FIT_HORIZONTAL - Zoom to fit the page horizontally.
    GotoPageAction.ZOOM_FIT_VERTICAL - Zoom to fit the page vertically.
    GotoPageAction.ZOOM_EXPLICIT - Set the zoom scale explicitly. When using this mode, the viewer will use the value in TargetZoom for the scale.
    GotoPageAction.ZOOM_RETAIN - Do not adjust the zoom scale, retain the current value.
    
    Throws:
    
    PDFException

Class PDFAssemble

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAGNIFICATION_FIT_WIDTH

MAGNIFICATION_FIT_HEIGHT

MAGNIFICATION_FIT_PAGE

MAGNIFICATION_FIT_ACTUAL

PAGEMODE_USENONE

PAGEMODE_USEOUTLINES

PAGEMODE_USETHUMBS

PAGEMODE_FULLSCREEN

PAGEMODE_USEOC

PAGEMODE_USEATTACHMENTS

PAGELAYOUT_SINGLEPAGE

PAGELAYOUT_ONECOLUMN

PAGELAYOUT_TWOCOLUMNLEFT

PAGELAYOUT_TWOPAGELEFT

Constructor Detail

PDFAssemble

PDFAssemble

PDFAssemble

PDFAssemble

Method Detail

close

getPageCount

getDocumentInfo

getVersion

appendDocument

appendPage

insertPage

deletePage

deletePages

extractPages

extractPages

createRootBookmark

getRootBookmark

saveDocument

saveDocument

setAppletKey

setKey

loadLicense

loadLicense

usePermissionsPassword

getPDFPermissions

setInitialPageMode

setInitialPageLayout

setInitialPage

addGoToPage

addGoToPage

addGoToPage

createBookmark

createBookmark

createBookmark